Xlight FTP Server Help Document

Xlight FTP Server LDAP Schema Fields


 
NAMEDESC
ftpDisableAccountDisable FTP account
ftpAccountExpireTimeAccount expires time. format="yyyy-mm-dd hh:mm:ss" ,where yyyy-mm-dd is year-month-day and hh:mm:ss is hour-minute-second. The range of hours is between 0-23.
ftpGroupNameThe FTP group this user belongs to
ftpHomeDirectoryThe real path to the user's home directory
ftpHomePermControl the access permission to the home directory. Supported flags are the following: L - List; R - Read; S -including subdir; C- create W-Write; A - Append; D - Delete; N-Rename; For example, if you want "write", "list", "read" and "including sub-directories" permission for this user, you can use "WLRS-----" in this column. The order of flag values has no impact on the permission.
ftpHidePublicPathHide the public virtual path from this user
ftpHideGroupPathHide the group virtual path from this user
ftpBypassServerMaxBypass the maximum user limit in the FTP server
ftpMaxDownloadSpeedMaximum download speed in KB/s
ftpMaxUploadSpeedMaximum upload speed in KB/s
ftpMaxUserConnectionsMaximum connections for this user
ftpMaxConnectionsIPMaximum connections per IP for this user
ftpMaxSessionTimeMaximum session time for this user
ftpMaxDownloadFileNumTotal files allowed to download in a session
ftpMaxUploadFileNumTotal files allowed to upload in a session
ftpSessionMaxDownloadMaximum amount (in MBytes) allowed to download in a session
ftpSessionMaxUploadMaximum amount (in MBytes) allowed to upload in a session
ftpMaxDownloadFileSizeMaximum file size (in MBytes) allowed to download
ftpMaxUploadFileSizeMaximum file size (in MBytes) allowed to upload
ftpEnableQuotasEnable quotas support
ftpUserSpaceQuotasDisk space usage (in MBytes) allowed for this user
ftpUserQuotaUnitFTP user disk quota unit in KB(default) or MB
ftpEnableRatioEnable ratio support
ftpRatioTypeRatio type for this user
ftpRatioDownloadThe first half of the download/upload ratio
ftpRatioUploadThe second half of the download/upload ratio
ftpRatioStartingCreditThe starting ratio credit
ftpUserCommandSpeedNumber of FTP commands allowed in a second. Value range, 0-1000. FTP command speed per second after user login. 0(default)= 20 commands per second.
ftpAllowedUserLoginIPIP address allowed to log in. Format:IP address/subnet mask; Maximum 16 items are allowed. Items are separated by "|". For example: "192.168.252.1/255.255.255.0|202.96.3.1/255.255.255.0".
ftpDeniedUserLoginIPIP address denied to login. Format:IP address/subnet mask; Maximum 16 items are allowed. Items are separated by "|". For example: "192.168.252.1/255.255.255.0|202.96.3.1/255.255.255.0".
ftpAllowedUserLoginTimeAllowed login time to this user. Format:"start - end", where the start and end is in the format "mon/day/year hour:minute" or "weekday hour:minute". Note: The minimum unit is minute not second. A maximum of 10 items are allowed for this column. Items are separated by "|". For example, "01/11/2004 11:00 - 02/11/2004 12:00 | 03/21/2004 - 04/21/2005 | Mon - Tus | Wed 20:04 - Fri 20:04". Leave this column empty, if you don't want to restrict the user's login time. The start and end times must match. For example, if the start time is a weekday, the end time must also be a weekday. If the start time is time, the end must also be time.
ftpFilesAllowedAccessFiles allowed access to this user. If names are put in this field, this user can only access and see these files in the FTP server. But he can not access and see other files other than those in this field. The name can be unix shell-style wildcards. Different file names are separated by "|". For example, if "*.exe|*.txt" is put here, then this user can only access and see files with ".exe" and ".txt" extensions.
ftpFilesDeniedAccessFiles denied access to this user. If names are put in this field, this user can not access and see these files in the FTP server. But he can still access and see other files. The name can be unix shell-style wildcards. Different file names are separated by "|". For example, if "*.exe|*.txt" is put here, then this user can not access and see files with ".exe" and ".txt" extensions.
ftpDeniedCommandsFTP commands denied to this user
ftpSendSocketBufferSocket buffer for sending data to the client. The Unit is in KB. 0(default) will use 32KB as the socket buffer size. FTP clients will normally have better throughput with a large socket buffer, especially when users are in the Gigabyte Ethernet.
ftpRecvSocketBufferSocket buffer for receiving data from the client. The Unit is in KB. 0(default) will use 32KB as the socket buffer size. FTP clients will normally have better throughput with a large socket buffer, especially when users are in the Gigabyte Ethernet.
ftpVirtualPathsThe virtual paths of a user. This is a multi-value attribute. A user can have multiple virtual paths. The ftpVirtualPaths string is the "|" separated combination of virtual path, real path and permission. Its format is: "virtual path | real path | permission". An example virtual path string can be "/files/ | d:\Downloads\ | RLS----", where the "/files/" is the virtual path, "d:\Downloads\" is the real path mapped to "/files/", "R--L--S" is permission flag of "/files/". Virtual path, real path and permission are separated by "|". You can refer to the description of "ftpHomePerm" for the meaning of each permission flag. Note: The virtual path must be a UNIX-style path and the real path must be a Windows-style path. The variable %username% can be used for the real path. %username% will be replaced with the actual user name after a user logs in. If the real path doesn't exist when a user logs in, Xlight FTP Server will create it automatically.