CADSMCMD Command Line Interface › cadsmcmd Commands › cancel—Canceling a Distribution

cancel—Canceling a Distribution

From an enterprise manager, use the cancel command to cancel an order previously sent to domains or domain groups. The order can be canceled only if it has not yet been started, or if it has completed successfully or failed.

From a domain manager, issue the cancel command against an existing job, independent of state. However, if an active job that has been started on any target computer is canceled, it is temporarily registered at the domain manager as a failed job on those target computers on which it was installed before cancellation. The actual job status for each of these computers will be registered on the domain manager, when the job has completed.

This command has the following format:

At the enterprise:

cancel item=item_name 

version=version_name 
procedure=procedure_name 
task={install | activate | configure | uninstall}
installedwith=procedure_name
{compgrp=computer_group_name}
{domain=domain_name | area=area_name } 
cname=[name]

At the domain:

cancel item=item_name 

version=version_name 
procedure=procedure_name 
task={install | activate | configure | uninstall}
installedwith=procedure_name
{compgrp=computer_group_name |
computer=computer_name }

area

Specifies the name of a Client Automation domain.

The parameter can be coded more than once to pass a list of Client Automation domains.

cname

Specifies the the optional unique name of a job container / distribution.

If a job container / distribution with the specified name already exists an error will be reported.
If "cname" is not coded, a generic name is generated.

compgrp

Specifies the name of a computer group to be addressed by the job. The parameter can be coded more than once to assign a list of computer groups.

computer

Specifies the name of the computer.

The parameter can be coded more than once to assign a list of computers.

domain

Specifies the name of a Client Automation domain group.

The parameter can be coded more than once to pass a list of Client Automation domain groups.

installedWith

Specifies the name of the install procedure referred to in the job being cancelled.

This parameter is required even if the procedure being canceled is that installation procedure. In this case, enter the install procedure again with installedWith

item

Specifies the name of the item that is subject to the job being cancelled.

procedure

Specifies the name of an item procedure that is subject to the job being cancelled.

task

Specifies the type of task to be performed by the item procedure.

install

installation procedure

activate

activation procedure

configure

configuration procedure

uninstall

uninstallation procedure

version

Specifies the version of the item that is subject to the job being cancelled.