Command Plugin Reference 7.5.x

The XL Deploy Command plugin allows you to execute scripts on remote systems, without requiring you to manually log on to each system, copy required resources, and execute the scripts or commands.

This document provides information that is specific to this version of the Command plugin. For general information about the plugin, refer to Introduction to the XL Deploy Command plugin.

Using the deployables and deployeds

Deployable vs. container Table

The following table describes which deployable/container combinations are possible.

Deployables Containers Generated Deployed
cmd.Command overthere.Host cmd.DeployedCommand

Note: Command plugin configuration items (CIs) can only be targeted to containers that are derived from the overthere.Host CI.

Deployed actions table

The following table describes the effect a deployed has on its container.

DeployedCreate Destroy Modify
cmd.DeployedCommand
  • Upload command resources to host
  • Resolve command line placeholder references with absolute paths to the uploaded resource files on host
  • Execute command line on host
  • Run the undo command associated with the deployed command, if exists. Actions are same as described for Create
  • Run the undo command associated with the deployed command, if exists. Actions are same as described for Create
  • Run the modified command. Actions are same as described for Create

CI Reference

Configuration Item Overview

Deployables

CIDescription
cmd.Command Command specification that is executed on a host

Deployeds

CIDescription
cmd.DeployedCommand Command deployed to a Host

Configuration Item Details

cmd.Command

Type Hierarchy udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Command specification that is executed on a host

  Public properties
 
 
order: INTEGER = 50
Order of the command
 
 
undoOrder: INTEGER = 49
Order of the undo command
 
 
commandLine: STRING
Command line to execute on host. Dependent artifacts can be referred to using ${artifact name}.
 
 
dependencies: SET_OF_CI<file.File>
Artifacts that the command depends on
 
 
runUndoCommandOnUpgrade: BOOLEAN = true
Indicates whether the undoCommand should be run on an upgrade
 
 
tags: SET_OF_STRING
If set, this deployable will only be mapped automatically to containers with the same tag.
 
 
undoCommand: CI<cmd.Command>
(Deprecated)Command to execute when undeploying command
 
 
undoCommandLine: STRING
Undo command line to execute on host. Dependent artifacts can be referred to using ${artifact name}.
 
 
undoDependencies: SET_OF_CI<file.File>
Artifacts that the undo command depends on

cmd.DeployedCommand

Type Hierarchy udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

Command deployed to a Host

  Parent
 
 
container: CI<udm.Container>
The container on which this deployed runs.
  Public properties
 
 
commandLine: STRING
Command line to execute on host. Dependent artifacts can be referred to using ${artifact name}.
 
 
order: INTEGER = 50
Order of the command
 
 
undoOrder: INTEGER = 49
Order of the undo command
 
 
dependencies: SET_OF_CI<file.File>
Artifacts that the command depends on
 
 
deployable: CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
rerunCommand: BOOLEAN
Forces the command to be rerun.
 
 
runUndoCommandOnUpgrade: BOOLEAN = true
Indicates whether the undoCommand should be run on an upgrade
 
 
undoCommand: CI<cmd.Command>
Command to execute when undeploying command
 
 
undoCommandLine: STRING
Undo command line to execute on host. Dependent artifacts can be referred to using ${artifact name}.
 
 
undoDependencies: SET_OF_CI<file.File>
Artifacts that the undo command depends on