Schemas for the ftp Superservice
Prev | Chapter 6. Schemas Reference | Next

## Schemas for the ftp Superservice

### DLF Schema for FTP service

Schema ID: `ftp`

Timestamp Field: `time`

This DLF file is adequate to represent most common informations about ftp transfers. It has the equivalent information of the xferlog format supported by many ftp servers.

Each DLF record in the FTP schema reprensents one FTP transfer, this schema isn't adequate to represents complete FTP session.

Fields in the Schema

`time`

  Type: timestamp

  Defaults: 0

  The time at which the transfer started.

`transfer_time`

  Type: duration

  Defaults: 0

  The time taken by the transfer.

`remote_host`

  Type: hostname

  Defaults: -

  The hostname of the client that initiated the transfer.

`file_size`

  Type: bytes

  Defaults: -

  The number bytes transferred.

`filename`

  Type: filename

  Defaults: -

  The filename that was transferred.

`transfer_type`

  Type: string

  Defaults: -

  The method used for the transfer. This will `ascii` when ASCII conversion is used during the transfer and `binary` otherwise.

`special_action_flag`

  Type: string

  Defaults: -

  A code used to represent special action accomplished by the server during the transfer. Valid codes besides the default are `compress`, `uncompress` and `tar`.

`direction`

  Type: string

  Defaults: -

  This should be `upload` for incoming transfer and `dowload` for outgoing transfer.

`access_mode`

  Type: string

  Defaults: -

  The type of authentication used. Valid values are `anonymous` when the use used anonymous login; `guest` for guest login and `authenticated` for when the user was authenticated through valid credentials.

`username`

  Type: string

  Defaults: -

  The name of the authenticated user. In the case of guest or anonymous logins, this should be the email address or other identifier given by the user on logon.

`service_name`

  Type: string

  Defaults: -

  That's the name through which the service was invoked. This will usually be FTP.

`auth_method`

  Type: string

  Defaults: -

  Additional authentication that was done on the connection. The only defined value besides the default is `ident` for the case when the connection was authenticated through RFC1931 authentication.

`auth_user_id`

  Type: string

  Defaults: -

  The user identification related to the `auth_method` mode of authentication.

`completion_status`

  Type: string

  Defaults: -

  This will be `complete` when the transfer completed successfully and `incomplete` when the transfer was aborted before it completes.

Prev | Up | Next
Schemas for the firewall Superservice | Home | Schemas for the msgstore Superservice