CCA Command Tool

The CCA Command tool, CcaCmd.exe, allows an administrator to configure the Deployment Agent from an endpoint giving an advanced level of control over the Deployment Agent and its behavior.

Administrators may use it to prepare a primary image for provisioning. The commands can be run individually or in a batch file as part of an existing provisioning script.

In this section:

Before Using the CCA Command Tool

Before you can use CcaCmd.exe the following conditions must be met:

  1. ClientCommunicationsAgent.msi installed on the endpoint.

  2. The following permissions must be enabled in Home > [Server] > Deployment Groups > [Deployment Group] > Settings > Deployment Agent Permissions:

    • Allow self-registration - maps to CCA Command tool switch /URL and /MOVE <GROUP NAME>
    • Allow unregistration - maps to CCA Command tool switch /UNREGISTER and /IMAGEPREP
    • Allow update initiation - maps to CCA Command tool switch /UPDATEAGENTS and /UPDATECONFIGS
  3. You must be a member of the local administrators group and running with an elevated token.

Using the CCA Command Tool

The CcaCmd.exe commands are as follows:

Command

Description

/showmessage off

Disables the "Applying installation manager policy" message at startup.

/showmessage default

Displays the default "Applying installation manager policy" message at startup. This is the default behavior.

/showmessage custom

Displays your customized startup message as defined by the /custommessage command.

/custommessage "Custom message here."

Defines a custom startup message. Use the /showmessage custom command to display your custom message at startup.

Messages with whitespace must be enclosed in quotes.

/url

 Changes the url used to communicate with the Management Server.
You can optionally include a Deployment Group with which to self register. This action requires Allow self-registration permission to be enabled for the Deployment Group.
See Deployment Agent Permissions.

/imageprep

 Prepares this computer for provisioning, the computer will be registered on the next poll. This command can be combined with the /unregister command.

When running /imageprep, the Deployment Agent will automatically Check for and download new Configurations at Startup regardless of the Deployment Group Settings.

/unregister

 Unregisters the Deployment Agent from the Management Server and stops the Deployment Agent service. Does not uninstall any User Workspace Manager agents or configurations. This requires Allow unregistration to be enabled in the Deployment Group Settings.

Once a computer has been unregistered the Deployment Agent Service must be restarted for the computer to re-register.

/updateagents

 Initiates install of agents assigned to the Deployment Group, overriding the Installation Schedule. This requires Allow update initiation to be enabled in the Deployment Group Settings.
A system restart is triggered if requested by the installer. The system restart can be suppressed by supplying the /suppressreboot option. The updating of agents is asynchronous. Use /isupdating to check if the Deployment Agent is still applying updates.

/updateconfigs

 Initiates install of configurations assigned to the Deployment Group, overriding the Installation Schedule. This requires Allow update initiation to be enabled in the Deployment Group Settings. The updating of configurations is asynchronous. Use /isupdating to check if the Deployment Agent is still applying updates.

/isupdating

 Determines whether a previous call to /updateagents or /updateconfigs is still processing updates.

/pollnow

Initiates a poll to the server.

/move <group_name>

Initiates the request to move the computer to the group specified.

Note, to move a computer, Allow self-registration permission must be enabled in both the current Deployment Group and the target Deployment Group. See Deployment Agent Permissions.

When you initiate a move request the Administration Command Prompt confirms when the operation is submitted. However, there is no reporting on the resulting move command. Unless required permissions are set within both Deployment Groups the command cannot be executed.

Related topics

Deployment Agent

Installing the Deployment Agent

Configuring the Deployment Agent