Axigen Documentation

The Command Line Interface (in short CLI) is an interface the configuration of the Axigen service and permits the automation of specific administrative tasks via custom tools. In order to do that, a CLI listener will be available on a specified address, thus the commands can be issued using common tools such as Telnet, Netcat, etc.

CLI Service Description

CLI is a TCP service for the Axigen messaging solution, just like SMTP, IMAP, POP3, etc. The CLI service can be configured in its turn similarly to the other services, either by editing the configuration files or by using the remote configuration tools like CLI and WebAdmin. It has common parameters such as maxErrors, logLevel, etc. and also a list of listeners for configuring incoming connections.

The connection to the service must be authenticated using an Axigen server administrator account. This can be the default "admin" account or a delegated admin user.

CLI is structured in contexts, each of them including a specific set of commands. CLI also uses a common set of commands. Each context provides commands allowing switching to the previous and next context and a HELP command to view the available commands at that specific location. When connected, the login context is activated and an username and password must be provided. After activation, the initial context becomes active. The initial context is the only one not having a name in the command prompt.

CLI is a TCP service with specified dedicated socket accessible using Telnet applications and Netcat. CLI provides added functionality such as, apart from providing an alternate method of performing basic configuration tasks, it allows automating administration tasks using scripts (adding users, migration).