CompleteFTP CLI Reference

The CompleteFTP CLI uses a subcommand (or multi-level command) style similar to git and openssl. The main command is completeftp.

Getting Started

Help is available for all subcommands via the -h option, so a good way to get started is to simply enter:

completeftp -h

This will show all available top-level commands. Most of these have subcommands. Help for these is also available via the -h option, e.g.

completeftp site -h

Top-Level Commands

CompleteFTP's entire configuration is accessible through a structure referred to as a Configuration Object Model (COM). The objects at the top level are the main types that CompleteFTP deals with namely:

site - configuration of sites within CompleteFTP, including the various protocols SFTP, FTPS, HTTPS, etc.
server - configuration of the servers in the system
folder - configuration of the folders of the virtual file-system
user - configuration of users
group - configuration of groups
webapp - configuration of web-apps
extension - configuration of extensions (a.k.a. plug-ins)
notification - configuration of email notifications
trigger - configuration of process triggers (scripts and external programs)
monitor - configuration of monitoring methods

Each of these is accessible via the top-level command:

completeftp <object>

Properties

The COM is essentially an object with properties each of which can be a string, a number, a boolean (true/false), another object with properties, or a set of those values (i.e. an array).

Viewing Properties

Properties can be view using the show subcommand on various entity types:

For example, the following command will show all the SSH public keys of the default site:

completeftp site show default sshKeys

Objects can be drilled into via dot notation. For example, if you want to see just the 256 curve of the ECDSA key you can use:

completeftp site show default sshKeys.ecdsa.p256

Properties can be specified using the * wildcard, which matches any characters. For example, the following command can be used to show all the SSH properties of a site:

completeftp site show default ssh*

Setting Properties

The value of a property can be assigned using an equals sign, i.e. property1=value.

For example, SFTP can be enabled for the user whose user-name is fred as follows:

completeftp user set fred sftpEnabled=true

If an argument has a space in it then the argument should be enclosed in double quotes. For example, if you need to set the fullName property of a user then the argument should be enclosed in double-quotes, i.e.

completeftp user set fred "fullName=Fred Singh"

Sometimes, especially for passwords, it may be preferable to enter the values interactively. To do this, omit the equals sign and the value and you will be prompted for the values interactively when you execute the commands. Passwords will be hidden for asteriskes (`*`).

completeftp user set fred password

`siteName` and `serverName`

A lot of commands require a siteName or a serverName. Entering default or . for this argument will yield the first listed server or site, which saves having to rewrite the name.

Date properties

Some properties are dates. These may be set using the format yyyy-mm-dd. Dates are UTC, so you may sometimes notice a time-difference between the date that's set and the date that's shown.

Array Properties

Some properties are a set of values, also called an array. The values in an array can be accessed individually using angle brackets and zero-based indices, e.g. to get the first value in an array named a you'd use a[0].

Object Viewer

The -v (--view) option opens an interactive tree viewer for the COM, making it much easier to understand its structure. This option is available for all commands.

For example, the following command will show all the properties of the default site:

completeftp site show -v

The viewer supports navigation using the arrow and page keys, as well as the mouse. It's recommended to use the view to explore the various COM entities, such as sites, users and folders. This can be done with the following commands:

completeftp site show -v
completeftp folder show /Home -v
completeftp user show anonymous -v
completeftp group show users -v
completeftp server show -v

List of Commands

Below is a list of all commands and subcommands. Click on any of them to go straight to the details that follow.

completeftp folder
completeftp user
completeftp group
completeftp site
completeftp webapp
completeftp extension
completeftp server
completeftp notification
completeftp trigger
completeftp monitor
- completeftp monitor show
- completeftp monitor set
completeftp license

Command Details

Command: `completeftp folder`

Manage folders in the CompleteFTP virtual file system, including adding, removing, listing, and modifying folders and their properties.

Sub-commands: add remove show set list listall move chown chmod

Command: `completeftp folder add`

Add a new folder to the virtual file system. This command allows you to create a folder and specify how it maps to the underlying data source, such as a local directory or cloud storage location.

Arguments:

path: The absolute path within the virtual file system where the new folder will be created (e.g., '/NewFolder').
type: The type of the folder to be added. Possible values include 'OS' for an operating system folder, 'AmazonS3' for Amazon S3 storage, 'Azure' for Azure Blob Storage, etc.
mappingProperties: Assignments for the mapping properties that define how the folder connects to the data source (e.g., 'path=/my/directory', 'bucketName=mybucket').

Options:

--mapping: A mapping string that specifies the data source for the folder (e.g., '/my/directory' for a local directory, 's3://mybucket' for an Amazon S3 bucket). Either this option or 'mappingProperties' must be provided.

Command: `completeftp folder remove`

Remove a folder from the virtual file system. This command removes the specified folder, and optionally its subfolders. The actual data storage is not affected.

Arguments:

path: The absolute path of the folder to be removed from the virtual file system (e.g., '/OldFolder').

Options:

--recursive: If set to true, the folder and all its subfolders and files will be deleted recursively. Default is false.

Command: `completeftp folder show`

Display detailed information about a folder in the virtual file system, including its properties and mappings.

Arguments:

path: The absolute path of the folder whose details you want to view (e.g., '/MyFolder').
properties: (Optional) Specific properties to display. If omitted, all properties will be shown.

Object Type: Folder

Command: `completeftp folder set`

Modify the properties of an existing folder in the virtual file system. This can include changing its mapping, access permissions, or other attributes.

Arguments:

path: The absolute path of the folder to modify (e.g., '/MyFolder').
properties: Assignments of folder properties in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: Folder

Command: `completeftp folder list`

List the subfolders of a specified folder in the virtual file system. If no path is specified, lists the root folders.

Arguments:

path: (Optional) The path of the folder whose subfolders you want to list (e.g., '/'). If omitted, lists the top-level folders.
properties: (Optional) Specific properties of the subfolders to display. If omitted, displays folder names.

Options:

--details: Include full details for every subfolder, such as properties and mappings. Default is false.

Object Type: String[]

Command: `completeftp folder listall`

List all folders in the virtual file system, regardless of their hierarchy.

Options:

--details: Include full details for every folder, such as properties and mappings. Default is false.

Command: `completeftp folder move`

Move a folder to a new location within the virtual file system.

Arguments:

folder: The absolute path of the folder to be moved (e.g., '/MyFolder').
parentFolder: The absolute path of the new parent folder where the folder will be moved to (e.g., '/NewParentFolder').

Command: `completeftp folder chown`

Change the owner or group of a folder. This modifies the access permissions associated with the folder.

Arguments:

path: The absolute path of the folder (e.g., '/MyFolder').
target: The permission target to set: must be 'owner' or 'group'.
name: The user name or group name to assign as the new owner or group.

Command: `completeftp folder chmod`

Set the permissions of a folder. This command modifies the read, write, and execute permissions for the owner, group, or all users.

Arguments:

path: The absolute path of the folder (e.g., '/MyFolder').
entity: The permission entity to change: 'owner', 'group', or 'all'.
permissions: Permissions to set, combining any of the following letters: 'r' (read), 'w' (write), 'x' (execute), 'd' (manage directories), 'i' (ignore filters). For example, 'rwx'.

Command: `completeftp user`

Manage users within the CompleteFTP system, including adding new users, modifying existing users, setting password policies, and managing SSH keys.

Sub-commands: passwordpolicy list show set add key mapping home remove 2fa

Command: `completeftp user passwordpolicy`

Display or configure password policies that apply to internal users. These policies enforce password strength and change requirements.

Sub-commands: show set

Command: `completeftp user passwordpolicy show`

Show the current password policies. This includes settings like minimum length, complexity requirements, and password expiration.

Object Type: PasswordPolicy

Command: `completeftp user passwordpolicy set`

Set or modify the password policies for internal users. Use this command to enforce stronger passwords or change expiration settings.

Arguments:

properties: Password policy assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: PasswordPolicy

Command: `completeftp user list`

List all users in the CompleteFTP system. This can include both internal and OS users, depending on your configuration.

Arguments:

properties: (Optional) Specific user properties to display, such as 'userName', 'enabled', 'ftpEnabled'. If omitted, default properties are shown.

Command: `completeftp user show`

Display detailed information about a specific user, including their settings and permissions.

Arguments:

userName: The username of the user whose details you want to view (e.g., 'jdoe').
properties: (Optional) Specific properties to display. If omitted, all user properties are shown.

Object Type: User

Command: `completeftp user set`

Modify properties of an existing user. This can include enabling or disabling the user, changing their access permissions, or updating other settings.

Arguments:

userName: The username of the user to modify (e.g., 'jdoe').
properties: User property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: User

Command: `completeftp user add`

Add a new user to the CompleteFTP system. You can create either an internal user managed by CompleteFTP or an OS user managed by the operating system.

Arguments:

