Referencing Parameters in Scripts

Blueprints are composed of Steps, and each Step has a unique name and a number of other attributes, including a Script, where the actual commands for executing the Step are written. In these commands, curly braces { } are used to delimit Values which are referenced by Parameters.

In order to be used in a Script the Parameters names are stripped of any separating spaces between words and converted to camelcase - with only the first letter of the second, and any subsequent words, capitalised.

So if a Parameter is named - This is my Name, it would be converted to: thisIsMyName.

Values are referenced in scripts as: {placeHolderName.placeValueAttribute}.

So for a Parameter with the name This is my Name of type Server, we can refer to the IP address in a script as: {thisIsMyName.ip}.

The expressions contained in the curly braces are evaluated prior to Job being Run, and the curly brace expressions are replaced by actual Values . In the example above {thisIsMyName.ip} would be substituted with the IP attribute of the Value that was assigned to the Parameter - THIS IS my name in the Plan.

This substitution of Values is performed by Attune, so using the curly Brace {} notation to reference attribute Values works with all Script regardless of the type of Script.

Value Attributes

This section details the Value attributes for each Parameter type.

OS Credential

Attributes of OS Credential Parameter type can be referenced as follows:

Value Attribute	Attribute Name	Script Reference
Name	name	{myPlaceHolder.name}
User	user	{myPlaceHolder.user}
Password	password	{myPlaceHolder.password}
Comment	comment	{myPlaceHolder.comment}

SQL Credential

Attributes of SQL credential Parameter type can be referenced as follows:

Value Attribute	Attribute Name	Script Reference
Name	name	{myPlaceHolder.name}
User	user	{myPlaceHolder.user}
SID	sid	{myPlaceHolder.sid}
Password	password	{myPlaceHolder.password}
As Sysdba	asSysDba	{myPlaceHolder.asSysDba}
Comment	comment	{myPlaceHolder.comment}

Node

Attributes of Node Parameter type are referenced as follows:

Value Attribute	Attribute Name	Script Reference
Name	name	{myPlaceHolder.name}
IP Address	ip	{myPlaceHolder.ip}
Hostname	hostname	{myPlaceHolder.hostname}
Domain Name	domain	{myPlaceHolder.domain}
Comment	comment	{myPlaceHolder.comment}

Node List

Node List is a comma separated list of node Parameters (CSV).

Attributes of Node List Parameter type are referenced as follows:

Value Attribute	Attribute Name	Script Reference
Name	name	{myPlaceHolder.name}
Server	serverNames	{myPlaceHolder.serverNames} as CSV
Server	serverIps	{myPlaceHolder.serverIps} as CSV
Server	serverHostnames	{myPlaceHolder.serverHostnames} as CSV
Server	serverTypes	{myPlaceHolder.serverTypes} as CSV The types are: 1 = Linux 2 = Windows
Server	serverDomains	{myPlaceHolder.serverDomains} as CSV
Server	serverFqns	{myPlaceHolder.serverFqns} as CSV
Comment	comment	{myPlaceHolder.comment}

IPv4 Subnet

Attributes of IPv4 Subnet Parameter type are referenced as follows:

Value Attribute	Attribute Name	Script Reference
Name	name	{myPlaceHolder.name}
Subnet	subnet	{myPlaceHolder.subnet}
Netmask	netmask	{myPlaceHolder.netmask}
Gateway IP	gateway	{myPlaceHolder.gateway}
DNS IP 1	dns1	{myPlaceHolder.dns1}
DNS IP 2	dns2	{myPlaceHolder.dns2}
Comment	comment	{myPlaceHolder.comment}

Text

Attributes of Text Parameter type are referenced as follows:

Value Attribute	Attribute Name	Script Reference
Name	name	{myPlaceHolder.name}
Value	value	{myPlaceHolder} Please note the text value is referenced without the attribute.
Comment	comment	{myPlaceHolder.comment}