Knowledge Base

The VMware Knowledge Base provides support solutions, error messages and troubleshooting guides
 
Search the VMware Knowledge Base (KB)   View by Article ID
 

Using the Cell Management Tool to shut down a vCloud Director cell (1033575)

Details

This article provides information on using the cell management tool to gracefully shut down a vCloud Director cell.
 
This is especially useful when you need to upgrade the version of vCloud Director installed on the cell. Use this process to ensure that there are no tasks running on the cell when you shut it down.

Note:  The attached cell management tool utility is only for vCloud Director 1.0.x.  The cell management tool utility is already included with vCloud Director 1.5.x and 5.1x. In addition, installing the 1.0.x utility on to a vCloud Director 1.5.x or 5.1.x can cause system instability.  Do not attempt to install this utility on a 1.5.x or 5.1.x vCloud Director setup.

Solution

vCloud Director creates a task object to track and manage each asynchronous operation that a user requests. Information about all running and recently completed tasks is stored in the vCloud Director database. Because a database upgrade invalidates this task information, you must be sure that no tasks are running when you begin the upgrade process.
 
With the Cell Management Tool, you can suspend the task scheduler so that new tasks cannot be started, then check the status of all active tasks. You can wait for running tasks to complete or log in to vCloud Director as a system administrator and cancel them. See Cell Management Tool Reference. When no tasks are running, you can use the cell management tool to stop vCloud Director services.


vCloud Director 1.0.x

In vCloud Director 1.0.x, you can use the cell management tool attached to this article to gracefully shut down a vCloud Director cell.

To install the cell management tool:
  1. Log in to the target cell as root.
  2. Download cell-management-tool-1.0.0-bin.tar.gz file attached to this article.
  3. Run this command as the vcloud user to unpack the file: 

    sudo -u vcloud tar -xzvf
    cell-management-tool-1.0.0-bin.tar.gz -C $VCLOUD_HOME

    $VCLOUD_HOME is typically /opt/vmware/cloud-director / .

    Note: Ensure to run the preceding command as the vcloud user. If you do not run the sudo -u command as the vcloud  user, you may experience a vCloud Director outage. 
To gracefully shut down a cell:
  1. Log in to the target cell as root.
  2. Navigate to $VCLOUD_HOME/bin/ (typically /opt/vmware/cloud-director /bin/ ).
  3. Suspend the scheduler by running this command:

    ./cell-management-tool -u username -p -q true

  4. View running tasks by running this command:

    ./cell-management-tool -u username -p -t

  5. When the task count reaches zero, shut down the cell by running this command:

    ./cell-management-tool -u username -p -s

Cell Management Tool Parameters

Parameter
Description
-h or --help
Print help on how to use the tool.
-u arg or --username arg
vCloud Director system administrator user name.
-p arg or --password arg
vCloud Director system administrator password. If you leave the argument blank, you will be prompted for the password.
-q arg or --quiesce arg
Quiesce activity on the cell. The argument true suspends the scheduler; the argument false restarts the scheduler.
-s or --shutdown
Shuts down the cell.
-t or --status
Displays information about the number of tasks running on the cell and the status of the cell.
 

vCloud Director 1.5.x/5.1.x

Starting with vCloud Director 1.5, the cell management tool is part of the product and does not need to be downloaded.

To gracefully shut down a cell in vCloud Director 1.5.x and 5.1.x:

  1. Log in to the target cell as root.
  2. Navigate to $VCLOUD_HOME/bin/ (typically /opt/vmware/vcloud-director/bin/).
  3. Suspend the scheduler by running this command:

    ./cell-management-tool -u username -p password cell -q true

  4. View the tasks that are running using this command:

    ./cell-management-tool -u username -p password cell -t

  5. When the task count reaches zero, shut down the cell by running this command:

    ./cell-management-tool -u username -p password cell -s

Tags

vcloud-director  vcloud-director-cell-management-tool

This Article Replaces

2034994

Update History

02/14/2012 - Added steps for vCD 1.5 02/01/2013 - Added vCD 5.1.x to Products

Attachments

Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.

Feedback

  • 8 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.
What can we do to improve this information? (4000 or fewer characters)
  • 8 Ratings
Actions
KB: