The actions in this section | are executed |
environment/default/actions | on the local node for all types of environments. |
layers/default/actions | on the remote nodes for all layers, except for the layers that map to the local node. |
templates/default/actions | on the remote nodes for all templates, except for the templates applied on the local node. |
nodes/default/actions | on all nodes. If the action is executed for the local node, it is a local action. |
environments/environment.type/actions | on the local node, only for this environment type. |
layers/layerAlias /actions | when processing the layer with the specified alias. If the layer maps to the local node, the actions are executed as local actions. |
templates/templateAlias /actions | when processing the inline template with the specified alias. If the template is applied on the local node, the actions are executed as local actions. |
nodes/nodeAlias /actions | on the node with the specified alias. |
Parameter | Description |
actionName: | Required. The name of the action. If the action is executed on Windows, the name of the action ends with ".bat", for example: actionName.bat: |
description: | Optional. States the goal of the action. |
phase: {pre | post} | Optional. Specifies whether to execute the actions before or after the operation defined in the composite template section. For example, in the nodes/default/actions section, if phase=pre, the actions are executed before bootstrapping Platform Manager. If phase=post, the actions are executed after bootstrapping Platform Manager. The actions defined in the default sub-sections of top level sections are executed as follows: Default actions with the phase=pre parameters are executed before regular pre actions. Default actions with the phase=post parameters are executed after regular post actions. Default: phase: post |
failOnError: {true | false} | Indicates whether applying the composite template will fail if the action fails with an error. Valid values: true (default) - The composite template apply operation fails. false - The composite template apply operation ignores the error and continues processing the composite template. |
script: | Required when you do not specify the file property. Includes script commands, defined inline. When the shell scripts are included inline, the shell variables using the notation ${var} are evaluated against the properties defined in the composite template. The shell variables using the notation $var are not evaluated against the properties defined in the composite template and the script is executed as it stands. If you include both script and file properties, Command Central uses the script property and ignores the file property. |
file: | Required when you do not specify the script property. Specifies either the absolute, or the relative location path to an external script file. If you specify a relative location path to the composite template archive, the file is taken from the template archive. For example, file: scripts/main.sh |
target: POSIX | WINDOWS | Optional. Indicates on which operating systems to execute the action. Valid values: POSIX (default) - the action is executed on POSIX-compliant operating systems. WINDOWS - the action is executed only on Windows operating systems. This value is not supported for remote actions. |
namePrefix: hexTimestamp | none | Optional. Indicates whether Command Central adds a prefix to the names of action files created on the file system. Valid values: hexTimestamp (default) - the filename for an action is prefixed by a hexadecimal representation of the timestamp at the time of template evaluation. none - the filename for an action does not get a prefix. |
skipOnTemplateError: {true | false} | Optional. Indicates whether Command Central executes the action if applying the template fails with an ERROR status. Valid values: true - does not execute the action. false (default) - executes the action before stopping the template application. |
verbose | Optional. Indicates whether to include the standard output from the shell actions defined in the template in the Command Central logs. Valid values: true - include the standard output. false (default) - do not include the standard output. |