This section lists all CLI contexts and their specific commands, as displayed in the Command Line Interface. You may use this list as reference to find out what operations you can perform using CLI.

Login Context

The commands available for the Login context are:
HELP - prints this help message
EXIT/QUIT - exits CLI and closes connection to AXIGEN
USER <user> - CLI username, (in this version only "admin" username is implemented)
GET VERSION - gets the AXIGEN version
SET CONSOLE-CODES on|off - sets the color and other console codes on/off
SET QUIET off|on - enables/disables detailed information
SHOW - shows the options for this context

Initial Conext

The commands available for the Initial context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
LIST Domains [wildcard (ex: domain*)] - lists the domains of this server
LIST domainActivationRequests - lists the requests made for domain registration
CLEAR domainActivationRequests - clear the list of requests not pending
SAVE CONFIG [<path>] - saves the server's running configuration (a suffix will be added)
CONFIG SERVER - enters the Server context
SET admin-password <password> - sets the admin password (max. 32 chars) (OBSOLETE - kept for backward compatibility)
CHANGE password oldPassword <pass> newPassword <pass> - chnages your password (max. 32 chars)
ENTER QUEUE - enters the Queue context
ENTER AACL - enters the Administrative ACL context
ENTER DEBUG - enters the Debug context
CREATE Domain name <name> domainLocation <path> postmasterPassword <pass> - creates a domain (changes context)
REGISTER Domain domainLocation <path> - registers a domain to the server (changes context)
UNREGISTER Domain name <domainName> - unregisters a domain from the server
UPDATE Domain name <domainName> - updates a domain from the server (changes context)
SHOW Domain name <domainName> [ATTR <param>] - shows the given domain

Server Context

The commands available for the Server context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config [<path>] - saves the server's running configuration (a suffix will be added)
SHOW Config - shows the entire server's running configuration
SET [services (list of services)] - sets the services for the server
SET [primaryDomain <name>] - sets the server's primary domain
SET [sslRandomFile <file>] - sets file for entropy data used when generating random
SET [enableIOSynchronization <yes|no>] - enables/disables the I/O synchronization for file storages
LIST Usermaps - shows the list of usermaps
RESET - resets the service to the currently active configuration
CONFIG LOG - enters the Log context
CONFIG CLI - enters the CLI context
CONFIG RPOP - enters the RPOP context
CONFIG SMTP-INCOMING - enters the SMTP-Incoming context
CONFIG SMTP-OUTGOING - enters the SMTP-Outgoing context
CONFIG PROCESSING - enters the Processing context
CONFIG POP3 - enters the POP3 context
CONFIG IMAP - enters the IMAP context
CONFIG WEBMAIL - enters the Webmail context
CONFIG WEBADMIN - enters the Webadmin context
CONFIG FTP-BACKUP - enters the FTP-Backup context
CONFIG DNR - enters the DNR context
CONFIG REPORT - enters the Report context
CONFIG POP3-Proxy - enters the POP3 Proxy context
CONFIG IMAP-Proxy - enters the IMAP Proxy context
CONFIG USERDB - enters the User Database context
CONFIG PERMISSIONS - enters the Permissions context
CONFIG FILTERS - enters the Filters context
ADD Usermap [name] <name> - adds an usermap to the service (changes context)
UPDATE Usermap [name] <name> - updates an usermap from the service (changes context)
REMOVE Usermap [name] <name> - removes an usermap from the service
SHOW Usermap [name] <name> [ATTR <param>] - shows the given usermap

CLI Context

The commands available for the CLI context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
START Service - starts the cli service
STOP Service - stops the cli service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxAuthCommands <maxCmds>] - sets max no. of commands that can be issued before authentication
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
CONFIG AccessControl - enters the AccessControl context
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener

Listener context

The commands available for the Listener context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SET [address <address>] - sets the listener's address - only usable in an UPDATE operation
SET [enable <yes|no>] - enable/disable the listener

Listener context (as subcontext of proxy services)

