This topic provides a list of variables supported for naming. For general information on variables, see Add Data to Workflows With Variables.
If you need a variable that isn't documented, create a case through the Snow Support Portal, 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
| Variable | Expression | Description |
|---|---|---|
| Infrastructure | ||
| Cluster | target.cluster.name | The name of the cluster on which the VM is located. Not supported for public cloud instances. |
| Datacenter | target.datacenter.name | The 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. |
| Parent | target.parent.name | The name of the parent element in which the VM is located. For Azure Resource Manager, returns the resource group. |
| Region | target.region.name | The component's region. |
| Resource Group | target.resourceGroup.name | The name of the resource group in which the VM is located. Supported only for Azure Resource Manager. |
| Resource Pool | target.resourcePool.name | The name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager. |
| Virtual Network | target.virtualNetwork.name | The name of the virtual network in which the VM is located. Supported only for Microsoft Azure. |
| Operating System | ||
| Guest OS | target.guestOS | The guest operating system in a long format string. |
| Guest OS Family | target.osFamily | The type of operating system used by the VM. Values can be: Windows, Linux, Novell, Solaris, FreeBSD, or Other. |
| Organization Custom Attributes | ||
| Custom Attribute | request.organization.customAttribute['*'] | The value of the specified custom attribute for the organization. |
| Request | ||
| Date Submitted | request.requestDate | The date when the request was submitted. Value is a date string. |
| Fulfill Date | request.fulfillDate | The date when the request was fulfilled. Value is a date. |
| Requested Component | ||
| Dynamic List | target.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 Attribute | target.settings.customAttribute['*'] | The value of the specified custom attribute from the request. |
| Requested Service | ||
| Description | service.description | Description of the service in the service catalog. |
| Destination | service.settings.destination.name | The name of the requested destination. |
| Dynamic List | service.settings.dynamicList['*'] | Value of the specified dynamic list from the request. Replace * with the name of the dynamic list. |
| Input Field | service.settings.inputField['*'] | Value of the specified input text field from the request. Replace * with the name of the input text field. |
| Published Service Name | service.publishedName | The published name of the service in the service catalog. |
| Service Type | service.type | The type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service. |
| Requested Service Custom Attributes | ||
| Custom Attribute | service.settings.customAttribute['*'] | Value of the specified custom attribute from the request. |
| Requester | ||
| Organization Name | request.organization.name | The organization of the user performing the request. |
| Resources - Storage | ||
| Datastore | target.datastore.name | The datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account. |
| Target | ||
| Availability Set | target.availabilitySet.name | The availability set of the target. Supported only for Microsoft Azure. |
| Published Component Name | target.publishedName | The published name of the component in the service catalog. |
| Unique Number | ||
| Unique Number | uniqueNumber[*] | 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
| Variable | Expression | Description |
|---|---|---|
| Infrastructure | ||
| Cluster | target.cluster.name | The name of the cluster on which the VM is located. Not supported for public cloud instances. |
| Region | target.region.name | The component's region. |
| Resource Pool | target.resourcePool.name | The name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager. |
| Organization Custom Attributes | ||
| Custom Attribute | request.organization.customAttribute['*'] | The value of the specified custom attribute for the organization. |
| Request | ||
| Date Submitted | request.requestDate | The date when the request was submitted. Value is a date string. |
| Fulfill Date | request.fulfillDate | The date when the request was fulfilled. Value is a date. |
| Requested Service | ||
| Description | service.description | Description of the service in the service catalog. |
| Destination | service.settings.destination.name | The name of the requested destination. |
| Dynamic List | service.settings.dynamicList['*'] | Value of the specified dynamic list from the request. Replace * with the name of the dynamic list. |
| Input Field | service.settings.inputField['*'] | Value of the specified input text field from the request. Replace * with the name of the input text field. |
| Published Service Name | service.publishedName | The published name of the service in the service catalog. |
| Service Type | service.type | The type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service. |
| Requested Service Custom Attributes | ||
| Custom Attribute | service.settings.customAttribute['*'] | Value of the specified custom attribute from the request. |
| Requester | ||
| Organization Name | request.organization.name | The organization of the user performing the request. |
| Resources - Storage | ||
| Datastore | target.datastore.name | The datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account. |
| Unique Number | ||
| Unique Number | uniqueNumber[*] | 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
| Variable | Expression | Description |
|---|---|---|
| Infrastructure | ||
| Cluster | target.cluster.name | The name of the cluster on which the VM is located. Not supported for public cloud instances. |
| Datacenter | target.datacenter.name | The 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. |
| Parent | target.parent.name | The name of the parent element in which the VM is located. For Azure Resource Manager, returns the resource group. |
| Region | target.region.name | The component's region. |
| Resource Group | target.resourceGroup.name | The name of the resource group in which the VM is located. Supported only for Azure Resource Manager. |
| Resource Pool | target.resourcePool.name | The name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager. |
| Virtual Network | target.virtualNetwork.name | The name of the virtual network in which the VM is located. Supported only for Microsoft Azure. |
| Operating System | ||
| Guest OS | target.guestOS | The guest operating system in a long format string. |
| Guest OS Family | target.osFamily | The type of operating system used by the VM. Values can be: Windows, Linux, Novell, Solaris, FreeBSD, or Other. |
| Organization Custom Attributes | ||
| Custom Attribute | request.organization.customAttribute['*'] | The value of the specified custom attribute for the organization. |
| Request | ||
| Date Submitted | request.requestDate | The date when the request was submitted. Value is a date string. |
| Fulfill Date | request.fulfillDate | The date when the request was fulfilled. Value is a date. |
| Requested Component | ||
| Dynamic List | target.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 Attribute | target.settings.customAttribute['*'] | The value of the specified custom attribute from the request. |
| Requested Service | ||
| Description | service.description | Description of the service in the service catalog. |
| Destination | service.settings.destination.name | The name of the requested destination. |
| Dynamic List | service.settings.dynamicList['*'] | Value of the specified dynamic list from the request. Replace * with the name of the dynamic list. |
| Input Field | service.settings.inputField['*'] | Value of the specified input text field from the request. Replace * with the name of the input text field. |
| Published Service Name | service.publishedName | The published name of the service in the service catalog. |
| Service Type | service.type | The type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service. |
| Requested Service Custom Attributes | ||
| Custom Attribute | service.settings.customAttribute['*'] | Value of the specified custom attribute from the request. |
| Requester | ||
| Organization Name | request.organization.name | The organization of the user performing the request. |
| Resources - Storage | ||
| Datastore | target.datastore.name | The datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account. |
| Target | ||
| Availability Set | target.availabilitySet.name | The availability set of the target. Supported only for Microsoft Azure. |
| Published Component Name | target.publishedName | The published name of the component in the service catalog. |
| Unique Number | ||
| Unique Number | uniqueNumber[*] | 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
| Variable | Expression | Description |
|---|---|---|
| Infrastructure | ||
| Cluster | target.cluster.name | The name of the cluster on which the VM is located. Not supported for public cloud instances. |
| Region | target.region.name | The component's region. |
| Resource Pool | target.resourcePool.name | The name of the resource pool to which the VM is assigned. Not supported for AWS or Azure Resource Manager. |
| Organization Custom Attributes | ||
| Custom Attribute | request.organization.customAttribute['*'] | The value of the specified custom attribute for the organization. |
| Request | ||
| Date Submitted | request.requestDate | The date when the request was submitted. Value is a date string. |
| Fulfill Date | request.fulfillDate | The date when the request was fulfilled. Value is a date. |
| Requested Service | ||
| Description | service.description | Description of the service in the service catalog. |
| Destination | service.settings.destination.name | The name of the requested destination. |
| Dynamic List | service.settings.dynamicList['*'] | Value of the specified dynamic list from the request. Replace * with the name of the dynamic list. |
| Input Field | service.settings.inputField['*'] | Value of the specified input text field from the request. Replace * with the name of the input text field. |
| Published Service Name | service.publishedName | The published name of the service in the service catalog. |
| Service Type | service.type | The type of service: "SERVICE" for a regular service or "SHARED_IMAGE" for a shared service. |
| Requested Service Custom Attributes | ||
| Custom Attribute | service.settings.customAttribute['*'] | Value of the specified custom attribute from the request. |
| Requester | ||
| Organization Name | request.organization.name | The organization of the user performing the request. |
| Resources - Storage | ||
| Datastore | target.datastore.name | The datastore on which the VM is located. For Microsoft Azure, returns the name of the OS disk's storage account. |
| Unique Number | ||
| Unique Number | uniqueNumber[*] | 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. |