Naming Variables

This topic provides a list of variables supported for naming. For general information on variables, see Adding Commander Metadata to Workflows With Variables.

If you need a variable that isn't documented, contact support@snowsoftware.com, and if the variable is available, we'll provide you with the variable name. We'll also add it to the list of documented variables in the next release.

Global VM Naming Convention

VariableExpressionDescription
Infrastructure
Clustertarget.cluster.nameThe name of the cluster on which the VM is located. Not supported for public cloud instances.
Datacentertarget.datacenter.nameThe name of the datacenter in which the VM is stored. AWS availability zones are represented as datacenters in Commander. Not supported for Azure Resource Manager.
Parenttarget.parent.nameThe name of the parent element in which the VM is located. For Azure Resource Manager, returns the resource group.
Regiontarget.region.nameThe component's region.
Resource Grouptarget.resourceGroup.nameThe name of the resource group in which the VM is located. Supported only for Azure Resource Manager.
Resource Pooltarget.resourcePool.nameThe name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager.
Virtual Networktarget.virtualNetwork.nameThe name of the virtual network in which the VM is located. Supported only for Microsoft Azure.
Operating System
Guest OStarget.guestOSThe guest operating system in a long format string.
Guest OS Familytarget.osFamilyThe type of operating system used by the VM. Values can be: Windows, Linux, Novell, Solaris, FreeBSD, or Other.
Request
Date Submittedrequest.requestDateThe date when the request was submitted. Value is a date string.
Fulfill Daterequest.fulfillDateThe date when the request was fulfilled. Value is a date.
Requested Component
Dynamic Listtarget.settings.dynamicList['*']The value of the specified dynamic list from the request. Replace * with the name of the dynamic list.
Requested Component Custom Attributes
Custom Attributetarget.settings.customAttribute['*']The value of the specified custom attribute from the request. Replace * with the name of the custom attribute.
Requested Service
Descriptionservice.descriptionDescription of the service in the service catalog.
Destinationservice.settings.destination.nameThe name of the requested destination.
Dynamic Listservice.settings.dynamicList['*']Value of the specified dynamic list from the request. Replace * with the name of the dynamic list.
Input Fieldservice.settings.inputField['*']Value of the specified input text field from the request. Replace * with the name of the input text field.
Published Service Nameservice.publishedNameThe published name of the service in the service catalog.
Service Typeservice.typeThe type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service.
Requested Service Custom Attributes
Custom Attributeservice.settings.customAttribute['*']Value of the specified custom attribute from the request. Replace * with the name of the custom attribute.
Requester
Organization Namerequest.organization.nameThe organization of the user requesting the VM.
Resources - Storage
Datastoretarget.datastore.nameThe datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account.
Target
Availability Settarget.availabilitySet.nameThe availability set of the target. Supported only for Microsoft Azure.
Published Component Nametarget.publishedNameThe published name of the component in the service catalog.
Unique Number
Unique NumberuniqueNumber[*]A number that allows the name to be unique on the target destination. Replace * with the number of digits to use. For example, #{uniqueNumber[3]} returns a three-digit unique number.

Global Virtual Service Naming Convention

VariableExpressionDescription
Infrastructure
Clustertarget.cluster.nameThe name of the cluster on which the VM is located. Not supported for public cloud instances.
Regiontarget.region.nameThe component's region.
Resource Pooltarget.resourcePool.nameThe name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager.
Request
Date Submittedrequest.requestDateThe date when the request was submitted. Value is a date string.
Fulfill Daterequest.fulfillDateThe date when the request was fulfilled. Value is a date.
Requested Service
Descriptionservice.descriptionDescription of the service in the service catalog.
Destinationservice.settings.destination.nameThe name of the requested destination.
Dynamic Listservice.settings.dynamicList['*']Value of the specified dynamic list from the request. Replace * with the name of the dynamic list.
Input Fieldservice.settings.inputField['*']Value of the specified input text field from the request. Replace * with the name of the input text field.
Published Service Nameservice.publishedNameThe published name of the service in the service catalog.
Service Typeservice.typeThe type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service.
Requested Service Custom Attributes
Custom Attributeservice.settings.customAttribute['*']Value of the specified custom attribute from the request. Replace * with the name of the custom attribute.
Requester
Organization Namerequest.organization.nameThe organization of the user requesting the VM.
Resources - Storage
Datastoretarget.datastore.nameThe datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account.
Unique Number
Unique NumberuniqueNumber[*]A number that allows the name to be unique on the target destination. Replace * with the number of digits to use. For example, #{uniqueNumber[3]} returns a three-digit unique number.

