Substitution Variables
A stack file can contain substitution variables, such as the following:
casa
A stack file can contain substitution variables, such as the following:
<p>System Name: %SYSTEM_NAME%</p>
All substitution variable values can be set at the global level and some can be set at the tenant level. If a value is specified at the tenant level, the global value is ignored.
The substitution variables are associated one of the following email message categories:
- Reservation
- System
- Task
- Detailed message
- Miscellaneous
Reservation
The following variables are associated with reservation messages.
%IMAGENAMES% | Image names used for the reservation. (comma-separated string). |
%NUMSYSTEMS% | Number of systems reserved. |
%ORGUNIT% | Organizational unit of the requestor. |
%PROJECTID% | Project ID associated with the reservation. |
%READYSYSTEMLIST% | List of system names or IP addresses for reserved systems that are ready (HTML list). |
%READYSYSTEMTABLE% | Table of system names or IP addresses for reserved systems that are ready (HTML table). |
%REQUESTEDSOFTWARE% | List of requested software (HTML list). |
%RESERVATIONENDTIME% | Time when the reservation ends. |
%RESERVATIONID% | Reservation ID. |
%RESERVATIONNOTES% | Notes supplied for the reservation. |
%RESERVATIONREADYTEXT% | The user-supplied text to include with all reservation ready e-mails. |
%RESERVATIONSTARTTIME% | Time when the reservation starts. |
%TENANT% | The name of the tenant. |
%TENANTID% | An alternate tenant identification (short or abbreviated) |
%TEMPLATENAME% | The stack used for this reservation. |
%TICKETID% | The ticket ID associated with this reservation. |
%TICKETURL% | The ticket URL associated with this reservation. |
%USEREMAILADDRESS% | E-mail address of the requestor. |
%USERNAME% | The user name of the reservation requestor. |
%VCSERVERNAME% | Name of the VC Server that is hosting the reserved system. |
%VMNAMES% | List of reserved systems (HTML list). |
System
The following variables are associated with system messages.
%DATACENTER% | The name of the data center. |
%HOSTSYSTEM% | The name of the VM host system. |
%IMAGENAME% | The name of the system image used to create the VM. |
%IPADDRESSES% | A list of IP addresses associated with the system (comma-separated string). |
%RESOURCEPOOL% | The resource pool name. |
%SERVER% | The name of the server that is being reserved for a user. If a new VM is being created, this name is the same as the VM name. |
%SYSTEMPASSWORD% | The system password (only included if “ReservedSystemReadyNotificationContainsPassword” is true). |
%SYSTEMUPDATEDTIME% | The time that the status of the system was last updated. |
%SYSTEMUSERNAME% | User name associated with %SYSTEMPASSWORD% (only included if “ReservedSystemReadyNotificationContainsPassword” is true). |
%VMCONSOLEURL% | URL for the VM Console. |
%VMNAME% | The name of the virtual machine. |
Task
The following variables are associated with task messages.
%TASKID% | The task ID. |
%TASKDESCRIPTION% | The task description. |
%TASKTYPE% | The task type. |
%TASKTYPESHORT% | A shortened version of the task type. |
Detailed message
The following variable is associated with detailed messages.
%DETAILEDMESSAGE% | The detailed message. |
Miscellaneous
The following variables are associated only with an
Approval Required
message.%AUTOCANCEL% | If the reservation is not approved in time (true or false), this message indicates whether the reservation is canceled automatically. |
%AUTOCANCELMESSAGE% | If %AUTOCANCEL% is true, this message explains that the reservation is canceled automatically. Otherwise, no value. |
%APPROVALDEADLINE% | If %AUTOCANCEL% is true, this message shows the time at which the reservation is canceled if it has not been approved. |
The following variable is associated with any message.
%CURRENTTIME% | The current time. |