The commands available for the Listener context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
LIST AllowRules - lists the allow rules for this listener
LIST DenyRules - lists the deny rules for this listener
SET [address <address>] - sets the listener's address - only usable in an UPDATE operation
SET [enable <yes|no>] - enable/disable the listener
SET [maxConnections <maxConn>] - sets max number of connections
SET [timeInterval <interval>] - sets the time interval
SET [maxIntervalConnections <interval>] - sets max connections in time interval
SET [peerMaxConnections <maxConn>] - sets sets max connections no. from a single host
SET [peerTimeInterval <interval>] - sets the time interval - single host
SET [peerMaxIntervalConnections <interval>] - sets max connections in time interval - single host
SET [idleTimeout <timeout>] - sets the inactivity timeout
SET [sslEnable <yes|no>] - enable/disable SSL on the listener
SET [listenerDomain <domain>] - if specified, will act as primary domain for connections made on this listener
CONFIG SSLCONTROL - enters the SslControl context
ADD DenyRule [ipSet] <ipRange> [enable <yes|no>] [priority <priority>] - adds a deny rule to the listener
UPDATE DenyRule [ipSet] <ipRange> [enable <yes|no>] [priority <priority>] - updates a deny rule from the listener
REMOVE DenyRule [ipSet] <ipRange> - removes a deny rule from the listener
SHOW DenyRule [ipSet] <ipRange> - shows the given rule
ADD AllowRule [ipSet] <ipRange> - adds an allow rule to the listener(changes context)
UPDATE AllowRule [ipSet] <ipRange> - updates an allow rule from the listener(changes context)
REMOVE AllowRule [ipSet] <ipRange> - removes an allow rule from the listener
SHOW AllowRule [ipSet] <ipRange> - shows the given rule

Listener context (as subcontext of non-proxy services)

The commands available for the Listener context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
LIST AllowRules - lists the allow rules for this listener
LIST DenyRules - lists the deny rules for this listener
SET [address <address>] - sets the listener's address - only usable in an UPDATE operation
SET [enable <yes|no>] - enable/disable the listener
SET [maxConnections <maxConn>] - sets max number of connections
SET [timeInterval <interval>] - sets the time interval
SET [maxIntervalConnections <interval>] - sets max connections in time interval
SET [peerMaxConnections <maxConn>] - sets sets max connections no. from a single host
SET [peerTimeInterval <interval>] - sets the time interval - single host
SET [peerMaxIntervalConnections <interval>] - sets max connections in time interval - single host
SET [idleTimeout <timeout>] - sets the inactivity timeout
SET [sslEnable <yes|no>] - enable/disable SSL on the listener
CONFIG SSLCONTROL - enters the SslControl context
ADD DenyRule [ipSet] <ipRange> [enable <yes|no>] [priority <priority>] - adds a deny rule to the listener
UPDATE DenyRule [ipSet] <ipRange> [enable <yes|no>] [priority <priority>] - updates a deny rule from the listener
REMOVE DenyRule [ipSet] <ipRange> - removes a deny rule from the listener
SHOW DenyRule [ipSet] <ipRange> - shows the given rule
ADD AllowRule [ipSet] <ipRange> - adds an allow rule to the listener(changes context)
UPDATE AllowRule [ipSet] <ipRange> - updates an allow rule from the listener(changes context)
REMOVE AllowRule [ipSet] <ipRange> - removes an allow rule from the listener
SHOW AllowRule [ipSet] <ipRange> - shows the given rule

Allow Rule Context

The commands available for the AllowRule context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [ipSet <ipSet>] - sets the ipSet parameter - only usable in an UPDATE operation
SET [enable <yes|no>] - enable/disable the rule
SET [priority <priority>] - sets the rule's priority
SET [maxConnections <maxConn>] - sets max number of connections
SET [timeInterval <interval>] - sets the time interval
SET [maxIntervalConnections <interval>] - sets max connections in time interval
SET [peerMaxConnections <maxConn>] - sets sets max connections no. from a single host
SET [peerTimeInterval <interval>] - sets the time interval - single host
SET [peerMaxIntervalConnections <interval>] - sets max connections in time interval - single host

SSL Control Context

The commands available for the SSLControl context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [allowedVersions (version list)] - sets SSL versions allowed
SET [maxChainDepth <maxDepth>] - sets max depth of verification
SET [cipherSuite <cipher>] - sets the cipher suite to be used
SET [useEphemeralKey <yes|no>] - use/not use ephemeral keys
SET [certFile <file>] - sets path for certification chain file
SET [caFile <file>] - sets path for certificate authorities file
SET [dhParamFile <file>] - sets path to Diffie-Hellman param file
SET [requestClientAuth <yes|no>] - request/not request client authentication

Log Context

The commands available for the Log context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
LIST Rules - lists rules
START Service - starts the log service
STOP Service - stops the log service
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener
ADD Rule [priority] <priority> - adds a rule (changes context)
UPDATE Rule [priority] <priority> - updates a rule (changes context)
REMOVE Rule [priority] <priority> - removes a rule
SHOW Rule [priority] <priority> [ATTR <param>] - shows the given rule

Rule Context

The commands available for the Rule context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [priority <priority>] - sets the rule's priority - only usable in an UPDATE operation
SET [hostname <hostname>] - sets hostname of the user of this rule
SET [module <module>] - sets module of the user of this rule. Valid names: DNR USERDB LOG REPORTING PROCESSING SMTP-IN SMTP-OUT CLI POP3 IMAP WEBMAIL WEBADMIN FTP-BACKUP RPOP PROXY_POP3 PROXY_IMAP *=ALL)
SET [logLevel <level>] - sets the log level
SET [fileName <name>] - sets the name of the destination file
SET [fileSize <size>] - sets the maximum size of the destination file in KB
SET [fileTime <time>] - sets the maximum duration the destination file is used in seconds
SET [fileCount <count>] - sets the maximum number of old (saved) files kept
SET [rotatePeriod <period>] - sets the period after which a file change is forced (choice: none|day|week|month)
SET [type <type>] - sets the type of the rule (choice: local|remote)

SMTP-Incoming Context

The commands available for the SMTP-Incoming context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
START Service - starts the smtp incoming service
STOP Service - stops the smtp incoming service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [maxReceivedHeaders <maxHeaders>] - sets max no. of received headers for a mail
SET [userdbConnectorType <type>] - sets the type of the userdb connector
SET [userdbConnectorName <name>] - sets the name of the userdb connector
SET [enableSmtpRouting <yes|no>] - allow this service to become a routing smtp service
RESET - resets the service to the currently active configuration
CONFIG mappingData - enters the mapping data context
CONFIG AccessControl - enters the AccessControl context
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener

SMTP-Outgoing Context

The commands available for the SMTP-Outgoing context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
START Service - starts the smtp outgoing service
STOP Service - stops the smtp outgoing service
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
RESET - resets the service to the currently active configuration

Processing Context

The commands available for the Processing context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
START Service - starts the processing service
STOP Service - stops the processing service
SET [maxSchedInterval <maxInterval>] - sets max interval for rescheduling a mail
SET [schedInterval <interval>] - sets interval for rescheduling queue checking
SET [maxRetryCount <count>] - sets max no. of times for trying to deliver
SET [queuePath <path>] - sets path to internal server queue
SET [queueEntryCount <count>] - sets upper limit for no. of sub-directories in queue
SET [deliveryThreads <threads>] - sets no. of threads handling SMTP delivery
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [procQueueSize <size>] - sets the size of internal processing queue
SET [messagesPerSecond <no>] - sets the maximum number of messages a mail box can receive in one second
SET [disableInterval <no>] - sets the time interval a mail box will be disabled if messagesPerSecond limit is exceeded
RESET - resets the service to the currently active configuration

POP3 Context

The commands available for the POP3 context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
START Service - starts the pop3 service
STOP Service - stops the pop3 service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [allowStartTLS <yes|no>] - allow|not allow secure connections (STLS command)
SET [secureConnAuthTypes (types)] - sets types of authentication on secure conn.
SET [plainConnAuthTypes (types)] - sets types of authentication on plain conn.
SET [secureConnAllowLogin <yes|no>] - allow/not allow plain text login on secure conn.
SET [plainConnAllowLogin <yes|no>] - allow/not allow plain text login on plain conn.
SET [userdbConnectorType <type>] - sets the type of the userdb connector
SET [userdbConnectorName <name>] - sets the name of the userdb connector
CONFIG AccessControl - enters the AccessControl context
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <name>] - shows the given listener

IMAP Context

The commands available for the IMAP context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
START Service - starts the imap service
STOP Service - stops the imap service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [allowStartTLS <yes|no>] - allow/not allow secure connections
SET [secureConnAuthTypes (types)] - sets types of authentication on secure conn.
SET [plainConnAuthTypes (types)] - sets types of authentication on plain conn.
SET [secureConnAllowLogin <yes|no>] - allow/not allow plain text login on secure conn.
SET [plainConnAllowLogin <yes|no>] - allow/not allow plain text login on plain conn.
SET [userdbConnectorType <type>] - sets the type of the userdb connector
SET [userdbConnectorName <name>] - sets the name of the userdb connector
CONFIG AccessControl - enters the AccessControl context
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener

Webmail Context

The commands available for the Webmail context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
LIST UrlRedirects - lists the rules used for secure login
LIST HostNameResolvers - lists the hostname resolvers
START Service - starts the webmail service
STOP Service - stops the webmail service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [path <path>] - sets the location of HSP files
SET [sessionIdleTimeout <timeout>] - sets the inactivity timeout
SET [sessionActivityTimeout <timeout>] - sets maximum living time for a session
SET [allowKeepAlive <yes|no>] - enables/disables persistent connection
SET [allowLargeIncomingData <yes|no>] - enables/disables receiving incoming data after the limit is exceeded
SET [httpHeadersMaxSize <size>] - sets the maximum allowed size for received HTTP headers
SET [httpBodyMaxSize <size>] - sets the maximum allowed size for incoming HTTP body
SET [uploadMaxSize <size>] - sets the maximum allowed size for incoming upload data
SET [showDomainList <yes|no>] - enables/disables displaying domains list at user login
SET [userdbConnectorType <type>] - sets the type of the userdb connector
SET [userdbConnectorName <name>] - sets the name of the userdb connector
CONFIG AccessControl - enters the AccessControl context
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener
ADD HostNameResolver [host] <host> domain <domain>
UPDATE HostNameResolver [host] <host> domain <domain>
REMOVE HostNameResolver [host] <host>
ADD UrlRedirect [address] <address> port <port> host <host>
UPDATE UrlRedirect [address] <address> [port <port>] [host <host>]
REMOVE UrlRedirect [address] <address>

Webadmin Context

The commands available for the Webadmin context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
LIST UrlRedirects - lists the rules used for secure login
START Service - starts the webadmin service
STOP Service - stops the webadmin service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [path <path>] - sets the location of HSP files
SET [sessionIdleTimeout <timeout>] - sets the inactivity timeout
SET [sessionActivityTimeout <timeout>] - sets maximum living time for a session
SET [allowKeepAlive <yes|no>] - enables/disables persistent connection
SET [allowLargeIncomingData <yes|no>] - enables/disables receiving incoming data after the limit is exceeded
SET [httpHeadersMaxSize <size>] - sets the maximum allowed size for received HTTP headers
SET [httpBodyMaxSize <size>] - sets the maximum allowed size for incoming HTTP body
SET [uploadMaxSize <size>] - sets the maximum allowed size for incoming upload data
CONFIG AccessControl - enters the AccessControl context
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener
ADD UrlRedirect [address] <address> port <port> host <host>
UPDATE UrlRedirect [address] <address> [port <port>] [host <host>]
REMOVE UrlRedirect [address] <address>

FTP Backup Context

The commands available for the FTP-Backup context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
START Service - starts the ftp backup service
STOP Service - stops the ftp backup service
SET [maxErrors <maxErrors>] - sets max no. of wrong commands
SET [maxAuthErrors <maxErrors>] - sets max no. of failed authentications
SET [maxConnThreads <maxThreads>] - sets max no. of threads handling the conn.
SET [minConnThreads <minThreads>] - sets min no. of threads handling the conn.
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
CONFIG AccessControl - enters the AccessControl context
RESET - resets the service to the currently active configuration
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener

DNR Context

The commands available for the DNR context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Nameservers - lists the nameservers
START Service - starts the dnr service
STOP Service - stops the dnr service
SET [timeout <timeout>] - sets the timeout
SET [retries <retries>] - sets the number of retries
SET [cacheSize <cacheSize>] - sets the cache size
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
RESET - resets the service to the currently active configuration
ADD Nameserver [priority] <priority> - adds a nameserver to the service (changes context)
UPDATE Nameserver [priority] <priority> - updates a nameserver from the service (changes context)
REMOVE Nameserver [priority] <priority> - removes a nameserver from the service
SHOW Nameserver [priority] <priority> [ATTR <param>] - shows the given nameserver

Name Server Context

The commands available for the NameServer context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [priority <priority>] - sets the priority of the nameserver
SET [address <address>] - sets the IP of the nameserver
SET [timeout <timeout>] - sets the timeout for first DNS query
SET [retries <retries>] - sets the maximum number of DNS queries retries

Report Context

The commands available for the Report context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SAVE Config - saves the server's running configuration
LIST Listeners - lists available listeners
LIST SNMPTrapDestinations - lists available SNMP trap destinations
START Service - starts the report service
STOP Service - stops the report service
SET [logLevel <level>] - sets the service's logging level
SET [logType <type>] - sets the service's logging type
SET [logHost <host>] - sets the service's remote logging host
SET [SNMPEnable <yes|no>] - enables/disables the snmp module
SET [SNMPSentTrapsToAllManagers <yes|no>] - no description
SET [SNMPCommunity <string>] - no description
ADD Listener [address] <address> - adds a listener to the service (changes context)
UPDATE Listener [address] <address> - updates a listener from the service (changes context)
REMOVE Listener [address] <address> - removes a listener from the service
SHOW Listener [address] <address> [ATTR <param>] - shows the given listener
ADD SNMPTrapDestination <address> - adds a snmp trap destination to the service
REMOVE SNMPTrapDestination <address> - removes a snmp trap destination from the service
RESET - resets the service to the currently active configuration

Filters Context (as subcontext of server|domain|folderRcpt|group|list)

The commands available for the Filters context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - switches back to the previous context
LIST ScriptFilters - lists the script filters defined
LIST SocketFilters - lists the socket filters defined
LIST ActiveFilters - lists the active filters
LIST Filters - lists all three categories of filters
ADD ScriptFilter [name] <name> file <file> - adds a script filter (changes context)
UPDATE ScriptFilter [name] <name> - updates a script filter (changes context)
REMOVE ScriptFilter [name] <name> - removes a script filter from the listener
SHOW ScriptFilter [name] <name> [ATTR <param>] - shows the given script filter
ADD SocketFilter [name] <name> address <addr> protocolFile <file> - adds a socket filter (changes context)
UPDATE SocketFilter [name] <name> - updates a socket filter (changes context)
REMOVE SocketFilter [name] <name> - removes a socket filter from the listener
SHOW SocketFilter [name] <name> [ATTR <param>] - shows the given socket filter
ADD ActiveFilter [priority] <no.> filterName <name> filterType <type> - adds an active filter to the active filter list (changes context)
UPDATE ActiveFilter [priority] <no.> - updates a filter (changes context)
REMOVE ActiveFilter [priority] <no.> - removes a filter from the active filter list
SHOW ActiveFilter [priority] <no.> [ATTR <param>] - shows the given filter

Filters Context (as subcontext of account|accountClass)

The commands available for the Filters context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
LIST ScriptFilters - lists the script filters defined
LIST SocketFilters - lists the socket filters defined
LIST ActiveFilters - lists the active filters
LIST Filters - lists all three categories of filters
ADD ScriptFilter [name] <name> file <file> - adds a script filter (changes context)
UPDATE ScriptFilter [name] <name> - updates a script filter (changes context)
REMOVE ScriptFilter [name] <name> - removes a script filter from the listener
SHOW ScriptFilter [name] <name> [ATTR <param>] - shows the given script filter
ADD SocketFilter [name] <name> address <addr> protocolFile <file> - adds a socket filter (changes context)
UPDATE SocketFilter [name] <name> - updates a socket filter (changes context)
REMOVE SocketFilter [name] <name> - removes a socket filter from the listener
SHOW SocketFilter [name] <name> [ATTR <param>] - shows the given socket filter
ADD ActiveFilter [priority] <no.> filterName <name> filterType <type> - adds an active filter to the active filter list (changes context)
UPDATE ActiveFilter [priority] <no.> - updates a filter (changes context)
REMOVE ActiveFilter [priority] <no.> - removes a filter from the active filter list
SHOW ActiveFilter [priority] <no.> [ATTR <param>] - shows the given filter
RESET - Inherit filters

ScriptFilter Context

The commands available for the ScriptFilter context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [name <name>] - sets the name of the filter - only usable in an UPDATE operation
SET [type <type>] - sets the type of the script filter
SET [file <path>] - sets the path to the file where the script is located

SocketFilter Context

The commands available for the SocketFilter context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [name <name>] - sets the name of the filter - only usable in an UPDATE operation
SET [address <addr>] - sets the address of the filter, used to communicate with the filter
SET [protocolFile <path>] - sets the path to the ASFL file that describes the communication protocol
SET [idleTimeout <timeout>] - sets the inactivity timeout of the connection (in seconds)
SET [actionOnMatch <action>] - sets the action to be taken in case the filter matches an email
SET [maxConnections <no.>] - sets the maximum number of connections that will be made to the filter

ActiveFilter Context

The commands available for the ActiveFilter context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [priority <priority>] - sets the priority of the filter - only usable in an UPDATE operation
SET [filterName <name>] - sets the name of the filter as defined in the socket/script object sets
SET [filterType <type>] - sets type of the filter (to which object set belongs)
SET [applyOn (local and/or relay)] - Specifies where this filter is activated (local, relay delivery or both)

ActiveFilter Context

The commands available for the ActiveFilter context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [priority <priority>] - sets the priority of the filter - only usable in an UPDATE operation
SET [filterName <name>] - sets the name of the filter as defined in the socket/script object sets
SET [filterType <type>] - sets type of the filter (to which object set belongs)

ActiveFilter Context

The commands available for the ActiveFilter context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [priority <priority>] - sets the priority of the filter - only usable in an UPDATE operation
SET [filterName <name>] - sets the name of the filter as defined in the socket/script object sets
SET [filterType <type>] - sets type of the filter (to which object set belongs)

Domain Context

Important! When creating domains, one message storage location with the default 32GB size is recommended for each predicted 20GB of message occupied storage space. For larger spaces, additional message storage locations should be created or the default parameters modified in order to increase total average size for the location to correspond to the number of 20GB storages you need. It is recommended that the occupied space is 2/3 out of the storage location size.

You can add multiple message storage locations using CLI only within the domain creation context. After creating the domain, additional locations cannot be added. The command to create multiple message storage locations is the following:
                    ADD MessagesLocation <path>

The commands available for the Domain context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
LIST Aliases - lists aliases for current domain
LIST Accounts [wildcard (ex: account*)] - lists accounts for current domain
LIST Groups [wildcard (ex: account*)] - lists groups for current domain
LIST FolderRcpts [wildcard (ex: account*)] - lists folder recipients for current domain
LIST Lists [wildcard (ex: account*)] - lists mail lists for current domain
LIST AccountClasses [wildcard (ex: account*)] - lists account classes for current domain
SHOW RegistryInformation - shows registry information
SHOW StorageInformation [details] - shows storage files information (with details per file if option present)
SET [name <name>] - sets the domain's name - only usable in an UPDATE operation
SET [assignedIp <ip>] - sets the assigned ip
SET [services (list of services)] - sets the services for this domain
SET [showWebmailLogin <yes|no>] - enables/disables displaying this domain at Webmail login
SET [createUsersFromLdap <yes|no>] - enables/disables auto-creation of users authenticated from LDAP
SET [publishRcptContacts <yes|no>] - switch indicating if domain recipients contacts are published
SET [enableAppender <yes|no>] - enables/disables the message appender
SET [catchAllType <type>] - sets the type of Catch-All behaviour
SET [catchAllAccountName <value>] - sets the name of the account used to store all messages with unknown recipient
SET [catchAllFolderName <value>] - sets the name of the folder used to store all messages with unknown recipient
ESET appenderText - this text will be appended to all messages sent from this domain
CONFIG MIGRATIONDATA - enters the migrationdata context
CONFIG FILTERS - enters the domain filters context
CONFIG adminLimits - enters the admin limits context
CONFIG accountDefaultFilters - enters the account default filters context
CONFIG accountDefaultLimits - enters the account default limits context
CONFIG accountDefaultQuotas - enters the account default quotas context
CONFIG PUBLIC-FOLDER - enters the Public Folder context
CONFIG PERMISSIONS - enters the Permissions context
ADD Account [name] <name> password <password> - adds an account to the domain (changes context)
UPDATE Account [name] <name> - updates an account from the domain (changes context)
REMOVE Account [name] <name> - removes an account from the domain
SHOW Account [name] <name> [ATTR <param>] - shows the given account
ADD Group [name] <name> - adds a group to the domain (changes context)
UPDATE Group [name] <name> - updates a group from the domain (changes context)
REMOVE Group [name] <name> - removes a group from the domain
SHOW Group [name] <name> [ATTR <param>] - shows the given group
ADD FolderRcpt [name] <name> - adds a folder recipient to the domain (changes context)
UPDATE FolderRcpt [name] <name> - updates a folder recipient from the domain (changes context)
REMOVE FolderRcpt [name] <name> - removes a folder recipient from the domain
SHOW FolderRcpt [name] <name> [ATTR <param>] - shows the given folder recipient
ADD List [name] <listName> password <password> adminEmail <email> - adds a list to this domain (changes context)
UPDATE List [name] <listName> - updates a list from this domain (changes context)
REMOVE List [name] <listName> - removes a list from this domain
SHOW List [name] <listName> [ATTR <param>] - shows the given list
ADD Alias <aliasName> - adds an alias for the domain
REMOVE Alias <aliasName> - removes an alias from the domain
ADD accountClass [name] <accountClassName> - adds an account class for the domain (changes context
UPDATE accountClass [name] <accountClassName> - updates an account class from the domain (changes context)
REMOVE accountClass [name] <accountClassName> - removes an account class from the domain
MIGRATE - migrate command which has the following parameters:

• account <accountName> - the account name for migration
• remoteHost <host> - the host of the migration server
• remotePort <port> - the port of the migration server
• remoteUser <imap-user> - the imap username of the migration server
• remotePass <imap-pass> - the imap password of the migration server
• [ignoreFolders (folders)] - specifies a list of folders as displayed by LIST separated by spaces which will not be migrated
• [overrideQuota <yes|no>] - specifies if the mailbox quota should be overridden (default: no)
• [deleteOriginal <yes|no>] - enables/disables deletion of all migrated messages on the remote server (default: no)
• [structureOnly <yes|no>] - enables migration of only the directory structure (default: no)
• [verbose <yes|no>] - specifies if the command should be verbose (default: no)

LIST Storages - lists all storages registered to AXIGEN
COMPACT All [forced] - compacts all storages registered to AXIGEN
COMPACT Storage usid <storage_usid> [forced] - compacts a storage from the list
UPGRADE Storage - upgrade storage representation of configuration data and folders to current version
REPAIR Accounts <name> [<name>...] - try to recover lost accounts

Domain-Create Context

The commands available for the Domain-Create context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW - shows information about this context
SET [name <name>] - sets domain name
SET [postmasterPassword <pass>] - sets the password to the postmaster account
SET [domainLocation <path>] - sets the domain storage location
SET [domainObjectsLocation <path>] - sets the domain objects (eg: accounts, maillists etc.) storage location
SET [maclSupport <yes|no>] - enables/disables MACL support for this domain
ADD MessagesLocation <path> - adds a messages storage location
REMOVE MessagesLocation <path> - removes a messages storage location

Domain-Register Context

The commands available for the Domain-Register context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW - shows information about this context
SET [domainLocation <path>] - sets the domain storage location
SET [domainObjectsLocation <path>] - sets the domain objects (eg: accounts, maillists etc.) storage location
SET [maclSupport <yes|no>] - enables/disables MACL support for this domain
ADD MessagesLocation <path> - adds a messages storage location
REMOVE MessagesLocation <path> - removes a messages storage location

Domain Administration Limits Context

The commands available for the Domain Administration Limits context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
SET [maxAccounts <no>] - (no description)
SET [maxMaillists <no>] - (no description)
SET [maxGroups <no>] - (no description)
SET [maxFolderRecipients <no>] - (no description)
SET [maxAccountClasses <no>] - (no description)
SET [maxAccountMessageSizeQuota <no>] - (no description)
SET [maxAccountMessageCountQuota <no>] - (no description)
SET [maxAccountFolderCountQuota <no>] - (no description)
SET [maxAccountFolderMessageSizeQuota <no>] - (no description)
SET [maxAccountFolderMessageCountQuota <no>] - (no description)
SET [maxMaillistMessageSizeQuota <no>] - (no description)
SET [maxMaillistMessageCountQuota <no>] - (no description)
SET [maxMaillistFolderCountQuota <no>] - (no description)
SET [maxMaillistFolderMessageSizeQuota <no>] - (no description)
SET [maxMaillistFolderMessageCountQuota <no>] - (no description)
SET [maxPublicFolderMessageSizeQuota <no>] - (no description)
SET [maxPublicFolderMessageCountQuota <no>] - (no description)
SET [maxPublicFolderFolderCountQuota <no>] - (no description)
SET [maxPublicFolderFolderMessageSizeQuota <no>] - (no description)
SET [maxPublicFolderFolderMessageCountQuota <no>] - (no description)
SET [availableServices (list of domain services)] - (no description)

Account Context

The commands available for the Account context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
LIST Aliases - lists aliases for current account
SHOW RegistryInformation - shows registry information
SET [name <name>] - sets the account's name - only usable in an UPDATE operation
SET [password <password>] - sets password for the account
SET [firstName <firstName>] - sets the first name of the account
SET [lastName <lastName>] - sets the last name of the account
CONFIG WEBMAILDATA - enters the webmaildata context
CONFIG FILTERS - enters the filters context
CONFIG QUOTAS - enters the quota context
CONFIG LIMITS - enters the limits context
SHOW ContactInfo [ATTR <param>] - shows the contact information
ADD Alias <aliasName> - adds an alias for the account
REMOVE Alias <aliasName> - removes an alias from the account
UPLOAD wmFilter - uploads a webmail filter for the account
INHERIT SETTINGS FROM domainDefaults - inherit settings from domain defaults (explicit values will not be reset)
INHERIT SETTINGS FROM accountClass <accountClassName> - inherit settings from specified account class (explicit values will not be reset)

Account Class Context

The commands available for the Account Class context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
CONFIG filters - enters the filters context
CONFIG quotas - enters the quota context
CONFIG limits - enters the limits context
SET [name <name>] - sets the account class name - only usable in an UPDATE operation

WebmailData Context (as subcontext of account)

The commands available for the WebmailData context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [skin <skin>] - sets the skin for webmail
SET [pageSize <pageSize>] - sets page size
SET [saveToSent <yes|no>] - sets keep a mail copy in "Sent" folder
SET [deleteToTrash <yes|no>] - sets delete mail to trash
SET [autoRefreshInterval <minutes>] - sets Webmail automatic refresh interval stated in minutes
SET [confirmMailDelete <yes|no>] - sets confirmation of mail delete
SET [confirmFolderEmpty <yes|no>] - sets confirmation of empty folder
SET [htmlFilterLevel <no.>] - sets the security level for a html mail body
SET [language <language>] - sets the webmail's language
SET [usePublicContacts <yes|no>] - indicator if the account should use the domain public contacts in addressbook context
SET [useRcptContacts <yes|no>] - Indicator if the account should use the domain recipient contacts in addressbook context
ESET signature - sets the account's signature

WebmailData Context (as subcontext of list)

The commands available for the WebmailData context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [skin <skin>] - sets the skin for webmail
SET [pageSize <pageSize>] - sets page size
SET [saveToSent <yes|no>] - sets keep a mail copy in "Sent" folder
SET [deleteToTrash <yes|no>] - sets delete mail to trash
SET [autoRefreshInterval <minutes>] - sets Webmail automatic refresh interval stated in minutes
SET [confirmMailDelete <yes|no>] - sets confirmation of mail delete
SET [confirmFolderEmpty <yes|no>] - sets confirmation of empty folder
SET [htmlFilterLevel <no.>] - sets the security level for a html mail body
SET [language <language>] - sets the webmail's language
ESET signature - sets the account's signature

Quotas Context

The commands available for the Quotas context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [mboxCount <count>] - sets the maximum number of folders
SET [totalMessageCount <count>] - sets maximum number of messages in all folders
SET [totalMessageSize <size>] - sets maximum size in KB of all messages in all folders
SET [messageCount <count>] - sets default maximum number of messages in a folder
SET [messageSize <size>] - sets default maximum size in KB of messages in a folder
LIST Mboxes - list the available mboxes for this account
SET MboxQuota mboxName <name> messageCount <count> messageSize <size> - sets quotas for a given mbox
SHOW MboxQuota mboxName <name> - shows quotas for a given mbox

Quotas Context (as subcontext of account)

The commands available for the Quotas context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context
SET [mboxCount <count>] - sets the maximum number of folders
SET [totalMessageCount <count>] - sets maximum number of messages in all folders
SET [totalMessageSize <size>] - sets maximum size in KB of all messages in all folders
SET [messageCount <count>] - sets default maximum number of messages in a folder
SET [messageSize <size>] - sets default maximum size in KB of messages in a folder
SET [quotaLimitThreshold <size>] - sets percent of quota which triggers an alert
SET [quotaLimitNotificationInterval <size>] - sets the minimum interval(in minutes) between two quota limit notifications
SET [quotaLimitNotificationSubject <text>] - sets email subject of quota limit notification message
SET [quotaLimitNotificationEnabled <yes|no>] - enables/disables the quota limit notification
ESET quotaLimitNotificationBody - sets email body of quota limit notification message
LIST Mboxes - list the available mboxes for this account
SET MboxQuota mboxName <name> messageCount <count> messageSize <size> - sets quotas for a given mbox
SHOW MboxQuota mboxName <name> - shows quotas for a given mbox
RESET <attr> - Set an attribute to be inherited