Job - executeAgainstComponentGroups
Job - executeAgainstComponentGroups
Description :
This command executes a job against one or more component groups. This command returns a schedule ID, which indicates when the job is scheduled to run.
The argument jobKey is the handle to the job you want to execute. To find the jobKey for a specific job type, use the SnapshotJob getDBKeyByGroupAndName command. Use the groupsName argument to provide one or more fully qualified paths to the target component group(s) (for example, /WestCoast/Windows). Separate groups with commas.
Note: To use this command on an Advanced Deploy Job, the Reset job on failure option must be selected for the job, so that failed job runs are automatically reset. In addition, the last job run must not be in incomplete state. If necessary, you can manually reset the job.
Return type : Integer
Command Input :
Variable Name | Variable Type | Description |
|---|---|---|
jobKey | DBKey | Handle of the job to execute. |
groupsName | StringList | Full path(s) and name(s) of the component group(s). |
Example
The following example executes a job against the component groups compGroup1 and compGroup2.
Script
blcli Job executeAgainstComponentGroups $JOB_KEY /Components/compGroup1,/Components/compGroup2