userName: The username of the new user to add (e.g., 'jdoe').
type: (Optional) The type of user account. Acceptable values are 'OS' for an operating system user or 'internal' for a CompleteFTP-managed user. Default is 'internal'.
homeFolderPath: (Optional) The virtual path of the user's home folder in the CompleteFTP file system (e.g., '/Home/jdoe'). If the folder doesn't exist, you must also provide 'homeFolderType' and 'homeFolderMapping'.
homeFolderType: (Optional) The type of the home folder. Examples include 'OS' for a local directory, 'AmazonS3' for an Amazon S3 bucket, 'Azure' for Azure storage, etc. This is required if 'homeFolderPath' is specified and the folder doesn't exist.
homeFolderMapping: (Optional) The mapping of the home folder to the data source (e.g., 'C:\Users\jdoe' for a local directory). Required if 'homeFolderPath' is specified and the folder doesn't exist.

Command: `completeftp user key`

Manage SSH public keys associated with a user. This is used for key-based authentication when users connect via SFTP or SCP.

Sub-commands: show add remove

Command: `completeftp user key show`

List the SSH public keys that are currently associated with a specific user.

Arguments:

userName: The username of the user whose SSH public keys you want to list (e.g., 'jdoe').

Object Type: SshPublicKey[]

Command: `completeftp user key add`

Add a new SSH public key to a user's account. This allows the user to authenticate using the corresponding private key.

Arguments:

userName: The username of the user to whom you want to add the SSH public key (e.g., 'jdoe').
publicKey: The SSH public key in OpenSSH or SECSH format. This can be pasted directly or read from a file.

Command: `completeftp user key remove`

Remove an SSH public key from a user's account by specifying the index of the key in the list.

Arguments:

userName: The username of the user whose SSH public key you want to remove (e.g., 'jdoe').
index: The zero-based index of the public key to remove, as listed by the 'key show' command.

Command: `completeftp user mapping`

Manage a user's site mapping, which defines how the user interacts with different sites configured in CompleteFTP.

Sub-commands: show set

Command: `completeftp user mapping show`

Display the site mapping details for a specific user, optionally for a specific site.

Arguments:

userName: The username of the user whose site mapping you want to view (e.g., 'jdoe').
site: (Optional) The name of the site for which to display the mapping. If omitted, mappings for all sites are shown.

Object Type: SiteUserMapping

Command: `completeftp user mapping set`

Set or modify the properties of a user's site mapping. This can include enabling or disabling the user on a site, or changing their home folder for that site.

Arguments:

userName: The username of the user whose site mapping you want to modify (e.g., 'jdoe').
site: The name of the site to modify. If omitted, the default site is assumed.
properties: Site mapping property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: SiteUserMapping

Command: `completeftp user home`

Set or change the home folder for a user on a specific site. The home folder is the default directory the user sees upon logging in.

Arguments:

userName: The username of the user whose home folder you want to set (e.g., 'jdoe').
homeFolder: The virtual path of the home folder to set for the user (e.g., '/Home/jdoe').
site: (Optional) The name of the site for which to set the home folder. If omitted, the default site is assumed.

Command: `completeftp user remove`

Remove a user from the CompleteFTP system. This action cannot be undone and will delete all user-specific configurations.

Arguments:

userName: The username of the user to remove (e.g., 'jdoe').

Command: `completeftp user 2fa`

Manage 2-Factor Authentication (2FA) settings for a user.

Sub-commands: enable disable status reset backuppins

Command: `completeftp user 2fa enable`

Enable 2FA for a user. The user will be prompted to complete setup on their next login.

Arguments:

loginUserName: The login user-name of the user for whom 2FA should be enabled (e.g., 'jdoe').

Command: `completeftp user 2fa disable`

Disable 2FA for a user. This removes the 2FA requirement and clears any existing configuration.

Arguments:

loginUserName: The login user-name of the user whose 2FA should be disabled (e.g., 'jdoe').

Command: `completeftp user 2fa status`

Show whether 2FA is enabled and initialized for a specified user.

Arguments:

loginUserName: The login user-name of the user whose 2FA status you want to view (e.g., 'jdoe').

Object Type: bool

Command: `completeftp user 2fa reset`

Reset a user's 2FA enrollment. The user will be required to set up 2FA again on their next login.

Arguments:

loginUserName: The login user-name of the user whose 2FA should be reset (e.g., 'jdoe').

Command: `completeftp user 2fa backuppins`

Show the current one-time backup PINs for a user as a comma-separated string.

Arguments:

loginUserName: The login user-name of the user whose backup PINs you want to view (e.g., 'jdoe').

Object Type: String

Command: `completeftp group`

Manage user groups within CompleteFTP. Groups allow you to organize users and assign permissions collectively.

Sub-commands: list show add remove memberlist memberadd memberremove

Command: `completeftp group list`

List all groups configured in CompleteFTP. This provides an overview of existing groups and the number of members in each.

Command: `completeftp group show`

Display detailed information about a specific group or all groups, including their members and any associated permissions or settings.

Arguments:

groupName: (Optional) The name of the group to display details for (e.g., 'Developers'). If omitted, details for all groups are shown.
properties: (Optional) Specific properties of the group(s) to display. If omitted, all group properties are shown.

Object Type: Group

Command: `completeftp group add`

Add a new group to CompleteFTP. Groups can be used to manage permissions and settings for multiple users at once.

Arguments:

name: The name of the new group to add (e.g., 'Developers').
users: (Optional) A list of usernames to add to the group upon creation.

Command: `completeftp group remove`

Remove an existing group from CompleteFTP. This action will delete the group but will not affect the user accounts that were members of the group.

Arguments:

groupName: The name of the group to remove (e.g., 'Developers').

Command: `completeftp group memberlist`

List all members of a specific group. This shows which users are currently assigned to the group.

Arguments:

groupName: The name of the group whose members you want to list (e.g., 'Developers').

Command: `completeftp group memberadd`

Add one or more users to an existing group. This assigns the group's permissions to those users.

Arguments:

groupName: The name of the group to which you want to add users (e.g., 'Developers').
users: A list of usernames to add to the group. You must specify at least one user.

Command: `completeftp group memberremove`

Remove one or more users from a group. This revokes the group's permissions from those users.

Arguments:

groupName: The name of the group from which you want to remove users (e.g., 'Developers').
users: A list of usernames to remove from the group. You must specify at least one user.

Command: `completeftp site`

Manage sites within the CompleteFTP server. Sites represent different server configurations, including ports, protocols, and security settings.

Sub-commands: list show set add remove cert key ipfilter filenamefilter auth httpheader mimetype

Command: `completeftp site list`

List all sites configured in the CompleteFTP server. This provides an overview of available sites and their basic properties.

Arguments:

properties: (Optional) Specific properties of the sites to display. If omitted, default properties are shown.

Command: `completeftp site show`

Display detailed information about a specific site or all sites, including configuration settings and enabled protocols.

Arguments:

siteName: (Optional) The name of the site to display details for. If omitted, details for all sites are shown.
properties: (Optional) Specific properties to display. If omitted, all site properties are shown.

Object Type: Site

Command: `completeftp site set`

Modify the configuration of an existing site. This can include changing ports, enabling or disabling protocols, and updating security settings.

Arguments:

siteName: The name of the site to modify (e.g., 'Default Site').
properties: Site property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: Site

Command: `completeftp site add`

Create a new site by copying settings from an existing site or starting with default settings. Useful for setting up different configurations for testing or specific client requirements.

Arguments:

siteName: (Optional) The name of the new site to create. If omitted, a default name will be assigned.
templateSite: (Optional) The name of an existing site to use as a template. The new site will inherit its settings.
copyUsers: (Optional) Indicates whether users from the template site should be copied to the new site. Accepts 'true' or 'false'. Default is 'false'.

Command: `completeftp site remove`

Delete an existing site from the CompleteFTP server. This action will remove the site's configuration but will not affect global settings or users.

Arguments:

siteName: The name of the site to remove (e.g., 'Test Site').

Command: `completeftp site cert`

Manage the SSL/TLS certificates associated with a site. Certificates are used to secure connections over FTPS and HTTPS protocols.

Sub-commands: import export generate

Command: `completeftp site cert import`

Import an existing SSL/TLS certificate file for a specified site. Supports formats like PFX or PEM.

Arguments:

siteName: The name of the site to which the certificate will be imported (e.g., 'Secure Site').
certFilePath: The file path to the certificate file to import. Supports absolute or relative paths.
certPassword: (Optional) The password for the certificate file, if it is password-protected. Use empty quotes ('') if there is no password.
privateKeyFilePath: (Optional) The file path to a separate private key file, if required.
privateKeyPassword: (Optional) The password for the private key file, if it is password-protected. Use empty quotes ('') if there is no password.

Command: `completeftp site cert export`

Export the SSL/TLS certificate associated with a specified site. This can be useful for backup purposes or for importing into another system.

Arguments:

siteName: The name of the site whose certificate you want to export (e.g., 'Secure Site').

Options:

--exportPrivateKey: If set to true, the private key will be included in the exported file. Default is false.

Command: `completeftp site cert generate`

Generate a new self-signed SSL/TLS certificate for a specified site. This is useful for testing or for internal secure communications.

Arguments:

siteName: The name of the site for which to generate the certificate (e.g., 'Secure Site').
cn: Common Name (CN) for the certificate, typically the domain name (e.g., 'example.com').
o: Organization (O) name (e.g., 'Example Corp').
ou: Organizational Unit (OU) name (e.g., 'IT Department').
l: Locality (L), such as city or town (e.g., 'New York').
st: State or province name (ST) (e.g., 'New York').
c: Country (C) code in two-letter format (e.g., 'US').
from: Valid from date in 'yyyy-mm-dd' format (e.g., '2033-01-01').
to: Valid to date in 'yyyy-mm-dd' format (e.g., '2034-01-01').
keySize: Bit length of the private key (e.g., '2048'). Common values are 2048 or 4096.

Options:

--exportPrivateKey: If set to true, the private key will be included in the output. Default is false.

Command: `completeftp site key`

Manage the SSH key pairs used by a site for SFTP connections. SSH keys are used for server authentication and secure communication.

Sub-commands: show import remove

Command: `completeftp site key show`

Display the public SSH keys for a specified site. This helps verify which keys are currently in use.

Arguments:

siteName: (Optional) The name of the site whose SSH keys you want to view. If omitted, the default site is assumed.
keyTypes: (Optional) Specific key types to display, such as 'rsa', 'dsa', 'ecdsa.p256', 'ed25519'. If omitted, all key types are shown.

Object Type: SshKeys

Command: `completeftp site key import`

Import SSH key pairs from a file for a specified site. This allows you to use existing keys for server authentication.

Arguments:

siteName: The name of the site to which the SSH keys will be imported (e.g., 'SFTP Site').
keyFilePath: The file path to the private key file to import. Supports formats like PEM.
password: (Optional) The password for the private key file, if it is password-protected. Use empty quotes ('') if there is no password.

Command: `completeftp site key remove`

Remove SSH key pairs of specified algorithms from a site. This can be used to disable certain key types or replace keys.

Arguments:

siteName: The name of the site from which to remove SSH keys (e.g., 'SFTP Site').
algorithms: One or more algorithms whose keys should be removed. Acceptable values are 'dsa', 'rsa', 'ed25519', 'ecdsa.p256', 'ecdsa.p384', or 'ecdsa.p521'.

Command: `completeftp site ipfilter`

Manage IP address filtering rules for a site. IP filters control access to the site based on client IP addresses.

Sub-commands: list precedence add remove test

Command: `completeftp site ipfilter list`

List all IP filter rules configured for a specified site. This shows which IP addresses are allowed or denied access.

Arguments:

siteName: (Optional) The name of the site whose IP filters you want to list. If omitted, the default site is assumed.

Object Type: String[]

Command: `completeftp site ipfilter precedence`

Show or set the rule precedence for IP filtering on a site. Precedence determines whether allow or deny rules take priority.

Arguments:

siteName: (Optional) The name of the site for which to set the precedence. If omitted, the default site is assumed.
precedence: (Optional) The precedence type to set. Acceptable values are 'DenyOverAllow' or 'AllowOverDeny'. If omitted, the current precedence is shown.

Command: `completeftp site ipfilter add`

Add a new IP filter rule to a site. This can be used to allow or deny access from specific IP addresses or ranges.

Arguments:

siteName: The name of the site to which the IP filter rule will be added (e.g., 'Default Site').
action: The action of the rule: 'allow', 'allow-always', or 'deny'. 'allow-always' bypasses the auto-ban system.
host: The IP address, partial IP address, host name, or 'all' to which the rule applies (e.g., '192.168.1.*', 'example.com').
userName: (Optional) The username to which this rule applies. If omitted, the rule applies to all users.

Command: `completeftp site ipfilter remove`

Remove an existing IP filter rule from a site. You can specify the rule by host, IP address, or rule ID.

Arguments:

siteName: The name of the site from which to remove the IP filter rule (e.g., 'Default Site').
host: The IP address, host name, or rule ID of the rule to remove.
userName: (Optional) The username associated with the rule to remove. If omitted, the rule for all users is removed.

Command: `completeftp site ipfilter test`

Test an IP address and optional username against the IP filter rules of a site to determine if access would be allowed or denied.

Arguments:

siteName: The name of the site whose IP filter rules you want to test (e.g., 'Default Site').
ip: The IP address to test (e.g., '192.168.1.100').
userName: (Optional) The username to test from this IP address. If omitted, the test assumes no specific user.

Command: `completeftp site filenamefilter`

Manage file name filters for a site. File name filters control which files can be uploaded or downloaded based on their names.

Sub-commands: show set add remove

Command: `completeftp site filenamefilter show`

Display the current file name filter settings for a site, including the list of blocked or allowed patterns.

Arguments:

siteName: (Optional) The name of the site whose file name filters you want to view. If omitted, the default site is assumed.

Object Type: FileNameFilterManager

Command: `completeftp site filenamefilter set`

Modify the file name filter settings for a site. Currently this includes only the 'matchingFilesBlocked' property.

Arguments:

siteName: The name of the site to modify (e.g., 'Default Site').
properties: File name filter property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: FileNameFilterManager

Command: `completeftp site filenamefilter add`

Add a new file name pattern to the site's filter list. Patterns can include wildcards and are used to match file names.

Arguments:

siteName: The name of the site to which the file name filter will be added (e.g., 'Default Site').
filter: The file name pattern to add (e.g., '*.exe', 'secret_*').

Command: `completeftp site filenamefilter remove`

Remove a file name pattern from the site's filter list.

Arguments:

siteName: The name of the site from which to remove the file name filter (e.g., 'Default Site').
filter: The file name pattern to remove.

Command: `completeftp site auth`

Manage authentication methods for a site, including built-in authenticators and external authentication profiles like Active Directory or SAML.

Sub-commands: list show set profile

Command: `completeftp site auth list`

List all authenticators configured for a specified site. This shows which authentication methods are available and their status.

Arguments:

siteName: (Optional) The name of the site whose authenticators you want to list. If omitted, the default site is assumed.

Options:

--excludeDisabled: If set to true, the list will exclude authenticators that are currently disabled. Default is false.

Command: `completeftp site auth show`

Display properties of a specific authenticator for a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator to display (e.g., 'activedirectory').
properties: (Optional) Specific properties to display. If omitted, all authenticator properties are shown.

Object Type: SamlAuthenticator | DatabaseAuthenticator | GatewayAuthenticator | ActiveDirectoryAuthenticator | LdapAuthenticator

Command: `completeftp site auth set`

Modify properties of a specific authenticator for a site. This can include enabling or disabling the authenticator and updating settings.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator to modify (e.g., 'activedirectory').
properties: Authenticator property assignments in the format 'property=value' or simply 'property' for interactive entry. Properties vary depending on the authenticator.

Object Type: AuthenticatorManager

Command: `completeftp site auth profile`

Manage profiles (such as servers or groups) for authenticators that support them. Profiles define specific configurations within an authenticator.

Sub-commands: list show set add remove

Command: `completeftp site auth profile list`

List all profiles for a specified authenticator on a site. Useful for authenticators like Active Directory that support multiple profiles.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator (e.g., 'activedirectory').

Command: `completeftp site auth profile show`

Display properties of a specific profile for an authenticator on a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator (e.g., 'activedirectory').
profileName: The name of the profile to display (e.g., 'Default Profile').
properties: (Optional) Specific properties to display. If omitted, all profile properties are shown.

Object Type: AuthenticatorProfile

Command: `completeftp site auth profile set`

Modify properties of a specific profile for an authenticator on a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator (e.g., 'activedirectory').
profileName: The name of the profile to modify (e.g., 'Default Profile').
properties: Profile property assignments in the format 'property=value' or simply 'property' for interactive entry. Properties vary depending on the authenticator and profile.

Object Type: AuthenticatorProfile

Command: `completeftp site auth profile add`

Add a new profile to a specified authenticator on a site. Profiles allow for multiple configurations within the same authenticator.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator (e.g., 'activedirectory').
configuration: A configuration string for the new profile. The format and content vary depending on the authenticator. Refer to the user guide for details.

Command: `completeftp site auth profile remove`

Remove a specific profile from an authenticator on a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
authName: The name of the authenticator (e.g., 'activedirectory').
profileName: The name of the profile to remove (e.g., 'Default Profile').

Command: `completeftp site httpheader`

Manage custom HTTP headers for a site. HTTP headers can be used to control caching, security policies, and other web server behaviors.

Sub-commands: list set remove

Command: `completeftp site httpheader list`

List all custom HTTP headers configured for a site.

Arguments:

siteName: (Optional) The name of the site whose HTTP headers you want to list. If omitted, the default site is assumed.

Command: `completeftp site httpheader set`

Add a new HTTP header or modify an existing one for a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
name: The name of the HTTP header field to set (e.g., 'Cache-Control').
value: The value to assign to the HTTP header field (e.g., 'no-cache').

Command: `completeftp site httpheader remove`

Remove a custom HTTP header from a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
name: The name of the HTTP header field to remove (e.g., 'Cache-Control').

Command: `completeftp site mimetype`

Manage MIME types for a site. MIME types determine how different file types are handled by clients and servers.

Sub-commands: list set remove

Command: `completeftp site mimetype list`

List all MIME types configured for a site.

Arguments:

siteName: (Optional) The name of the site whose MIME types you want to list. If omitted, the default site is assumed.

Object Type: String[]

Command: `completeftp site mimetype set`

Add a new MIME type or modify an existing one for a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
name: The file extension associated with the MIME type (e.g., '.json').
value: The MIME type to assign to the extension (e.g., 'application/json').

Command: `completeftp site mimetype remove`

Remove a MIME type association from a site.

Arguments:

siteName: The name of the site (e.g., 'Default Site').
name: The file extension whose MIME type association you want to remove (e.g., '.json').

Command: `completeftp webapp`

Manage web applications (web-apps) hosted by CompleteFTP. Web-apps allow you to serve dynamic web content or APIs alongside your FTP services.

Sub-commands: list show set add remove mapping

Command: `completeftp webapp list`

List all web applications configured in CompleteFTP. This provides an overview of available web-apps and their basic properties.

Arguments:

properties: (Optional) Specific properties of the web-apps to display. If omitted, default properties are shown.

Options:

--includeSystem: If set to true, the list will include system web-apps that are built into CompleteFTP. Default is false.

Command: `completeftp webapp show`

Display detailed information about a specific web application, including its configuration settings and mappings to sites.

Arguments:

userName: The name of the web-app to display (e.g., 'MyWebApp').
properties: (Optional) Specific properties to display. If omitted, all web-app properties are shown.

Object Type: WebApp

Command: `completeftp webapp set`

Modify the properties of an existing web application. This can include changing the folder path, enabling or disabling the web-app, or updating other settings.

Arguments:

webAppName: The name of the web-app to modify (e.g., 'MyWebApp').
properties: Web-app property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: WebApp

Command: `completeftp webapp add`

Add a new web application to CompleteFTP. You need to specify a name and the folder where the web-app files are located.

Arguments:

webAppName: The name of the new web-app to add (e.g., 'MyWebApp').
folderPath: The file system path to the folder where the web-app files are stored. The folder must already exist (e.g., 'C:\WebApps\MyWebApp').

Command: `completeftp webapp remove`

Remove an existing web application from CompleteFTP. This will delete the web-app's configuration but will not affect the actual files on disk.

Arguments:

webAppName: The name of the web-app to remove (e.g., 'MyWebApp').

Command: `completeftp webapp mapping`

Manage the mapping of web applications to sites. This defines which sites the web-app is available on and under which URL paths.

Sub-commands: show set

Command: `completeftp webapp mapping show`

Display the site mappings for a specific web-app, optionally for a specific site.

Arguments:

webAppName: The name of the web-app whose mappings you want to view (e.g., 'MyWebApp').
site: (Optional) The name of the site for which to display the mapping. If omitted, mappings for all sites are shown.

Object Type: SiteWebAppMapping

Command: `completeftp webapp mapping set`

Set or modify the properties of a web-app's site mapping. This can include changing the URL path or enabling/disabling the mapping.

Arguments:

webAppName: The name of the web-app to modify (e.g., 'MyWebApp').
site: (Optional) The name of the site to modify. If omitted, the default site is assumed.
properties: Site mapping property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: SiteWebAppMapping

Command: `completeftp extension`

Manage extensions in CompleteFTP. Extensions allow you to extend the functionality of CompleteFTP by adding custom scripts or assemblies.

Sub-commands: list show set addscript registerscript registerassembly remove call

Command: `completeftp extension list`

List all extensions that are currently registered in CompleteFTP. This includes custom extensions and, optionally, system extensions.

Arguments:

properties: (Optional) Specific properties of the extensions to display. If omitted, default properties are shown.

Options:

--includeSystem: If set to true, the list will include system extensions that are built into CompleteFTP. Default is false.

Command: `completeftp extension show`

Display detailed information about a specific extension, including its type, configuration, and associated scripts or assemblies.

Arguments:

extensionName: The name of the extension to display (e.g., 'MyCustomExtension').
properties: (Optional) Specific properties to display. If omitted, all extension properties are shown.

Object Type: Extension

Command: `completeftp extension set`

Modify the properties of an existing extension. This can include changing its configuration, enabling or disabling it, or updating other settings.

Arguments:

extensionName: The name of the extension to modify (e.g., 'MyCustomExtension').
properties: Extension property assignments in the format 'property=value' or simply 'property' for interactive entry. Properties vary depending on the extension type.

Object Type: Extension

Command: `completeftp extension addscript`

Add a JSS extension script. The script is read from a file or stdin and stored in the configuration database.

Arguments:

extensionName: The name of the new extension to add (e.g., 'MyScriptExtension').
extensionType: The type of the extension. Acceptable values are 'filesystem', 'customcommand', 'event', 'authentication', or 'ipfilter'.
script: The file path to the JSS script file or '-' to read the script from standard input. The script contains the code that defines the extension's functionality.
properties: (Optional) Property assignments for the extension in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Command: `completeftp extension registerscript`

Arguments:

extensionName: The name of the extension to add (e.g., 'MyScriptExtension').
extensionType: The type of the extension. Acceptable values are 'filesystem', 'customcommand', 'event', 'authentication', or 'ipfilter'.
scriptFilePath: The file path to the JSS script file to register (e.g., 'C:\Scripts\myextension.jss').
properties: (Optional) Property assignments for the extension in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Command: `completeftp extension registerassembly`

Register a .NET assembly as an extension. This allows you to use compiled .NET code to extend CompleteFTP's functionality.

Arguments:

extensionName: The name of the extension to add (e.g., 'MyAssemblyExtension').
extensionType: The type of the extension. Acceptable values are 'filesystem', 'customcommand', 'event', 'authentication', 'jsstodotnetbridge', or 'ipfilter'.
scriptFilePath: The file path to the .NET assembly DLL file (e.g., 'C:\Assemblies\MyExtension.dll').
className: The fully qualified class name within the assembly that implements the extension (e.g., 'MyNamespace.MyExtensionClass').
properties: (Optional) Property assignments for the extension in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Command: `completeftp extension remove`

Remove an existing extension from CompleteFTP. This will delete the extension's configuration but will not affect the associated script or assembly files.

Arguments:

extensionName: The name of the extension to remove (e.g., 'MyCustomExtension').

Command: `completeftp extension call`

Execute a custom command defined by an extension. This allows you to invoke custom functionality provided by the extension from the CLI.

Arguments:

functionName: The name of the custom function to execute, as defined in the extension (e.g., 'MyCustomFunction').
functionArguments: Arguments to pass to the function. The number and type of arguments depend on the function's definition.

Command: `completeftp server`

Manage servers in a CompleteFTP cluster. Clustering allows multiple CompleteFTP servers to share configurations and provide high availability.

Sub-commands: list show set add remove

Command: `completeftp server list`

List all servers that are part of the CompleteFTP cluster. This shows the servers' statuses and key properties.

Arguments:

properties: (Optional) Specific properties of the servers to display. If omitted, default properties are shown.

Command: `completeftp server show`

Display detailed information about a specific server or all servers in the cluster.

Arguments:

serverName: (Optional) The name of the server to display. If omitted, details for all servers are shown.
properties: (Optional) Specific properties to display. If omitted, all server properties are shown.

Object Type: Server

Command: `completeftp server set`

Modify the configuration of a server in the cluster. This can include changing synchronization settings or server roles.

Arguments:

serverName: The name of the server to modify (e.g., 'Server1').
properties: Server property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: Server

Command: `completeftp server add`

Add a new server to the CompleteFTP cluster. You need to provide connection details and administrative credentials for both the local and remote servers.

Arguments:

localUserName: The administrator username on the local server (e.g., 'admin').
localPassword: The administrator password on the local server.
remoteAddress: The IP address or hostname of the remote server to add to the cluster (e.g., '192.168.1.2').
remotePort: The port number of the admin site on the remote server (typically '14983').
remoteUserName: The administrator username on the remote server (e.g., 'admin').
remotePassword: The administrator password on the remote server.

Command: `completeftp server remove`

Remove a server from the CompleteFTP cluster. This will stop configuration synchronization with that server.

Arguments:

serverName: The name of the server to remove from the cluster (e.g., 'Server2').

Command: `completeftp notification`

Manage email notifications in CompleteFTP. Email notifications can alert administrators to various events occurring on the server.

Sub-commands: smtp list show set add remove

Command: `completeftp notification smtp`

Configure the SMTP settings used to send email notifications.

Sub-commands: show set

Command: `completeftp notification smtp show`

Display the current SMTP settings, including server address, port, and authentication details.

Object Type: SmtpSettings

Command: `completeftp notification smtp set`

Set or modify the SMTP settings for sending email notifications.

Arguments:

properties: SMTP setting assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: SmtpSettings

Command: `completeftp notification list`

List all email notifications configured in CompleteFTP. This shows what events trigger notifications and to whom they are sent.

Arguments:

properties: (Optional) Specific properties of the notifications to display. If omitted, default properties are shown.

Command: `completeftp notification show`

Display detailed information about a specific email notification or all notifications.

Arguments:

notificationName: (Optional) The name of the email notification to display. If omitted, details for all notifications are shown.
properties: (Optional) Specific properties to display. If omitted, all notification properties are shown.

Object Type: EmailNotification

Command: `completeftp notification set`

Modify the properties of an existing email notification. This can include changing the recipient, subject, message, or events that trigger the notification.

Arguments:

notificationName: The name of the email notification to modify.
properties: Email notification property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: EmailNotification

Command: `completeftp notification add`

Add a new email notification. You can specify which events trigger the notification and customize the message content.

Arguments:

name: The name of the new email notification (e.g., 'HighLoadAlert').
events: A comma-separated list of events that will trigger the notification (e.g., 'LogIn,UploadFile'). Available events are StartServer, StopServer, StartSite, StopSite, LogIn, LogOut, ChangeDirectory, UploadFile, DownloadFile, MoveFile, DeleteFile, CreateFolder, DeleteFolder, MoveFolder, Timer, AutoBan, CertificateExpiring, CertificateExpired, and ClusterSyncFailed
to: The email address of the recipient (e.g., 'admin@example.com').
from: The email address of the sender (e.g., 'noreply@example.com').
subject: The subject line of the email message.
message: The body text of the email message. You can include placeholders for dynamic content.

Command: `completeftp notification remove`

Remove an existing email notification from CompleteFTP.

Arguments:

notificationName: The name of the email notification to remove (e.g., 'HighLoadAlert').

Command: `completeftp trigger`

Manage process triggers in CompleteFTP. Process triggers allow you to execute external programs or scripts in response to server events.

Sub-commands: processcontrol list show set add remove

Command: `completeftp trigger processcontrol`

Configure global settings for process control, such as the maximum number of concurrent processes.

Sub-commands: show set

Command: `completeftp trigger processcontrol show`

Display the current process control settings.

Object Type: ProcessSettings

Command: `completeftp trigger processcontrol set`

Set or modify the process control settings.

Arguments:

properties: Process control setting assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: ProcessSettings

Command: `completeftp trigger list`

List all process triggers configured in CompleteFTP. This shows which events trigger processes and what actions are taken.

Arguments:

properties: (Optional) Specific properties of the triggers to display. If omitted, default properties are shown.

Command: `completeftp trigger show`

Display detailed information about a specific process trigger or all triggers.

Arguments:

triggerName: (Optional) The name of the process trigger to display. If omitted, details for all triggers are shown.
properties: (Optional) Specific properties to display. If omitted, all trigger properties are shown.

Object Type: ProcessTrigger

Command: `completeftp trigger set`

Modify the properties of an existing process trigger. This can include changing the events that trigger it or the process that is executed.

Arguments:

triggerName: The name of the process trigger to modify (e.g., 'FileUploadTrigger').
properties: Process trigger property assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: ProcessTrigger

Command: `completeftp trigger add`

Add a new process trigger. You can specify which events trigger the process and the action to take.

Arguments:

name: The name of the new process trigger (e.g., 'FileUploadTrigger').
events: A comma-separated list of events that will trigger the process (e.g., 'UploadFile,DeleteFile'). Available events are StartServer, StopServer, StartSite, StopSite, LogIn, LogOut, ChangeDirectory, UploadFile, DownloadFile, MoveFile, DeleteFile, CreateFolder, DeleteFolder, MoveFolder, Timer, AutoBan, CertificateExpiring, CertificateExpired, ClusterSyncFailed
type: The type of process to run. Acceptable values are 'Program', 'JSS', or (Windows only) 'Batch', 'PowerShell', 'FTPScript'.
process: For scripts, the script content; for programs, the file path to the executable (e.g., '/usr/lib/mytool').
args: (Optional) Arguments to pass to the program or script. Not used for JSS scripts.

Command: `completeftp trigger remove`

Remove an existing process trigger from CompleteFTP.

Arguments:

triggerName: The name of the process trigger to remove (e.g., 'FileUploadTrigger').

Command: `completeftp monitor`

Show or set monitoring settings in CompleteFTP. Monitoring includes logging levels, auditing, and event recording.

Sub-commands: show set

Command: `completeftp monitor show`

Display the current monitoring settings, including logging level and auditing configuration.

Arguments:

properties: Specific monitoring properties to display. If omitted, all monitoring properties are shown.

Object Type: MonitoringSettings

Command: `completeftp monitor set`

Set or modify the monitoring settings.

Arguments:

properties: Monitoring setting assignments in the format 'property=value' or simply 'property' for interactive entry. See object type for a list of available properties.

Object Type: MonitoringSettings

Command: `completeftp license`

Manage CompleteFTP trial and production licenses, including activation, requesting activation keys, applying keys, releasing licenses, and viewing license information.

Sub-commands: trial activate release show

Command: `completeftp license trial`

Manage CompleteFTP trial licenses.

Sub-commands: offlinerequest offlineapply

Command: `completeftp license trial offlinerequest`

Generate an offline activation request for a trial license.

Command: `completeftp license trial offlineapply`

Apply an offline trial activation key returned by the EnterpriseDT licensing server.

Arguments:

activationKey: The trial activation key to apply (e.g., 'TRIAL-ABC123XYZ').

Command: `completeftp license activate`

Activate a CompleteFTP license using different methods.

Sub-commands: online offlinerequest offlineapply

Command: `completeftp license activate online`

Activate a license directly using purchase reference, username, and password.

Arguments:

purchaseRef: The purchase reference associated with the license (e.g., 'ABC123456').
userName: The username of the account used to activate the license (e.g., 'jdoe').
password: The password of the account used to activate the license.

Options:

-type: (Optional) The type of the license reference. Acceptable values are 'SID', 'UUID', or 'AWSInstanceName'.

Command: `completeftp license activate offlinerequest`

Request an activation key for a CompleteFTP license using the purchase reference.

Arguments:

purchaseRef: The purchase reference associated with the license (e.g., 'ABC123456').

Options:

-type: (Optional) The type of the license reference. Acceptable values are 'SID', 'UUID', or 'AWSInstanceName'.

Command: `completeftp license activate offlineapply`

Apply an activation key to activate a CompleteFTP license.

Arguments:

activationKey: The activation key to apply (e.g., 'XYZ789123').

Command: `completeftp license release`

Release this server's CompleteFTP license either online or offline.

Sub-commands: online offlinerequest offlineconfirm

Command: `completeftp license release online`

Release this server's license directly using username, and password.

Arguments:

userName: The username of the account used to activate the license (e.g., 'jdoe').
password: The password of the account used to activate the license.

Command: `completeftp license release offlinerequest`

Request a deactivation key for this server's CompleteFTP license. Access this URL to obtain a deactivation key.

Command: `completeftp license release offlineconfirm`

Confirm the deactivation using the deactivation key and return confirmation URL that must be accessed to release the activation from the license server.

Arguments:

activationKey: The deactivation key to apply (e.g., 'XYZ789123').

Command: `completeftp license show`

Show detailed information about the current CompleteFTP license.

Object Type: LicenseInfo

Types

Type `ActiveDirectoryAuthenticator`

Represents the configuration of an Active Directory Authenticator

Properties

profiles (Object): The profiles for this active directory.
autoCreateHomeOverrides (Boolean): Whether or not to automatically create home directory overrides.
enabled (Boolean): Whether this authenticator is enabled.
logInAsUser (String): The username to log in as, or null to use the current user.

Type `AuditingSettings`

Settings related to auditing within CompleteFTP.

Properties

enabled (Boolean): Whether auditing is enabled.
useRollingFiles (Boolean): Whether to use rolling audit log files.
maxRollingFiles (Number): The maximum number of rolling audit log files to keep.

Type `Authenticator`

Represents the base configuration of an authenticator object. The configuration of each particular authenticator is different, and is determined by the extensions that have been installed.

Properties

enabled (Boolean): Whether this authenticator is enabled.
logInAsUser (String): The username to log in as, or null to use the current user.

Type `AuthenticatorManager`

Provides a container for the available authenticators within the CompleteFTP configuration. The available authenticators and their configurations are dynamic based on the installed extensions.

Properties

saml (SamlAuthenticator): The SAML authenticator settings.
database (DatabaseAuthenticator): The database authenticator settings.
gateway (GatewayAuthenticator): The gateway authenticator settings.
activedirectory (ActiveDirectoryAuthenticator): The ActiveDirectory authenticator settings.
ldap (LdapAuthenticator): The LDAP authenticator settings.
items (Authenticator[]): An array of the Authenticators.

Type `AuthenticatorProfile`

Encapsulates the settings of a specific authenticator profile, such as a SAML IDP or a remote server for the gateway authenticator

Properties

Type `DatabaseAuthenticator`

Represents the configuration of a Database Authenticator

Properties

