Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Pod substitution parameter syntax

The pod XML templates support embedding of references to pod substitution parameters to dynamically refer to the values of a particular pod. This includes the ability to reference VLANs that have been acquired from VLAN pools, addresses that have been acquired from address pools, and integers, for example, fault group IDs that have been acquired from integer pools.

The following table lists the syntax supported for pod substitution parameters:

Substitution parameterDescription and usage

addressPools[<address-pool-name
#link-id>].broadcastAddress

Refers to the broadcast address of the specified pool in Pod.addressPools.

Usage: ${pod.addressPools[<address-pool-name>].broadcastAddress}

addressPools[<address-pool-name
#link-id>].endAddress

Refers to the last address within the specified pool in Pod.addressPools.

Usage: ${pod.addressPools[<address-pool-name>].endAddress}

addressPools[<address-pool-name
#link-id>].gatewayAddress

Refers to the gateway address of the specified pool in Pod.addressPools.

Usage: ${pod.addressPools[<address-pool-name>].gatewayAddress}

addressPools[<address-pool-name
#link-id>].networkAddress

Refers to the network address of the address of the specified pool in Pod.addressPools.

Usage: ${pod.addressPools[<address-pool-name>].networkAddress}

addressPools[<address-pool-name
#link-id>].startAddress

Refers to the first address within the specified pool in Pod.addressPools.

Usage: ${pod.addressPools[<address-pool-name>].startAddress}

addressPools[<address-pool-name
#link-id>].subnetMask

Refers to the subnet mask of the specified pool in Pod.addressPools.

Note: For IPv6 addresses, subnetMask is not populated. Therefore, modify templates to use the appropriate IPv6 commands. Also, use the subnetMask.CIDR substitution parameter instead of the subnetMask substitution parameter.

Usage: ${pod.addressPools[<address-pool-name>].subnetMask}

addressPools[<address-pool-name
#link-id>].subnetMask.CIDR

Refers to the subnet mask of the specified pool in Pod.addressPools in Classless Inter-Domain Routing (CIDR) format.

Usage: ${pod.addressPools[<address-pool-name>].subnetMask.CIDR}

addressPools[<address-pool-
name>].broadcastAddress

Refers to the broadcast address of the specified pool in Pod.addressPools. Available only for a chain of pod address pools.

Usage: ${pod.addressPools[<address-pool-name>#<link-id>].broadcastAddress}

addressPools[<address-pool-
name>].endAddress

Refers to the last address within the specified pool in Pod.addressPools. Available only for a chain of pod address pools.

Usage: ${pod.addressPools[<address-pool-name>#<link-id>].endAddress}

addressPools[<address-pool-
name>].gatewayAddress

Refers to the gateway address of the specified pool in Pod.addressPools. Available only for a chain of pod address pools. 

Usage: ${pod.addressPools[<address-pool-name>#<link-id>].gatewayAddress}

addressPools[<address-pool-
name>].networkAddress

Refers to the network address of the address of the specified pool in Pod.addressPools. Available only for a chain of pod address pools.

Usage: ${pod.addressPools[<address-pool-name>#<link-id>].networkAddress}

addressPools[<address-pool-
name>].startAddress

Refers to the first address within the specified pool in Pod.addressPools. Available only for a chain of pod address pools.

Usage: ${pod.addressPools[<address-pool-name>#<link-id>].startAddress}

addressPools[<address-pool-
name>].subnetMask

Refers to the subnet mask of the specified pool in Pod.addressPools. This substitution parameter is available only for a chain of pod address pools.

Note: For IPv6 addresses, subnetMask is not populated. Therefore, modify templates to use the appropriate IPv6 commands. Also, use the subnetMask.CIDR substitution parameter instead of the subnetMask substitution parameter.

Usage: ${pod.addressPools[<address-pool-name>#<link-id>].subnetMask}

addressPools[<address-pool-
name>].subnetMask.CIDR

Refers to the subnet mask of the specified pool in Pod.addressPools in CIDR format. This substitution parameter is available only for a chain of NAT address pools.

Usage: ${pod.addressPools[<address-pool-name#link-id>].subnetMask.CIDR}}

balancedParams[<param-name>]

Refers to value of entry in Pod.balancedParams of specified name, which will be appropriate for a given container instance.

Usage: ${pod.balancedParams[<balanced-param-name>]}

id

Refers to value of Pod.id attribute.

Usage: ${pod.id}

name

Refers to value of Pod.name attribute.

Usage: ${pod.name}

node.balancedParams[<param-
name>]

Refers to value of entry in PodNode.balancedParams of current node for specified name, which is appropriate for a given container instance.

Usage: ${pod.node.balancedParams[<balanced-param-name>]}

node.params[<param-name>]

Refers to value of entry in PodNode.params of current node for specified name.

Usage: ${pod.node.params[<param-name>]}

node.portTypes[<port-type-
name>].name

Refers to the name of a VirtualPortType in this PodHypervisorSwitch. This should match the name of the corresponding port group on the VSwitch (or port profile on the Nexus 1000V) which already exists for this pod.

For pods created before BMC Network Automation version 8.1.02, this refers to VLAN number since BMC Cloud Lifecycle Management created port groups or port profiles using VLAN number. For pods created in BMC Network Automation version 8.1.02 and later, this corresponds to the nameWithinSwich attribute specified in the blueprint.

Usage: ${pod.node.portTypes[<port-type-name>].name}

node.portTypes[<port-type-
name>].vlan

Refers to the id of the VLAN associated with a VirtualPortType in this PodHypervisorSwitch

Usage: ${pod.node.portTypes[<port-type-name>].vlan]}

nodes[<role-name>]
.balancedParams[<param-name>]

Refers to value of entry in PodNode.balancedParams of the specified node for specified role, which will be appropriate for a given container instance.

Usage: ${pod.nodes[<role-name>].balancedParams[<balanced-param-name>]}

nodes[<role-name>].params
[<param-name>]

Refers to value of entry in PodNode.params of the specified node for specified name.

Usage: ${pod.nodes[<role-name>].params[<param-name>]}

nodes[<role-name>].portTypes
[<port-type-name>].name

Refers to value of entry in PodPair.balancedParams of current pair for specified name, which will be appropriate for a given container instance.

Usage: ${pod.pair.balancedParams[<balanced-param-name>]}

nodes[<role-name>].portTypes
[<port-type-name>].vlan

Refers to the name of a VirtualPortType in the specified PodHypervisorSwitch. This should match the name of the corresponding port group on the VSwitch (or port profile on the Nexus 1000V) which already exists for this pod.

For pods created before BMC Network Automation version 8.1.02, this refers to VLAN number since BMC Cloud Lifecycle Management created port groups or port profiles using VLAN number. For pods created in BMC Network Automation version 8.1.02 and later, this corresponds to the nameWithinSwich attribute specified in the blueprint.

Usage: ${pod.nodes[<role-name>].portTypes[<port-type-name>].name}

pair.balancedParams[<param
-name>]

Refers to the id of the VLAN associated with a VirtualPortType in the specified PodHypervisorSwitch

Usage: ${pod.nodes[role-name].portTypes[<port-type-name>].vlan}

pair.params[<param-name>]

Refers to value of entry in PodPair.params of current group for specified name.

Usage: ${pod.pair.params[<param-name>]}

pairs[<pair-name>]
.balancedParams[<param-name>]

Refers to value of entry in PodPair.balancedParams of the specified pair for specified name, which will be appropriate for a given container instance.

Usage: ${pod.pairs[pair-name].balancedParams[<balanced-param-name>]}

pairs[<pair-name>].params
[<param-name>]

Refers to value of entry in PodPair.params of the specified group for specified name.

Usage: ${pod.pairs[pair-name].params[<param-name>]}

params[<param-name>]

Refers to value of entry in Pod.params of specified name.

Usage: ${pod.params[<param-name>]}

vlans[<vlan-name>]

Refers to numeric value of management VLAN of specified name acquired by this pod.

Usage: ${pod.vlans[<vlan-name>]}

vnmcTenant

Refers to value of Pod.vnmcTenant attribute.

Usage: ${pod.vnmcTenant}

The names called out in <vlan-name> are automatically prefixed with the name of the container before they are used because they refer to pod resources that must be uniquely named across containers.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments