Root Context

Axigen Documentation

The commands available for the Root context are:

  • EXIT/QUIT – exits CLI and closes connection to Axigen

  • HELP – prints this help message

  • LIST Domains [<wildcard> (ex: domain*)] – lists the active domains of this server

  • LIST AllDomains [<wildcard> (ex: domain*)] – lists all the domains (active and inactive) of this server

  • LIST domainActivationRequests – lists the requests made for domain registration

  • CLEAR domainActivationRequests – clears the list of requests not pending

  • SAVE CONFIG [<path>] – saves the server's running configuration (a suffix will be added)

  • SAVE supportInfo [<path>] – saves runtime information; default path is <workingDir>/supportInfo.zip

  • 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> – changes your password (max. 32 chars)

  • SHOW onboardingComplete – shows the value of the onboarding complete flag

  • SET onboardingComplete <yes|no> – sets the onboarding complete flag

  • ENTER QUEUE – enters the Queue context

  • ENTER AACL – enters the Administrative ACL context

  • ENTER TRACER – enters the Webdav tracer context

  • CREATE Domain name <name> domainLocation <path> postmasterPassword <pass> – creates a domain (changes context)

  • CREATE Subdomain prefix <name> parentDomain <name> postmasterPassword <pass> – creates a subdomain (changes context)

  • ENABLE Domain domainLocation <path> – activates a domain to the server using the location parameter

  • ENABLE Domain name <name> – activates a domain to the server using the name parameter

  • DISABLE Domain name <name> – deactivates a domain from the server

  • EDIT Domain domainLocation <path> – edits a domain from the server using the location parameter (changes context)

  • EDIT Domain name <name> – edits a domain from the server using the name parameter (changes context)

  • DELETE Domain domainLocation <path> [dontKeepCopy] – deletes a domain from the server using the location parameter

  • DELETE Domain name <name> [dontKeepCopy] – deletes a domain from the server using the name parameter

  • UPDATE Domain name <domainName> – updates a domain from the server (changes context)

  • SHOW Domain name <domainName> [ATTR <param>] – shows the given domain

  • RESTORE Domain name <domainName> – restores a domain (changes context)

  • SEARCH Object <objectNameOrId>[+<folderNameOrId>][@<domainName>] | +<folderNameOrId>[@<domainName>] | @<domainName> – search for an object by name or id, displaying identity information in case it is found; ids must always be specified in hexa with '0x' prefix

  • LOOKUP Index Object <accountName>+<folderName>@<domainName> – get the search index file for a folder

  • LOOKUP Index File <path> – get the folder for a search index file

  • LIST premiumAccounts [domain <name>] [wildcard (ex: account*)] – lists the premium accounts (all or per domain)

  • SET premiumAccountAddons name <name> addons (list of addons) – sets the addons for a premium account

    • Possible addons: outlook|activesync|sharing|personalorganizer|kav|kas

  • LIST premiumFolderRcpts [domain <name>] [wildcard (ex: account*)] – lists the "premium" folder recipients (all or per domain)

  • SET premiumFolderRcptsAddons name <name> addons (list of addons) – sets the addons for a "premium" folder recipient

    • Possible addons: kav|kas

  • SHOW LicenseInfo – shows license information

  • SHOW PremiumAddonsStatistics – shows the usage statistics for premium addons

  • SHOW AccountingStatistics [since <date>][until <date>] – shows accounting statistics for the last month or a specified period

  • SHOW MigrationStatus – shows migration status

  • SHOW Processing – shows information on ongoing processing work

  • PURGE public|account folders <folderName> [, <folderName>]* [<purgeCondition>] – purge mails from specified folders of all users from all enabled domains

  • SET multilineEOF <string> – set the EOF sequence for multi-line upload commands, defaults to .