providerName (String): The name of the database provider.
connectionString (String): The database connection string.
query (String): The database query to run.
isPasswordHashed (Boolean): Whether the password is hashed.
enabled (Boolean): Whether this authenticator is enabled.
logInAsUser (String): The username to log in as, or null to use the current user.

Type `EmailNotification`

Represents an email notification in the CompleteFTP configuration.

Properties

id (String): The unique ID of the email notification.
name (String): The name of the email notification.
enabled (Boolean): Whether the email notification is enabled.
onError (Boolean): Whether to trigger the notification on errors.
onSuccess (Boolean): Whether to trigger the notification on success.
pathFilterInverse (Boolean): Whether to invert the path filter.
userFilterInverse (Boolean): Whether to invert the user filter.
siteFilterInverse (Boolean): Whether to invert the site filter.
schedule (String): The schedule of the notification.
pathFilter (String): A filter applied to the path to check if this notification should trigger.
subject (String): The email subject line.
message (String): The email message body.
from (String): The sender email address.
to (String): The recipient email address(es).
rowOrder (Number): The order of this rule.
events (String): A comma-separated string of event types that will trigger the notification.
sites (String): A comma-separated string of site names on which the notification should trigger.
users (String): A comma-separated string of usernames on which the notification should trigger.

Type `EventRecordingSettings`

Settings related to event recording within CompleteFTP.

Properties

enabled (Boolean): Whether event recording is enabled.
importAuditing (Boolean): Whether to import auditing events into the event recorder.

Type `Extension`

Represents an extension in the CompleteFTP configuration.

Properties

id (String): The unique ID of the extension.
type (String): The type of the extension.
name (String): The name of the extension.
className (String): The class name of the extension.
editorClassName (String): The class name of the editor for this extension.
assemblyPath (String): The path of the extension's assembly file.
configuration (String): The configuration string for the extension.
configurationPath (String): The path to the configuration file.
createdTime (String): The time the extension was created.
modifiedTime (String): The last modified time of the extension.
users (String): A comma separated string of user names that have access to this extension.
groups (String): A comma separated string of group names that have access to this extension.

Type `FileNameFilterManager`

Manages file name filters for a site.

Properties

matchingFilesBlocked (Boolean): Indicates whether to block matching files or not.
items (String[]): An array of the Strings.

Type `Folder`

Represents a folder in the CompleteFTP configuration.

Properties

id (String): The unique ID of the folder.
inbuilt (Boolean): Whether the folder is an inbuilt folder.
hidden (Boolean): Whether the folder is hidden.
showRecursiveListing (Boolean): Whether to show recursive listing for this folder.
name (String): The name of the folder.
createdTime (String): The time the folder was created.
modifiedTime (String): The last modified time of the folder.
fullPath (String): The full path of the folder.
type (String): The type of the folder.
mappingPath (String): The mapping path for the folder.
mapping (string | object): The mapping configuration object for the folder.
hasSubfolders (Boolean): Whether the folder has subfolders
access (FolderAccess): The access control for the folder.

Type `FolderAccess`

Represents access control settings for a folder.

Properties

owner (UserFolderPermissions): The owner permissions.
group (GroupFolderPermissions): The group permissions.
allUsers (WorldFolderPermissions): The all user permissions.
inherits (Boolean): Whether this folder inherits permissions from its parent.

Type `GatewayAuthenticator`

Represents the configuration of a Gateway Authenticator

Properties

profiles (Object): The profiles for the gateway.
enabled (Boolean): Whether this authenticator is enabled.
logInAsUser (String): The username to log in as, or null to use the current user.

Type `Group`

Represents a group in the CompleteFTP configuration.

Properties

id (String): The unique ID of the group.
name (String): The name of the group.
createdTime (String): The time the group was created.
modifiedTime (String): The last modified time of the group.
inbuilt (Boolean): Indicates if the group is a system group.
members (GroupMembershipManager): Manages group members.

Type `GroupFolderPermissions`

Represents group permissions settings for a folder.

Properties

groupName (String): The group name that owns this folder, or null if this folder inherits from its parent.
permissions (String): A comma-separated string of permissions for this folder.

Type `GroupMembershipManager`

Manages the membership of a group.

Properties

items (GroupMembership[]): An array of the GroupMemberships.

Type `HttpHeader`

Represents an HTTP header.

Properties

fieldName (String): The name of the header.
fieldValue (String): The value of the header.

Type `HttpHeaderManager`

Manages HTTP headers for a site.

Properties

items (HttpHeader[]): An array of the HttpHeaders.

Type `IpFilterManager`

Manages IP filters for a site.

Properties

precedence (String): Gets or sets the IP filter precedence ('DenyOverAllow' or 'AllowOverDeny').
items (IpFilterRule[]): An array of the IpFilterRules.

Type `IpFilterRule`

Represents an IP filter rule.

Properties

id (String): The unique ID of the IP filter rule.
host (String): The host or IP address or 'all' to apply this filter rule to.
action (String): The action for the filter rule ('Allow' or 'Deny').
userName (String): The username to apply this rule to.

Type `LdapAuthenticator`

Represents the configuration of an LDAP Authenticator

Properties

server (String): The server for the LDAP authenticator.
userName (String): The user name for the LDAP authenticator.
password (String): The password for the LDAP authenticator.
query (String): The LDAP query for this authenticator.
ssl (Boolean): Whether to use ssl for this authenticator.
validate (Boolean): Whether or not to validate the certificates.
userMatching (Boolean): Whether or not to use user matching.
port (Number): The port to connect to.
version (Number): The version of LDAP to use.
enabled (Boolean): Whether this authenticator is enabled.
logInAsUser (String): The username to log in as, or null to use the current user.

Type `LicenseInfo`

Provides information about the current CompleteFTP license.

Properties

edition (String): The edition of the license (e.g., 'Standard', 'Professional').
machineID (String): The machine ID associated with the license.
licenseID (String): The license ID.
isTrial (Boolean): Whether the license is a trial license.
activationKey (String): The activation key for the license, or null if not set.
expiryDate (String): The expiry date of the license, or null if the license does not expire.
licenseType (String): The type of license ('server' or 'corporate').
activationType (String): The type of machine id that was used when the activation key was generated.

Type `LoggingSettings`

Settings related to logging within CompleteFTP.

Properties

level (String): The logging level (e.g., 'Debug', 'Info', 'Warning', 'Error').

Type `MimeType`

Represents a MIME type.

Properties

extension (String): The file extension for the MIME type.
mimeType (String): The MIME type.

Type `MimeTypeManager`

Manages MIME types for a site.

Properties

items (MimeType[]): An array of the MimeTypes.

Type `MonitoringSettings`

Provides settings for monitoring, logging, and auditing within the CompleteFTP configuration.

Properties

logging (LoggingSettings): Settings related to logging.
auditing (AuditingSettings): Settings related to auditing.
eventRecording (EventRecordingSettings): Settings related to event recording.

Type `PasswordPolicy`

Represents the password policy settings.

Properties

allowChange (Boolean): Allows users to change their passwords.
minLength (Number): Minimum password length.
mustHaveMixedCase (Boolean): Password must have mixed case characters.
mustHaveDigit (Boolean): Password must contain at least one digit.
mustHaveSpecialChar (Boolean): Password must contain at least one special character.
requireChangeAfterDays (number): Number of days after which a password change is required or null.
denyAccessAfterDays (number): Number of days after which access is denied if the password is not changed or null.
store (Boolean): (Only if not readOnly) If the password should be stored.

Type `ProcessSettings`

Settings for the process control.

Properties

runSequentially (Boolean): Indicates whether to run the processes sequentially.
maxProcesses (Number): The maximum number of concurrent processes to run.
runTimeoutMs (Number): The timeout for the processes (in ms).

Type `ProcessTrigger`

Represents a process trigger rule in the CompleteFTP configuration.

Properties

id (String): The unique ID of the process trigger rule.
name (String): The name of the process trigger rule.
type (String): The type of process to run ('program', 'jssscript').
enabled (Boolean): Whether the process trigger rule is enabled.
onError (Boolean): Whether to trigger the process on errors.
onSuccess (Boolean): Whether to trigger the process on success.
pathFilterInverse (Boolean): Whether to invert the path filter.
userFilterInverse (Boolean): Whether to invert the user filter.
siteFilterInverse (Boolean): Whether to invert the site filter.
schedule (String): The schedule of the trigger.
pathFilter (String): A filter applied to the path to check if this trigger should run.
workingDirectory (String): The working directory for the process.
runAsUser (String): The username of the user to run the process as, or null to run as system.
runOnSite (String): The site name on which to run the process or null to run on all sites.
rowOrder (Number): The order of this rule.
events (String): A comma-separated string of event types that will trigger the process.
sites (String): A comma-separated string of site names on which the process trigger should run.
users (String): A comma-separated string of usernames on which the process trigger should run.
processPath (String): The path to the executable, only for process type 'program'.
arguments (String): The arguments to pass to the process or script.
script (String): The script for type jssScript

Type `SamlAuthenticator`

Represents the configuration of a SAML Authenticator

Properties

