Cell Management Tool Reference

The cell management tool is a command-line utility that you can use to manage a VMware Cloud 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/. You can use it to run a single command or run it as an interactive shell.

Listing Available Commands

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

./cell-management-tool -h

Using Shell Mode

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 running. To exit the shell mode, type exit at the cmt> prompt.

Cell Management Tool Usage Help

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

Starting with VMware Cloud Director 10.3, to troubleshoot failed access to the VMware Cloud Director UI, you must use the https://{api_host}/cloudapi/1.0.0/site/settings/cors API endpoint instead of a CMT command. For more information, see Troubleshoot Failed Access to the VMware Cloud Director User Interface.