Shared Steps

This section lists steps that may be used in either a component or a simple plan. These steps include:

• <call> (described in call Step)

• <checkDependency> (described in CheckDependency Step)

• <execJava> described in execJava Step

• <execNative> (described in execNative Step)

• <if> described in if Step)

• <pause> (described in pause Step)

• <processTest> (described in processTest Step)

• <raise> (described in raise Step)

• <reboot> )(described in reboot Step)

• <retarget> (described in retarget Step)

• <sendCustomEvent> (described The sendCustomEvent Step)

• <transform> (described in transform Step)

• <try> (described in try Step)

• <urlTest> (described in urlTest Step)

In the following tables, the “Config” column indicates whether or not a specific attribute may include substitution variable references in the form “:[varName]”.

call Step

You can use the <call> step to execute a control block associated with a component installed on the target host.

call Step attributes

call Step child elements

The argList Child Element

The <argList> element is a child of the <call>, <install>, <uninstall>, <execSubplan>, and <addSnapshot> steps. It specifies a list of variables to be passed as arguments to the called service. The called service declares the variables that it expects using a <paramList> element. The variables within the <argList> and the called <paramList> need not be the same. However, for any variable in the called <paramList> that does not have a default value, there must be a variable with the same name in the <argList>, or a preflight error is raised at plan runtime. For each variable in the called <paramList> for which there is a corresponding variable in the <argList>, the value of the variable in <paramList> will obtain the value of corresponding variable in <argList> for the duration of the execution of the called service.

Variables in <argList> that do not correspond to a variable in the called <paramList> will be silently ignored. This permits services to be redefined with additional parameters, while still allowing for backward compatibility such that one plan can call both old and new versions of the service.

The arguments of the <argList> element are expressed as attributes. For example, the following <argList> declares two arguments, “password” and “path”:

<argList password=”:[password]”
path=”/tmp”/> 

Order is not important.

argList Child Element attributes

The <argList> element must have at least one attribute. Each attribute is treated as a named variable to be passed to the called service. The name of each attribute must be an identifier without substitution variable references, and should correspond to the name of a parameter in the called service. The value of each attribute is an arbitrary string which may include references to variables in the enclosing scope, but not other arguments within the <argList>.