profiles (Object): The profiles of the SAML authenticator.
validateCerts (Boolean): Whether or not to validate the certificates.
siteUrl (String): The site url for the SAML authenticator.
givenName (String): The given name property for the SAML authenticator.
company (String): The company property for the SAML authenticator.
emailAddress (String): The email address property for the SAML authenticator.
telephoneNumber (String): The telephone number property for the SAML authenticator.
surname (String): The surname property for the SAML authenticator.
enabled (Boolean): Whether this authenticator is enabled.
logInAsUser (String): The username to log in as, or null to use the current user.

Type `Server`

Represents a server in the CompleteFTP cluster configuration.

Properties

name (String): The name of the server.
machineName (String): The machine name of the server.
activationKey (String): The activation key of the server.
latestMachineID (String): The latest machine ID of the server.
ipAddresses (String): The IP addresses of the server.
syncPeriod (Number): The sync period for the server.
preferredMachineIDType (Number): The preferred machine ID type for the server.
akMachineIDType (Number): The machine ID type for the activation key.
syncEnabled (Boolean): Whether synchronization is enabled for the server.
isPrimary (Boolean): Whether this is the primary server.
createdTime (String): The time the server was created.
modifiedTime (String): The last modified time of the server.
lastContactTime (String): The last contact time of the server or null if the server is not running or is the primary server.
connection (Object): The connection details for this server.
siteMapping (SiteServerMapping[]): The site mappings for this server.
logLevel (String): The log level of the server.

Type `Site`

Represents a site in the CompleteFTP configuration.

Properties

isAdmin (Boolean): Whether the site is the admin site.
pasvIP (String): The IP address for passive FTP connections.
pasvWhiteList (String): The white list for passive IP addresses.
allowOverWriteOnRename (Boolean): Whether to allow overwriting files when renaming.
anonymousEnabled (Boolean): Whether anonymous FTP is enabled.
anonymousHTTPEnabled (Boolean): Whether anonymous HTTP is enabled.
archiveNavEnabled (Boolean): Whether to allow archive navigation.
backslashPathSep (Boolean): Whether to use backslashes as path separators.
enabled (Boolean): Whether the site is enabled.
ftpEnabled (Boolean): Whether FTP is enabled for the site.
ftpsEnabled (Boolean): Whether FTPS is enabled for the site.
ftpsImplicitEnabled (Boolean): Whether FTPS implicit is enabled for the site.
ftpsVerifyClient (Boolean): Whether to verify the client certificate when using FTPS.
hideProductVersion (Boolean): Whether to hide the product version.
homeDirIsRoot (Boolean): Whether the home directory is treated as the root.
httpBasicAuth (Boolean): Whether to use HTTP basic authentication.
httpEnabled (Boolean): Whether HTTP is enabled for the site.
httpsEnabled (Boolean): Whether HTTPS is enabled for the site.
jssEnabled (Boolean): Whether JSS is enabled for the site.
redirectPassiveIPSecureOnly (Boolean): Whether to redirect passive IP only for secure connections.
scpEnabled (Boolean): Whether SCP is enabled for the site.
sftpEnabled (Boolean): Whether SFTP is enabled for the site.
sharingEnabled (Boolean): Whether sharing is enabled for the site.
showHiddenFiles (Boolean): Whether to show hidden files.
showInaccessibleVirtualFolders (Boolean): Whether to show inaccessible virtual folders.
sshForwardingEnabled (Boolean): Whether SSH forwarding is enabled for the site.
sshTerminalEnabled (Boolean): Whether SSH terminal access is enabled for the site.
system (Boolean): Whether this is a system site.
archiveNavSuffix (String): The archive navigation suffix.
defaultDomain (String): The default domain for this site.
htmlErrorTemplate (String): The HTML error template.
htmlListingTemplate (String): The HTML listing template.
name (String): The name of the site.
welcomeMessage (String): The welcome message for the site.
label (String): The label of the site.
anonymousMaxConnections (Number): The maximum number of anonymous connections.
autoBanDuration (Number): The duration of the autoban.
autoBanTriggerCount (Number): The number of autoban triggers.
autoBanTriggerPeriod (Number): The autoban trigger period.
maxConnections (Number): The maximum number of connections.
maxConnectionsHTTP (Number): The maximum number of HTTP connections.
maxConnectionsPerUser (Number): The maximum number of connections per user.
maxLoginAttempts (Number): The maximum number of login attempts.
pasvPortMax (Number): The maximum passive port.
pasvPortMin (Number): The minimum passive port.
portFTP (Number): The FTP port.
portFTPSImplicit (Number): The FTPS implicit port.
portHTTP (Number): The HTTP port.
portHTTPS (Number): The HTTPS port.
portSFTP (Number): The SFTP port.
timeoutIdle (Number): The idle timeout.
timeoutLogin (Number): The login timeout.
timeoutPassiveWait (Number): The passive wait timeout.
timeoutStalled (Number): The stalled timeout.
listingFormat (String): The format of the file listing.
encoding (String): The encoding for the site.
readOnly (Boolean): Sets the site as read only.
fileEncryptionMode (String): The file encryption mode for the site.
minimumSSLVersion (String): The minimum SSL version supported by the site (none, ssl3, tls1, tls11, tls12, tls13).
sshAuthMethods (String): A comma separated string of SSH authentication methods.
sshCipher (String): A comma separated string of SSH ciphers.
sshCompression (String): A comma separated string of SSH compression methods.
sshMAC (String): A comma separated string of SSH MAC methods.
sshKeyAlgorithm (String): A comma separated string of SSH key algorithms.
sshKeyExchange (String): A comma separated string of SSH key exchange methods.
sslCipherSuites (String): A comma separated string of SSL cipher suites.
timeoutHTTP (Number): The HTTP timeout.
serverMapping (SiteServerMapping[]): The server mapping for this site.
createdTime (String): The time the site was created.
modifiedTime (String): The last modified time of the site.
sshKeys (SshKeys): The SSH key pairs for the site.
sslCertificate (SiteSslCertificate): The SSL certificate for the site.
defaultWebApp (String): Gets or sets the default web app name.
fileNameFilter (FileNameFilterManager): The file name filter settings for the site.
ipFilter (IpFilterManager): The IP filter settings for the site.
authenticators (AuthenticatorManager): The authenticators for the site.
httpHeaders (HttpHeaderManager): The HTTP headers for the site.
mimeTypes (MimeTypeManager): The MIME types for the site.
homePath (String): The path of the home folder of the site.
allowedHostNames (String): Comma-separated list of allowed hostnames (may include wildcards, *), e.g. mydomain, my.domain, *.mydomain.

Type `SiteServerMapping`

Represents a mapping of a site to a server.

Properties

name (String): The name of the server.
enabled (Boolean): Whether the site is enabled on the server.
ftpInterfaces (String): The FTP interfaces for this server mapping.
sftpInterfaces (String): The SFTP interfaces for this server mapping.
httpInterfaces (String): The HTTP interfaces for this server mapping.

Type `SiteSshEcdsaKeys`

Manages ECDSA SSH key pairs for a site.

Properties

p256 (String): The ECDSA P256 public key string, or null if not set.
p384 (String): The ECDSA P384 public key string, or null if not set.
p521 (String): The ECDSA P521 public key string, or null if not set.

Type `SiteSslCertificate`

Represents an SSL certificate for a site.

Properties

commonName (String): The common name of the certificate.
organization (String): The organization of the certificate.
organizationalUnit (String): The organizational unit of the certificate.
locality (String): The locality of the certificate.
state (String): The state of the certificate.
country (String): The country of the certificate.
subjectAltName (String): The Subject Alternative Name (SAN) of the certificate.
serialNumber (String): The serial number of the certificate.
thumbprint (String): The thumbprint of the certificate.
validFrom (String): The start date for which the certificate is valid.
validTo (String): The end date for which the certificate is valid.
keySize (Number): The key size of the certificate.

Type `SiteUserMapping`

Represents a user's mapping to a site.

Properties

siteName (String): The name of the site.
enabled (Boolean): Whether the mapping is enabled.
homeFolder (String): The path to the user's home folder for the site, or null if not set.
homeWebApp (String): Gets or sets the home web app for this site mapping or null if not set.

Type `SiteUserMappingManager`

Manages site mappings for a user.

Properties

items (SiteUserMapping[]): An array of the SiteUserMappings.

Type `SiteWebAppMapping`

Represents the mapping of a web app to a site.

Properties

siteName (String): The name of the site.
enabled (Boolean): Whether the site is enabled for the web app.
urlPath (String): The url path for this web app on this site.

Type `SmtpSettings`

Represents SMTP settings for sending email notifications.

Properties

host (String): The SMTP host address.
port (Number): The SMTP port number.
userName (String): The user name to authenticate with the SMTP server.
password (String): The password to authenticate with the SMTP server.
enableSSL (Boolean): Whether to use SSL for the SMTP connection.
defaultFromAddress (String): The default sender email address.

Type `SshKeys`

Manages SSH key pairs for a site.

Properties

