Retiring a Client Using Command Line Interface

You can retire a client by using an XML file.

Caution

Retiring a client that has no associated backup data removes the client and all of its data from the Commvault system. After you retire a client, you cannot undo the retirement. To add the client to the Commvault system again, you must add it as a new client.

Procedure

  1. To log on to the CommServe computer, run the qlogin command.

  2. Download the retire_client_template.xml file to the computer where you will run the command.

  3. From software_installation_directory/Base type the following command:

    qoperation execute -af xml_path\retire_client_template.xml -client/clientName "client_name"

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the example above) does not need to be included on the command line.

  4. To log off the CommServe computer, run the qlogout command.

Example

To retire a client with the name client123, use the following XML:

<App_RetireClientRequest> <client> <clientName>client123</clientName> </client>
</App_RetireClientRequest>

Results

  • If the client has backup data associated with it, then it is left in the deconfigured state.

  • If the client has no backup data associated with it, then it is deleted from the Commvault system, and the client does not appear in the CommCell environment. As a result, associated schedules are automatically removed.

×

Loading...