|MithiWiki Home > ConnectXf Home > ConnectXf Administration > Configuration > Overview Command Line Interface(CLI) and sample commands|
Connect XF Command Line interfaces
- MCS servers can be administered using the command line interfaces provided.
- The command line interfaces (CLI) allow the administrators to configure, maintain and trouble shoot a Connect XF installation through a script base interface.
- These scripts are wrappers over the complex logic of the Connect XF components and modules and also the open source components.
- All the scripts are located in the folder “/mithi/mcs/bin”.
- Each script takes one or more parameters. To give a comprehensive help on the usage of the scripts, you can refer to the online help or execute the script without any parameters.
- The scripts in the /mithi/mcs/bin folder can be broadly classified as follows:
- Scripts that allow the administrator to control all the server level properties. Some examples are
- The scripts to manage the services on the server,
- Scripts to manage the agents or automatic programs running on the server.
- Scripts for setting up the DR
- Scripts for setting the AD sync etc.
- Scripts that allow the administrator to manipulate the Connect XF entities.
- Scripts that manipulate or query the properties for the Connect XF entities
Commands for Provisioning
- Some examples of provisioning commands are:
- Using the privioning commands you can
- add/delete/rename/disable users
- add/delete/rename groups
- add/delete/rename domains
Commands to set and get Service status
- A command which allows you to check the status and stop / start all services is
- All the services like SMTP, POP etc. have individual commands which allow you to stop, start, restart and query the status of the service.
- The commands are as follows:
/mithi/mcs/bin/<service>.start.sh /mithi/mcs/bin/<service>.stop.sh /mithi/mcs/bin/<service>.restart.sh /mithi/mcs/bin/<service>.status.sh
- Where <service> is the name of the service. Some examples are: httpd, qmail-smtp, qmail-pop etc.
- The above commands can also be accessed as follows:
/etc/init.d/<service> start /etc/init.d/<service> stop /etc/init.d/<service> restart /etc/init.d/<service> status
Commands to configure or customise the Services
- The parameters for each of the services can be configured. This is done through various scripts.
- For example, to set and get the POP concurrency the following commands are used:
- The configuration section of the wiki gives details of the commands:
Agents or programs that can be scheduled or executed
- The command line interface allows you to call programs to manage the system.
- This programs are called agents and can also be run automatically at scheduled times.
- Some examples of the programs are
- delete old files
- sync from AD
- calculate quota
- check the services etc.
- The nomenclature for most of these programs is such that their names start with "agent". For example,
- For newer versions of MCS (2.24+), there is a single command used to diagnose all the modules. This is
- For older version scripts having the following naming are present:
- These programs help audit and diagnose problems related to the configuration of the modules.