This topic provides a list of variables supported in command workflows. 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.
Command Workflows for All Target Types
| Variable | Expression | Description |
|---|---|---|
| Auto Scaling Group | ||
| Auto Scaling Group Desired Capacity | target.desiredCapacity | Desired number of instances for this auto scaling group. |
| Auto Scaling Group Launch Configuration Name | target.launchConfigurationName | The launch configuration used to launch the instances in the auto scaling group. |
| Auto Scaling Group Maximum Size | target.maxSize | The maximum number of instances that should be running in this auto scaling group. |
| Auto Scaling Group Minimum Size | target.minSize | The minimum number of instances that should be running in this auto scaling group. |
| Auto Scaling Group Virtual Cloud | target.virtualCloud.name | The auto scaling group virtual cloud. |
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Configuration | ||
| Connection State | target.connectionState | Indicates whether a VM is connected to the cloud account. Values can be: Connected, Disconnected, Inaccessible, Invalid, Orphaned, or Unknown. |
| Hardware Version | target.hardwareVersion | The VM's hardware version (ESX 4.0 and later). Returns Unknown for SCVMM. Not supported for public cloud instances. |
| Image ID | target.imageId | The VM's image ID. |
| Database | ||
| Allocated Storage | target.allocatedStorage.gb | The allocated storage size of the database, in gigabytes. |
| Database Name | target.dbName | For MySQL, SQL Server and PostgreSQL: The name of this instance's initial database provided at creation time, if a name was specified when the DB instance was created. This same name is returned for the life of the DB instance. For Oracle: The Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance. |
| End point | target.port | The database's endpoint. |
| Engine Type | target.engineType | The database type, for example, mysql or postgres. |
| Engine Version | target.engineVersion | The database version, for example, 5.6.22 or 9.3.6 |
| Instance Status | target.instanceStatus | The status of the database (for example, available, running, rebooting, deleting). |
| IOPS | target.iops | The number of I/O operations per second (IOPS) that the database should provision. |
| Guest Tools | ||
| Running Status | target.tools.runningStatus | The operating status of VMware Tools. Values can be: Starting, Not Running, Running, or Unknown. |
| Version | target.tools.version | The version of VMware Tools. |
| Version Status | target.tools.versionStatus | The version status of VMware Tools. Values can be: Unknown, Current, Not Installed, Out Of Date, Third Party, Error, Unsupported New Version, or Unsupported. |
| Infrastructure | ||
| Cloud Account Address | target.cloudAccount.address | The address of the cloud account that the VM is running on. For AWS, this is the account number of the instance owner (the Owner property in AWS). For Microsoft Azure, this is the subscription ID. |
| Cloud Account Name | target.cloudAccount.name | The name of the cloud account. |
| Cloud Account Tenant ID | target.cloudAccount.tenantId | The Microsoft Azure tenant ID of the cloud account that the VM is running on. |
| Cloud Account Type | target.cloudAccount.type | The cloud account type. Values can be vc (for VMware), ms_scvmm, amazon_aws, googlecloud, ms_arm (for Azure Resource Manager), or k8s (for Kubernetes). |
| 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. |
| Host | target.host.name | The VM's host name. Not supported for public cloud instances. |
| Managed By | target.managedBy | The remote id of the resource responsible for managing the current instance. The instance could be a host object or a VM. |
| 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. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Instance Type | ||
| ECUs | target.instanceType.ecu | The number of EC2 Compute Units associated with the instance type. For custom cost calculations, this variable is supported for deployed services only (not for requests). Supported for Amazon EC2 only. |
| Memory | target.instanceType.memory.gb | The amount of memory associated with the instance type, in gigabytes. |
| Remote ID | target.instanceType.remoteId | The instance type ID (for example, t1.micro, m3.2xlarge). |
| Storage | target.instanceType.storage.gb | The amount of storage assigned to the instance type, in gigabytes. |
| vCPUs | target.instanceType.vcpu | The number of vCPUs assigned to the instance type. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Licensing | ||
| Azure Hybrid Benefit | target.azureHybridBenefit | The Azure Hybrid Benefit for the Azure instance. This could be for the VM or database. |
| Image Source | target.licensing.imageSource | The VM's image source. |
| Tenancy | target.licensing.tenancy | The VM's AWS tenancy. |
| Load balancer | ||
| Healthy Instance Health | target.healthyInstanceCount | The number of healthy instances associated with this load balancer. |
| Load Balancer Type | target.loadBalancerType | The type of Elastic Load Balancer. The values can be: classic, application, or network. |
| Scheme | target.scheme | For load balancers attached to Amazon VPCs, this indicates whether the load balancer is internal or internet-facing. Values can be: internal (a load balancer with a DNS name that resolves to private IP addresses) or internet-facing (a load balancer with a publicly resolvable DNS name, which resolves to public IP addresses). |
| Unhealthy Instance Health | target.unhealthyInstanceCount | The number of unhealthy instances associated with this load balancer. |
| Unknown Instance Health | target.unknownInstanceCount | The number of instances associated with this load balancer whose health is unknown. |
| 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. |
| Resources - CPU | ||
| CPU Limit | target.cpuLimit.ghz | The maximum CPU allocation for the VM. Each unit represents a GHz. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| CPU Reservation | target.cpuReservation.ghz | The guaranteed CPU allocation for the VM, in GHz. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| CPU Shares | target.cpuShares | The CPU shares for a VM as part of a parent's total. Sibling virtual machines share resources according to their relative share values bounded by the reservation and limit. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| Number Of Cores | target.numCores | The total number of cores of the deployed target. |
| Total CPUs | target.cpuCount | The total number of CPUs of the deployed target. |
| Resources - Memory | ||
| Memory Limit | target.memLimit.gb | The maximum amount of the host's memory that the VM can use, in gigabytes. Can be -1 for unlimited. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| Memory Reservation | target.memReservation.gb | The amount of memory reserved for the VM, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| Memory Shares | target.memShares | A relative metric for allocating memory capacity (Low, Normal, High and Custom) ? compared to the sum of all shares of all virtual machines on the server and, if applicable, the server console. Not supported for public cloud instances. |
| Total Memory | target.memory.gb | The total amount of memory of the deployed target, in gigabytes. |
| Resources - Network | ||
| IP Address | target.ipAddress | The VM's IP address. For public cloud instances, this is the public IP address. |
| IPv4 Addresses | target.ipv4Addresses | A list of the VM's IPv4 addresses. Not supported for public cloud instances. |
| IPv6 Addresses | target.ipv6Addresses | A list of the VM's IPv6 addresses. Not supported for public cloud instances. |
| MAC Address | target.macAddresses | The unique address assigned to a virtual network adapter. Not supported for public cloud instances. |
| Network | target.networks | The VM's network. Not supported for public cloud instances. |
| NIC Count | target.nicCount | The number of Ethernet adapters for the VM. Not supported for public cloud instances. |
| Private IP Address | target.ipAddressPrivate | The private IP address for fenced VMs or the private IP address for public cloud VMs. |
| Resources - Storage | ||
| Committed Storage Space | target.storage.spaceCommitted.gb | The space occupied by all VMDK files + Other Files in the VM's directory (even if they are unrelated to the VM), in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Consumed Storage Space | target.storage.spaceConsumed.gb | The sum of all VM hard drives configured in vCenter (that is, all VMDK files) as reported by vCenter, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Container Storage Used | target.containerSpaceUsed.gb | The sum of all physical disks as reported by the guest OS, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| 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. |
| Disk Count | target.storage.diskCount | The total number of disks on the VM (including hard disks, CD-ROMs, etc.). |
| Provisioned Storage | target.provisionedStorage.gb | The maximum storage available to the VM regardless of whether the storage is actually used by the VM, in gigabytes. Can be a value of 0 if data is unavailable. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Scanned Storage Space | target.storage.spaceScanned.gb | The size of the VMDK file + log file + snapshots + swap files + all other VM files in folder, in gigabytes. Supported for pre-vCenter 4.0 systems. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Storage Free Space | target.storage.spaceFree.gb | The amount of unused space on all logical disks as reported by the guest OS, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). For public cloud VMs, returns Unknown. |
| Storage Free Space Percentage | target.storage.spaceFreePercent | The amount of free disk space as a percentage of the total space, as reported by the guest OS. For custom cost calculations, this variable is supported for deployed services only (not for requests). For public cloud VMs, returns Unknown. |
| Storage Logical Size | target.storage.logicalSize.gb | The sum of all logical disks partitioned on the physical disks as reported by the guest OS, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). For public cloud VMs, returns Unknown. |
| Total Storage | target.storage.gb | The total of all storage of the deployed target, in gigabytes. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Unallocated Storage Space | target.storage.spaceUnallocated.gb | The virtual disk size minus the physical disk size, in gigabytes. Only returns a value during the time interval between adding a new disk to a VM in vCenter and running the next Commander datastore scan. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Unpartitioned Storage Space | target.storage.spaceUnpartitioned.gb | The physical disk size minus the logical disk size, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Availability Set | target.availabilitySet.name | The availability set of the target. Supported only for Microsoft Azure. |
| Chef Node | target.chefNode | True if this VM is managed by Chef. |
| Chef Node Name | target.chefNodeName | The name of the Chef node associated with this VM. |
| Context | target.context | A JSON string containing information that can be used to look up the target on the cloud account, such as ID and resource type. |
| Deployed Name | target.deployedName | The deployed name of the component. |
| DNS name | target.dnsName | The DNS name of the VM. For AWS VMs, which have both a private and a public DNS name, this is the public DNS name. |
| Expiry Date | target.expiryDate | The date set for the VM to expire. Values can be: Date, No Expiry Date Set, or Never Expires. |
| Management Server Type | target.mediatorType | The management server type. Values can be: Unknown, Vim2, Vim2.5, Vim4, Vim4.1, Vim5, Vim5.1, VIM55, MS SCVMM, Amazon Web Services, Microsoft Azure, or Kubernetes. |
| Number of VMs | target.vmCount | The number of VMs in the virtual service. |
| Organization ID | target.organization.id | The unique identifier of target VM's organization. |
| Power State | target.state | The power state of the VM. Values can be: Creating, Failed, Not running, Running, Saved, Starting, Stopping, Suspended, Suspending, or Unknown. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Puppet Node | target.puppetNode | True if this VM is managed by Puppet. |
| Puppet Node Name | target.puppetNodeName | The name of the Puppet node associated with this VM. |
| Remote ID | target.remoteId | An identifier for the VM/component in the cloud account. Do not use for customized VM naming. |
| Replication Error | target.replicationError | For read replicas, displays errors that occurred during replication, if any. |
| Replication State | target.replicationState | For read replicas, the state of the read replica (for example, replicating, replicated). |
| Target ID | target.id | The unique identifier of the target VM. |
| Type | target.type | The component type. Values can be: VM, Virtual Service, or Unmanaged Object. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
Command Workflows for All Target Types: Address List Field Only
| Variable | Expression | Description |
|---|---|---|
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
Command Workflows with No Inventory Targets
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
VM Command Workflows
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Configuration | ||
| Connection State | target.connectionState | Indicates whether a VM is connected to the cloud account. Values can be: Connected, Disconnected, Inaccessible, Invalid, Orphaned, or Unknown. |
| Hardware Version | target.hardwareVersion | The VM's hardware version (ESX 4.0 and later). Returns Unknown for SCVMM. Not supported for public cloud instances. |
| Image ID | target.imageId | The VM's image ID. |
| Guest Tools | ||
| Running Status | target.tools.runningStatus | The operating status of VMware Tools. Values can be: Starting, Not Running, Running, or Unknown. |
| Version | target.tools.version | The version of VMware Tools. |
| Version Status | target.tools.versionStatus | The version status of VMware Tools. Values can be: Unknown, Current, Not Installed, Out Of Date, Third Party, Error, Unsupported New Version, or Unsupported. |
| Infrastructure | ||
| Cloud Account Address | target.cloudAccount.address | The address of the cloud account that the VM is running on. For AWS, this is the account number of the instance owner (the Owner property in AWS). For Microsoft Azure, this is the subscription ID. |
| Cloud Account Name | target.cloudAccount.name | The name of the cloud account. |
| Cloud Account Tenant ID | target.cloudAccount.tenantId | The Microsoft Azure tenant ID of the cloud account that the VM is running on. |
| Cloud Account Type | target.cloudAccount.type | The cloud account type. Values can be vc (for VMware), ms_scvmm, amazon_aws, googlecloud, ms_arm (for Azure Resource Manager), or k8s (for Kubernetes). |
| 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. |
| Host | target.host.name | The VM's host name. Not supported for public cloud instances. |
| 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. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Instance Type | ||
| ECUs | target.instanceType.ecu | The number of EC2 Compute Units associated with the instance type. For custom cost calculations, this variable is supported for deployed services only (not for requests). Supported for Amazon EC2 only. |
| Memory | target.instanceType.memory.gb | The amount of memory associated with the instance type, in gigabytes. |
| Remote ID | target.instanceType.remoteId | The instance type ID (for example, t1.micro, m3.2xlarge). |
| Storage | target.instanceType.storage.gb | The amount of storage assigned to the instance type, in gigabytes. |
| vCPUs | target.instanceType.vcpu | The number of vCPUs assigned to the instance type. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Licensing | ||
| Azure Hybrid Benefit | target.azureHybridBenefit | The Azure Hybrid Benefit for the Azure instance. This could be for the VM or database. |
| Image Source | target.licensing.imageSource | The VM's image source. |
| Tenancy | target.licensing.tenancy | The VM's AWS tenancy. |
| 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. |
| Resources - CPU | ||
| CPU Limit | target.cpuLimit.ghz | The maximum CPU allocation for the VM. Each unit represents a GHz. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| CPU Reservation | target.cpuReservation.ghz | The guaranteed CPU allocation for the VM, in GHz. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| CPU Shares | target.cpuShares | The CPU shares for a VM as part of a parent's total. Sibling virtual machines share resources according to their relative share values bounded by the reservation and limit. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| Number Of Cores | target.numCores | The total number of cores of the deployed target. |
| Total CPUs | target.cpuCount | The total number of CPUs of the deployed target. |
| Resources - Memory | ||
| Memory Limit | target.memLimit.gb | The maximum amount of the host's memory that the VM can use, in gigabytes. Can be -1 for unlimited. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| Memory Reservation | target.memReservation.gb | The amount of memory reserved for the VM, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). Not supported for public cloud instances. |
| Memory Shares | target.memShares | A relative metric for allocating memory capacity (Low, Normal, High and Custom) ? compared to the sum of all shares of all virtual machines on the server and, if applicable, the server console. Not supported for public cloud instances. |
| Total Memory | target.memory.gb | The total amount of memory of the deployed target, in gigabytes. |
| Resources - Network | ||
| IP Address | target.ipAddress | The VM's IP address. For public cloud instances, this is the public IP address. |
| IPv4 Addresses | target.ipv4Addresses | A list of the VM's IPv4 addresses. Not supported for public cloud instances. |
| IPv6 Addresses | target.ipv6Addresses | A list of the VM's IPv6 addresses. Not supported for public cloud instances. |
| MAC Address | target.macAddresses | The unique address assigned to a virtual network adapter. Not supported for public cloud instances. |
| Network | target.networks | The VM's network. Not supported for public cloud instances. |
| NIC Count | target.nicCount | The number of Ethernet adapters for the VM. Not supported for public cloud instances. |
| Private IP Address | target.ipAddressPrivate | The private IP address for fenced VMs or the private IP address for public cloud VMs. |
| Resources - Storage | ||
| Committed Storage Space | target.storage.spaceCommitted.gb | The space occupied by all VMDK files + Other Files in the VM's directory (even if they are unrelated to the VM), in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Consumed Storage Space | target.storage.spaceConsumed.gb | The sum of all VM hard drives configured in vCenter (that is, all VMDK files) as reported by vCenter, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Container Storage Used | target.containerSpaceUsed.gb | The sum of all physical disks as reported by the guest OS, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| 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. |
| Disk Count | target.storage.diskCount | The total number of disks on the VM (including hard disks, CD-ROMs, etc.). |
| Provisioned Storage | target.provisionedStorage.gb | The maximum storage available to the VM regardless of whether the storage is actually used by the VM, in gigabytes. Can be a value of 0 if data is unavailable. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Scanned Storage Space | target.storage.spaceScanned.gb | The size of the VMDK file + log file + snapshots + swap files + all other VM files in folder, in gigabytes. Supported for pre-vCenter 4.0 systems. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Storage Free Space | target.storage.spaceFree.gb | The amount of unused space on all logical disks as reported by the guest OS, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). For public cloud VMs, returns Unknown. |
| Storage Free Space Percentage | target.storage.spaceFreePercent | The amount of free disk space as a percentage of the total space, as reported by the guest OS. For custom cost calculations, this variable is supported for deployed services only (not for requests). For public cloud VMs, returns Unknown. |
| Storage Logical Size | target.storage.logicalSize.gb | The sum of all logical disks partitioned on the physical disks as reported by the guest OS, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). For public cloud VMs, returns Unknown. |
| Total Storage | target.storage.gb | The total of all storage of the deployed target, in gigabytes. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Unallocated Storage Space | target.storage.spaceUnallocated.gb | The virtual disk size minus the physical disk size, in gigabytes. Only returns a value during the time interval between adding a new disk to a VM in vCenter and running the next Commander datastore scan. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Unpartitioned Storage Space | target.storage.spaceUnpartitioned.gb | The physical disk size minus the logical disk size, in gigabytes. For custom cost calculations, this variable is supported for deployed services only (not for requests). |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Availability Set | target.availabilitySet.name | The availability set of the target. Supported only for Microsoft Azure. |
| Chef Node | target.chefNode | True if this VM is managed by Chef. |
| Chef Node Name | target.chefNodeName | The name of the Chef node associated with this VM. |
| Deployed Name | target.deployedName | The deployed name of the component. |
| DNS name | target.dnsName | The DNS name of the VM. For AWS VMs, which have both a private and a public DNS name, this is the public DNS name. |
| Expiry Date | target.expiryDate | The date set for the VM to expire. Values can be: Date, No Expiry Date Set, or Never Expires. |
| Management Server Type | target.mediatorType | The management server type. Values can be: Unknown, Vim2, Vim2.5, Vim4, Vim4.1, Vim5, Vim5.1, VIM55, MS SCVMM, Amazon Web Services, Microsoft Azure, or Kubernetes. |
| Organization ID | target.organization.id | The unique identifier of target VM's organization. |
| Power State | target.state | The power state of the VM. Values can be: Creating, Failed, Not running, Running, Saved, Starting, Stopping, Suspended, Suspending, or Unknown. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Puppet Node | target.puppetNode | True if this VM is managed by Puppet. |
| Puppet Node Name | target.puppetNodeName | The name of the Puppet node associated with this VM. |
| Remote ID | target.remoteId | An identifier for the VM/component in the cloud account. Do not use for customized VM naming. |
| Target ID | target.id | The unique identifier of the target VM. |
| Type | target.type | The component type. Values can be: VM, Virtual Service, or Unmanaged Object. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
VM Command Workflows: Address List Field Only
| Variable | Expression | Description |
|---|---|---|
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
Virtual Service Command Workflows
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Configuration | ||
| Connection State | target.connectionState | Indicates whether a VM is connected to the cloud account. Values can be: Connected, Disconnected, Inaccessible, Invalid, Orphaned, or Unknown. |
| Infrastructure | ||
| Cloud Account Address | target.cloudAccount.address | The address of the cloud account that the VM is running on. For AWS, this is the account number of the instance owner (the Owner property in AWS). For Microsoft Azure, this is the subscription ID. |
| Cloud Account Name | target.cloudAccount.name | The name of the cloud account. |
| Cloud Account Tenant ID | target.cloudAccount.tenantId | The Microsoft Azure tenant ID of the cloud account that the VM is running on. |
| Cloud Account Type | target.cloudAccount.type | The cloud account type. Values can be vc (for VMware), ms_scvmm, amazon_aws, googlecloud, ms_arm (for Azure Resource Manager), or k8s (for Kubernetes). |
| 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. |
| Region | target.region.name | The component's region. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Deployed Name | target.deployedName | The deployed name of the component. |
| DNS name | target.dnsName | The DNS name of the VM. For AWS VMs, which have both a private and a public DNS name, this is the public DNS name. |
| Expiry Date | target.expiryDate | The date set for the VM to expire. Values can be: Date, No Expiry Date Set, or Never Expires. |
| Management Server Type | target.mediatorType | The management server type. Values can be: Unknown, Vim2, Vim2.5, Vim4, Vim4.1, Vim5, Vim5.1, VIM55, MS SCVMM, Amazon Web Services, Microsoft Azure, or Kubernetes. |
| Number of VMs | target.vmCount | The number of VMs in the virtual service. |
| Organization ID | target.organization.id | The unique identifier of target VM's organization. |
| Power State | target.state | The power state of the VM. Values can be: Creating, Failed, Not running, Running, Saved, Starting, Stopping, Suspended, Suspending, or Unknown. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Remote ID | target.remoteId | An identifier for the VM/component in the cloud account. Do not use for customized VM naming. |
| Target ID | target.id | The unique identifier of the target VM. |
| Type | target.type | The component type. Values can be: VM, Virtual Service, or Unmanaged Object. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
Virtual Service Command Workflows: Address List Field Only
| Variable | Expression | Description |
|---|---|---|
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
Load Balancer Command Workflows
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Configuration | ||
| Connection State | target.connectionState | Indicates whether a VM is connected to the cloud account. Values can be: Connected, Disconnected, Inaccessible, Invalid, Orphaned, or Unknown. |
| Infrastructure | ||
| Cloud Account Address | target.cloudAccount.address | The address of the cloud account that the VM is running on. For AWS, this is the account number of the instance owner (the Owner property in AWS). For Microsoft Azure, this is the subscription ID. |
| Cloud Account Name | target.cloudAccount.name | The name of the cloud account. |
| Cloud Account Tenant ID | target.cloudAccount.tenantId | The Microsoft Azure tenant ID of the cloud account that the VM is running on. |
| Cloud Account Type | target.cloudAccount.type | The cloud account type. Values can be vc (for VMware), ms_scvmm, amazon_aws, googlecloud, ms_arm (for Azure Resource Manager), or k8s (for Kubernetes). |
| 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. |
| Region | target.region.name | The component's region. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Load balancer | ||
| Healthy Instance Health | target.healthyInstanceCount | The number of healthy instances associated with this load balancer. |
| Load Balancer Type | target.loadBalancerType | The type of Elastic Load Balancer. The values can be: classic, application, or network. |
| Scheme | target.scheme | For load balancers attached to Amazon VPCs, this indicates whether the load balancer is internal or internet-facing. Values can be: internal (a load balancer with a DNS name that resolves to private IP addresses) or internet-facing (a load balancer with a publicly resolvable DNS name, which resolves to public IP addresses). |
| Unhealthy Instance Health | target.unhealthyInstanceCount | The number of unhealthy instances associated with this load balancer. |
| Unknown Instance Health | target.unknownInstanceCount | The number of instances associated with this load balancer whose health is unknown. |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Deployed Name | target.deployedName | The deployed name of the component. |
| DNS name | target.dnsName | The DNS name of the VM. For AWS VMs, which have both a private and a public DNS name, this is the public DNS name. |
| Expiry Date | target.expiryDate | The date set for the VM to expire. Values can be: Date, No Expiry Date Set, or Never Expires. |
| Management Server Type | target.mediatorType | The management server type. Values can be: Unknown, Vim2, Vim2.5, Vim4, Vim4.1, Vim5, Vim5.1, VIM55, MS SCVMM, Amazon Web Services, Microsoft Azure, or Kubernetes. |
| Organization ID | target.organization.id | The unique identifier of target VM's organization. |
| Power State | target.state | The power state of the VM. Values can be: Creating, Failed, Not running, Running, Saved, Starting, Stopping, Suspended, Suspending, or Unknown. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Remote ID | target.remoteId | An identifier for the VM/component in the cloud account. Do not use for customized VM naming. |
| Target ID | target.id | The unique identifier of the target VM. |
| Type | target.type | The component type. Values can be: VM, Virtual Service, or Unmanaged Object. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
Load Balancer Command Workflows: Address List Field Only
| Variable | Expression | Description |
|---|---|---|
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
Database Command Workflows
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Configuration | ||
| Connection State | target.connectionState | Indicates whether a VM is connected to the cloud account. Values can be: Connected, Disconnected, Inaccessible, Invalid, Orphaned, or Unknown. |
| Database | ||
| Allocated Storage | target.allocatedStorage.gb | The allocated storage size of the database, in gigabytes. |
| Database Name | target.dbName | For MySQL, SQL Server and PostgreSQL: The name of this instance's initial database provided at creation time, if a name was specified when the DB instance was created. This same name is returned for the life of the DB instance. For Oracle: The Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance. |
| End point | target.port | The database's endpoint. |
| Engine Type | target.engineType | The database type, for example, mysql or postgres. |
| Engine Version | target.engineVersion | The database version, for example, 5.6.22 or 9.3.6 |
| Instance Status | target.instanceStatus | The status of the database (for example, available, running, rebooting, deleting). |
| IOPS | target.iops | The number of I/O operations per second (IOPS) that the database should provision. |
| Infrastructure | ||
| Cloud Account Address | target.cloudAccount.address | The address of the cloud account that the VM is running on. For AWS, this is the account number of the instance owner (the Owner property in AWS). For Microsoft Azure, this is the subscription ID. |
| Cloud Account Name | target.cloudAccount.name | The name of the cloud account. |
| Cloud Account Tenant ID | target.cloudAccount.tenantId | The Microsoft Azure tenant ID of the cloud account that the VM is running on. |
| Cloud Account Type | target.cloudAccount.type | The cloud account type. Values can be vc (for VMware), ms_scvmm, amazon_aws, googlecloud, ms_arm (for Azure Resource Manager), or k8s (for Kubernetes). |
| 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. |
| Managed By | target.managedBy | The remote id of the resource responsible for managing the current instance. The instance could be a host object or a VM. |
| 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. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Licensing | ||
| Azure Hybrid Benefit | target.azureHybridBenefit | The Azure Hybrid Benefit for the Azure instance. This could be for the VM or database. |
| Resources - CPU | ||
| Number Of Cores | target.numCores | The total number of cores of the deployed target. |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Deployed Name | target.deployedName | The deployed name of the component. |
| DNS name | target.dnsName | The DNS name of the VM. For AWS VMs, which have both a private and a public DNS name, this is the public DNS name. |
| Expiry Date | target.expiryDate | The date set for the VM to expire. Values can be: Date, No Expiry Date Set, or Never Expires. |
| Management Server Type | target.mediatorType | The management server type. Values can be: Unknown, Vim2, Vim2.5, Vim4, Vim4.1, Vim5, Vim5.1, VIM55, MS SCVMM, Amazon Web Services, Microsoft Azure, or Kubernetes. |
| Organization ID | target.organization.id | The unique identifier of target VM's organization. |
| Power State | target.state | The power state of the VM. Values can be: Creating, Failed, Not running, Running, Saved, Starting, Stopping, Suspended, Suspending, or Unknown. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Remote ID | target.remoteId | An identifier for the VM/component in the cloud account. Do not use for customized VM naming. |
| Replication Error | target.replicationError | For read replicas, displays errors that occurred during replication, if any. |
| Replication State | target.replicationState | For read replicas, the state of the read replica (for example, replicating, replicated). |
| Target ID | target.id | The unique identifier of the target VM. |
| Type | target.type | The component type. Values can be: VM, Virtual Service, or Unmanaged Object. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
Database Command Workflows: Address List Field Only
| Variable | Expression | Description |
|---|---|---|
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
Application Stack Command Workflows
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Configuration | ||
| Connection State | target.connectionState | Indicates whether a VM is connected to the cloud account. Values can be: Connected, Disconnected, Inaccessible, Invalid, Orphaned, or Unknown. |
| Infrastructure | ||
| Cloud Account Address | target.cloudAccount.address | The address of the cloud account that the VM is running on. For AWS, this is the account number of the instance owner (the Owner property in AWS). For Microsoft Azure, this is the subscription ID. |
| Cloud Account Name | target.cloudAccount.name | The name of the cloud account. |
| Cloud Account Tenant ID | target.cloudAccount.tenantId | The Microsoft Azure tenant ID of the cloud account that the VM is running on. |
| Cloud Account Type | target.cloudAccount.type | The cloud account type. Values can be vc (for VMware), ms_scvmm, amazon_aws, googlecloud, ms_arm (for Azure Resource Manager), or k8s (for Kubernetes). |
| 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. |
| Region | target.region.name | The component's region. |
| Initiator | ||
| Initiator Email | initiator.email | The initiator's email address. |
| Initiator Name | initiator.name | The initiator's name. |
| User ID | initiator.userId | The initiator's user ID. |
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Integrations | ||
| Chef Server IP | integrations.chef['*'].address | Hostname or IP address of the Chef server. |
| Chef Server Port | integrations.chef['*'].port | Port number for the Chef server |
| Puppet Server IP | integrations.puppet.address | Hostname or IP address of the Puppet server |
| Puppet Server Port | integrations.puppet.port | Port number for the Puppet server |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Deployed Name | target.deployedName | The deployed name of the component. |
| DNS name | target.dnsName | The DNS name of the VM. For AWS VMs, which have both a private and a public DNS name, this is the public DNS name. |
| Expiry Date | target.expiryDate | The date set for the VM to expire. Values can be: Date, No Expiry Date Set, or Never Expires. |
| Management Server Type | target.mediatorType | The management server type. Values can be: Unknown, Vim2, Vim2.5, Vim4, Vim4.1, Vim5, Vim5.1, VIM55, MS SCVMM, Amazon Web Services, Microsoft Azure, or Kubernetes. |
| Organization ID | target.organization.id | The unique identifier of target VM's organization. |
| Power State | target.state | The power state of the VM. Values can be: Creating, Failed, Not running, Running, Saved, Starting, Stopping, Suspended, Suspending, or Unknown. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Remote ID | target.remoteId | An identifier for the VM/component in the cloud account. Do not use for customized VM naming. |
| Target ID | target.id | The unique identifier of the target VM. |
| Type | target.type | The component type. Values can be: VM, Virtual Service, or Unmanaged Object. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Exit Code | steps[x].exitCode | Returns the exit code of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].exitCode} returns the exit code from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
| Skipped | steps[x].skipped | Indicates whether the specified step was skipped. Returns true if the specified step number was skipped; false otherwise. Replace the x with either a step number or step name. For example, #{steps[1].skipped} returns false if Step 1 in the current workflow executed successfully. If using a step name, enclose the step name in single quotation marks. |
| Workflow ID | workflowId | The Unique ID of the workflow this step is part of |
Application Stack Command Workflows: Address List Field Only
| Variable | Expression | Description |
|---|---|---|
| Input Variables | ||
| Input Variable | inputVariable['*'] | The value provided for the module specified input variable |
| Target | ||
| All Owners Email | target.allOwners.email | Semicolon-separated list of email addresses of the service's or component's owners. |
| Primary Owner Email | target.primaryOwner.email | The email address of the primary owner assigned to the target. |
| Target Custom Attributes | ||
| Custom Attribute | target.customAttribute['*'] | The value of the specified custom attribute for the deployed target. For custom cost calculations, this variable is supported for both requests and deployed services. |
| Workflow | ||
| Output | steps[x].output | Returns the output of the specified Execute Script step in the current workflow. Replace the x with either a step number or step name. For example, #{steps[1].output} returns the output from the first step in the workflow. If using a step name, enclose the step name in single quotation marks. |
