The cell management tool is a command-line utility that you can use to manage a vCloud Director cell or database. Superuser or system administrator credentials are required for most operations.

The cell management tool is installed in /opt/vmware/vcloud-director/bin/cell-management-tool. You can use it to execute a single command or run it as an interactive shell.

To list the available cell management tool commands, use the following command line.

./cell-management-tool -h

You can run the cell management tool as an interactive shell by invoking it with no arguments, as shown here.

[root@cell1 /opt/vmware/vcloud-director/bin]#./cell-management-tool
Cell Management Tool v8.14.0.4146350
Type "help" for available subcommands.
cmt>

While in shell mode, you can type any cell management tool command at the cmt> prompt, as shown in this example.

cmt>cell -h
usage: cell [options]
               -a,--application-states     display the state of each application
                                           on the cell [DEPRECATED - use the
                                           cell-application command instead]
               -h,--help                   print this message
               -i,--pid <arg>              the process id of the cell [REQUIRED
                                           if username is not specified]
               -m,--maintenance <arg>      gracefully enter maintenance mode on
                                           the cell
               -p,--password <arg>         administrator password [OPTIONAL]
               -q,--quiesce <arg>          quiesce activity on the cell
               -s,--shutdown               gracefully shutdown the cell
               -t,--status                 display activity on the cell
               -tt,--status-verbose        display a verbose description of
                                           activity on the cell
               -u,--username <arg>         administrator username [REQUIRED if
                                           pid is not specified]
Note: You will be prompted for administrator password if not entered in command
line.
cmt>

The command returns to the cmt> prompt when it finishes executing. To exit shell mode, type exit at the cmt> prompt.

This example runs a single, non-interactive command that lists available shell management tool commands.

[root@cell1 /opt/vmware/vcloud-director/bin]# ./cell-management-tool -h

usage: cell-management-tool
-h,--help   print this message

Available commands:
cell - Manipulates the Cell and core components
certificates - Reconfigures the SSL certificates for the cell
.
.
.

For command specific help:
 cell-management-tool <commandName> -h

Use the cell command of the cell management tool to suspend the task scheduler so that new tasks cannot be started, to check the status of active tasks, to control cell maintenance mode, and to shut down the cell gracefully.

Use the cell-application command of the cell management tool to control the set of applications that the cell runs on startup.

Use the dbextract command of the cell management tool to export data from the vCloud Director database.

vCloud Director uses the Quartz job scheduler to co-ordinate asynchronous operations (jobs) running on the system. If the Quartz scheduler database becomes corrupted, you might not be able to quiesce the system successfully. Use the fix-scheduler-data command of the cell management tool to scan the database for corrupt scheduler data and repair that data as needed.

Use the certificates command of the cell management tool to replace the cell's SSL certificates.

Use the generate-certs command of the cell management tool to generate new self-signed SSL certificates for the cell.

Use the ciphers command of the cell management tool to configure the set of cipher suites that the cell offers to use during the SSL handshake process.

Use the ssl-protocols command of the cell management tool to configure the set of SSL protocols that the cell offers to use during the SSL handshake process.

Use the configure-metrics command of the cell management tool to connect the cell to the optional metrics database.

If you know the vCloud Director database username and password, you can use the recover-password command of the cell management tool to recover the vCloud Director system administrator password.

Use the fail-tasks command of the cell management tool to update the completion status associated with tasks that were running when the cell was deliberately shut down. You cannot use the fail-tasks command unless all cells have been shut down.

Use the configure-audit-syslog command of the cell management tool to configure the way the system logs audit messages.

Use the reconfigure-database command of the cell management tool to update connection properties for the vCloud Director database. This command cannot be used to change the database type or migrate data to another database instance.

Use the system-setup command of the cell management tool to initialize the server group's database with a system administrator account and related information.

Use the manage-email command of the cell management tool to manage the templates that the system uses when creating email alerts.

Use the find-orphan-vms command of the cell management tool to find references to virtual machines that are present in the vCenter database but not in the vCloud Director database.

Use the configure-ceip command of the cell management tool to join or leave the VMware Customer Experience Improvement Program (CEIP).