Naming Convention for Deployed Components in the Service Catalog

VariableExpressionDescription
Infrastructure
Clustertarget.cluster.nameThe name of the cluster on which the VM is located. Not supported for public cloud instances.
Datacentertarget.datacenter.nameThe name of the datacenter in which the VM is stored. AWS availability zones are represented as datacenters in Commander. Not supported for Azure Resource Manager.
Parenttarget.parent.nameThe name of the parent element in which the VM is located. For Azure Resource Manager, returns the resource group.
Regiontarget.region.nameThe component's region.
Resource Grouptarget.resourceGroup.nameThe name of the resource group in which the VM is located. Supported only for Azure Resource Manager.
Resource Pooltarget.resourcePool.nameThe name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager.
Virtual Networktarget.virtualNetwork.nameThe name of the virtual network in which the VM is located. Supported only for Microsoft Azure.
Operating System
Guest OStarget.guestOSThe guest operating system in a long format string.
Guest OS Familytarget.osFamilyThe type of operating system used by the VM. Values can be: Windows, Linux, Novell, Solaris, FreeBSD, or Other.
Request
Date Submittedrequest.requestDateThe date when the request was submitted. Value is a date string.
Fulfill Daterequest.fulfillDateThe date when the request was fulfilled. Value is a date.
Requested Component
Dynamic Listtarget.settings.dynamicList['*']The value of the specified dynamic list from the request. Replace * with the name of the dynamic list.
Requested Component Custom Attributes
Custom Attributetarget.settings.customAttribute['*']The value of the specified custom attribute from the request. Replace * with the name of the custom attribute.
Requested Service
Descriptionservice.descriptionDescription of the service in the service catalog.
Destinationservice.settings.destination.nameThe name of the requested destination.
Dynamic Listservice.settings.dynamicList['*']Value of the specified dynamic list from the request. Replace * with the name of the dynamic list.
Input Fieldservice.settings.inputField['*']Value of the specified input text field from the request. Replace * with the name of the input text field.
Published Service Nameservice.publishedNameThe published name of the service in the service catalog.
Service Typeservice.typeThe type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service.
Requested Service Custom Attributes
Custom Attributeservice.settings.customAttribute['*']Value of the specified custom attribute from the request. Replace * with the name of the custom attribute.
Requester
Organization Namerequest.organization.nameThe organization of the user requesting the VM.
Resources - Storage
Datastoretarget.datastore.nameThe datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account.
Target
Availability Settarget.availabilitySet.nameThe availability set of the target. Supported only for Microsoft Azure.
Published Component Nametarget.publishedNameThe published name of the component in the service catalog.
Unique Number
Unique NumberuniqueNumber[*]A number that allows the name to be unique on the target destination. Replace * with the number of digits to use. For example, #{uniqueNumber[3]} returns a three-digit unique number.

Naming Convention for Deployed Services in the Service Catalog

VariableExpressionDescription
Infrastructure
Clustertarget.cluster.nameThe name of the cluster on which the VM is located. Not supported for public cloud instances.
Regiontarget.region.nameThe component's region.
Resource Pooltarget.resourcePool.nameThe name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager.
Request
Date Submittedrequest.requestDateThe date when the request was submitted. Value is a date string.
Fulfill Daterequest.fulfillDateThe date when the request was fulfilled. Value is a date.
Requested Service
Descriptionservice.descriptionDescription of the service in the service catalog.
Destinationservice.settings.destination.nameThe name of the requested destination.
Dynamic Listservice.settings.dynamicList['*']Value of the specified dynamic list from the request. Replace * with the name of the dynamic list.
Input Fieldservice.settings.inputField['*']Value of the specified input text field from the request. Replace * with the name of the input text field.
Published Service Nameservice.publishedNameThe published name of the service in the service catalog.
Service Typeservice.typeThe type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service.
Requested Service Custom Attributes
Custom Attributeservice.settings.customAttribute['*']Value of the specified custom attribute from the request. Replace * with the name of the custom attribute.
Requester
Organization Namerequest.organization.nameThe organization of the user requesting the VM.
Resources - Storage
Datastoretarget.datastore.nameThe datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account.
Unique Number
Unique NumberuniqueNumber[*]A number that allows the name to be unique on the target destination. Replace * with the number of digits to use. For example, #{uniqueNumber[3]} returns a three-digit unique number.