dsa (String): The DSA public key string, or null if not set.
rsa (String): The RSA public key string, or null if not set.
ed25519 (String): The ED25519 public key string, or null if not set.
ecdsa (SiteSshEcdsaKeys): The ECDSA public key strings.

Type `SshPublicKey`

Represents an SSH public key.

Properties

algorithm (String): The algorithm used for the key.
key (String): The key string itself.

Type `SshPublicKeysManager`

Manages SSH public keys for a user.

Properties

items (SshPublicKey[]): An array of the SshPublicKeys.

Type `User`

Represents a user in the CompleteFTP configuration.

Properties

id (String): The unique ID of the user.
type (String): The authentication type ('os' or 'internal').
inbuilt (Boolean): Whether the user is an inbuilt user or not.
userName (String): The user's username.
fullName (String): The user's full name.
description (String): The user's description.
email (String): The user's email address.
sshTerminalShell (String): The user's SSH terminal shell.
passwordHash (String): The hash of the user password, or null if not set.
enabled (Boolean): Whether the user is enabled.
ftpEnabled (Boolean): Whether FTP is enabled for the user.
ftpsEnabled (Boolean): Whether FTPS is enabled for the user.
homeDirIsRoot (Boolean): Whether the home directory is treated as the root.
httpEnabled (Boolean): Whether HTTP is enabled for the user.
httpsEnabled (Boolean): Whether HTTPS is enabled for the user.
jssEnabled (Boolean): Whether JSS is enabled for the user.
reportDecryptedSize (Boolean): Whether to report the decrypted size.
scpEnabled (Boolean): Whether SCP is enabled for the user.
sftpEnabled (Boolean): Whether SFTP is enabled for the user.
sshForwardingEnabled (Boolean): Whether SSH forwarding is enabled for the user.
sshTerminalEnabled (Boolean): Whether SSH terminal access is enabled for the user.
sharingEnabled (Boolean): Whether sharing is enabled for the user.
twoFactorAuthEnabled (Boolean): Whether two-factor authentication is enabled for the user.
quotaSpeedDownload (Number): The user's download speed quota.
quotaSpeedUpload (Number): The user's upload speed quota.
quotaStorage (Number): The user's storage quota.
createdTime (String): The time the user was created.
modifiedTime (String): The last modified time of the user.
passwordChangeTime (String): The last time the password was changed.
expiryDate (String): User expiry date or null if not set.
password (String): (Write-only, only for internal users) Allows setting or retrieving the password for internal users. (Getting the password requires it to be decrypted).
sshAuthMethods (String): Comma-separated string of allowed SSH authentication types.
filesEncryptedAtRest (Boolean): Indicates whether files are encrypted at rest.
accessControl (String): Gets or sets the access control.
readOnly (Boolean): Sets the user as read only.
siteMapping (SiteUserMappingManager): Manages site mappings for the user.
sshPublicKeys (SshPublicKeysManager): Manages the user's SSH public keys.

Type `UserFolderPermissions`

Represents user permissions settings for a folder.

Properties

userName (String): The username that owns this folder, or null if this folder inherits from its parent.
permissions (String): A comma-separated string of permissions for this folder.

Type `WebApp`

Represents a web application in the CompleteFTP configuration.

Properties

id (String): The unique ID of the web application.
name (String): The name of the web application.
folderPath (String): The full path of the folder that contains the web application.
system (Boolean): Indicates if the web application is a system web application.
createdTime (String): The time the web application was created.
modifiedTime (String): The last modified time of the web application.
siteMapping (SiteWebAppMapping[]): The site mappings for this web app.

Type `WorldFolderPermissions`

Represents world permissions settings for a folder.

Properties

permissions (String): A comma-separated string of permissions for this folder.

Type `String`

Any sequence of printable characters. If this includes a space then the whole argument must be inside double quotes.

Type `Number`

Any integer number.

Type `Boolean`

Must be either true or false.

Type `Date`

A date of the format, yyyy-mm-dd or yyyy-mm-ddThh:mm:ss.

CompleteFTP CLI Reference

Getting Started

Top-Level Commands

Properties

Viewing Properties

Setting Properties

siteName and serverName

Date properties

Array Properties

Object Viewer

List of Commands

Command Details

Command: completeftp folder

Command: completeftp folder add

Command: completeftp folder remove

Command: completeftp folder show

Command: completeftp folder set

Command: completeftp folder list

Command: completeftp folder listall

Command: completeftp folder move

Command: completeftp folder chown

Command: completeftp folder chmod

Command: completeftp user

Command: completeftp user passwordpolicy

Command: completeftp user passwordpolicy show

Command: completeftp user passwordpolicy set

Command: completeftp user list

Command: completeftp user show

Command: completeftp user set

Command: completeftp user add

Command: completeftp user key

Command: completeftp user key show

Command: completeftp user key add

Command: completeftp user key remove

Command: completeftp user mapping

Command: completeftp user mapping show

Command: completeftp user mapping set

Command: completeftp user home

Command: completeftp user remove

Command: completeftp user 2fa

Command: completeftp user 2fa enable

Command: completeftp user 2fa disable

Command: completeftp user 2fa status

Command: completeftp user 2fa reset

Command: completeftp user 2fa backuppins

Command: completeftp group

Command: completeftp group list

Command: completeftp group show

Command: completeftp group add

Command: completeftp group remove

Command: completeftp group memberlist

Command: completeftp group memberadd

Command: completeftp group memberremove

Command: completeftp site

Command: completeftp site list

Command: completeftp site show

Command: completeftp site set

Command: completeftp site add

Command: completeftp site remove

Command: completeftp site cert

Command: completeftp site cert import

Command: completeftp site cert export

Command: completeftp site cert generate

Command: completeftp site key

Command: completeftp site key show

Command: completeftp site key import

Command: completeftp site key remove

Command: completeftp site ipfilter

Command: completeftp site ipfilter list

Command: completeftp site ipfilter precedence

Command: completeftp site ipfilter add

Command: completeftp site ipfilter remove

Command: completeftp site ipfilter test

Command: completeftp site filenamefilter

Command: completeftp site filenamefilter show

Command: completeftp site filenamefilter set

Command: completeftp site filenamefilter add

Command: completeftp site filenamefilter remove

Command: completeftp site auth

Command: completeftp site auth list

`siteName` and `serverName`

Command: `completeftp folder`

Command: `completeftp folder add`

Command: `completeftp folder remove`

Command: `completeftp folder show`

Command: `completeftp folder set`

Command: `completeftp folder list`

Command: `completeftp folder listall`

Command: `completeftp folder move`

Command: `completeftp folder chown`

Command: `completeftp folder chmod`

Command: `completeftp user`

Command: `completeftp user passwordpolicy`

Command: `completeftp user passwordpolicy show`

Command: `completeftp user passwordpolicy set`

Command: `completeftp user list`

Command: `completeftp user show`

Command: `completeftp user set`

Command: `completeftp user add`

Command: `completeftp user key`

Command: `completeftp user key show`

Command: `completeftp user key add`

Command: `completeftp user key remove`

Command: `completeftp user mapping`

Command: `completeftp user mapping show`

Command: `completeftp user mapping set`

Command: `completeftp user home`

Command: `completeftp user remove`

Command: `completeftp user 2fa`

Command: `completeftp user 2fa enable`

Command: `completeftp user 2fa disable`

Command: `completeftp user 2fa status`

Command: `completeftp user 2fa reset`

Command: `completeftp user 2fa backuppins`

Command: `completeftp group`

Command: `completeftp group list`

Command: `completeftp group show`

Command: `completeftp group add`

Command: `completeftp group remove`

Command: `completeftp group memberlist`

Command: `completeftp group memberadd`

Command: `completeftp group memberremove`

Command: `completeftp site`

Command: `completeftp site list`

Command: `completeftp site show`

Command: `completeftp site set`

Command: `completeftp site add`

Command: `completeftp site remove`

Command: `completeftp site cert`

Command: `completeftp site cert import`

Command: `completeftp site cert export`

Command: `completeftp site cert generate`

Command: `completeftp site key`

Command: `completeftp site key show`

Command: `completeftp site key import`

Command: `completeftp site key remove`

Command: `completeftp site ipfilter`

Command: `completeftp site ipfilter list`

Command: `completeftp site ipfilter precedence`

Command: `completeftp site ipfilter add`

Command: `completeftp site ipfilter remove`

Command: `completeftp site ipfilter test`

Command: `completeftp site filenamefilter`

Command: `completeftp site filenamefilter show`

Command: `completeftp site filenamefilter set`

Command: `completeftp site filenamefilter add`

Command: `completeftp site filenamefilter remove`

Command: `completeftp site auth`

Command: `completeftp site auth list`

Command: `completeftp site auth show`

Command: `completeftp site auth set`

Command: `completeftp site auth profile`

Command: `completeftp site auth profile list`

Command: `completeftp site auth profile show`

Command: `completeftp site auth profile set`

Command: `completeftp site auth profile add`

Command: `completeftp site auth profile remove`

Command: `completeftp site httpheader`

Command: `completeftp site httpheader list`

Command: `completeftp site httpheader set`