Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

Container substitution parameter syntax

The following table shows the syntax for container substitution parameters:

Substitution parameterDescription

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Refers to the subnet mask of the specified pool in Container.addressPools. This substitution parameter is available only for a chain of NAT 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: ${container.addressPools[<address-pool-name>#link-id].subnetMask}

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

Refers to the subnet mask of the specified pool in Container.addressPools in Classless Inter-Domain Routing (CIDR) format. This substitution parameter is available only for chain of NAT address pools

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Refers to the subnet mask of the specified pool in Container.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: ${container.addressPools[<address-pool-name>].subnetMask}

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

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

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

addressSpaces[<address-space-name>]
.networkAddress

Refers to the network address of the specified space in Container.addressSpaces

Usage: ${container.addressSpaces[<address-space-name>].networkAddress}

addressSpaces[<address-space-name>]
.networkMask

Refers to the network mask of the specified space in Container.addressSpaces

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

Usage: ${container.addressSpaces[<address-space-name>].networkMask}

addressSpaces[<address-space-name>]
.networkMask.CIDR

Refers to the network mask of the specified space in CIDR format in Container.addressSpaces

Usage: ${container.addressSpaces[<address-space-name>].networkMask.CIDR}

addresses[<address-name>]

Refers to the numeric value of address of specified name for this container

Usage: ${container.addresses[<address-name>]}

addresses[<address-name>].gatewayAddress

Refers to the gateway address of the address pool from which the address has been acquired

Usage: ${container.addresses[<address-name>].gatewayAddress}

addresses[<address-name>].networkAddress

Refers to the network address of the address pool from which the address has been acquired

Usage: ${container.addresses[<address-name>].networkAddress}

addresses[<address-name>].subnetMask

Refers to the subnet mask of the address pool from which the specified address is derived for this container

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: ${container.addresses[<address-name>].subnetMask}

addresses[<address-name>]
.subnetMask.CIDR

Refers to the subnet mask of the address pool which the specified address came from for this container in CIDR format

Usage: ${container.addresses[<address-name>].subnetMask.CIDR}

blueprint

Refers to the value of the Container.blueprintName attribute

Usage: ${container.blueprint}

communityFaultHostPair.faultId

Refers to the numeric value of the fault ID of the current ContainerCommunityFaultHostPair

Usage: ${container.communityFaultHostPair.faultId}

communityFaultHostPair.managementVlan

Refers to the management VLAN number of the current ContainerCommunityFaultHostPair

Usage: ${container.communityFaultHostPair.managementVlan}

communityFaultHostPairs[<pair-name>]
.faultId

Refers to the numeric value of the fault id of the specified ContaineCommunithyFaultHostPair

Usage: ${container.communityFaultHostPairs[<pair-name>].faultId}

communityFaultHostPairs[<pair-name>]
.managementVlan

Refers to the management VLAN number of the specified ContainerCommunityFaultHostPair

Usage: ${container.communityFaultHostPairs[<pair-name>].managementVlan}

externalSegments[<external-segment-name>]
.broadcastAddress

Refers to the broadcast address of the external network

Usage: ${container.externalSegments[<external-segment-name>].broadcastAddress}

externalSegments[<external-segment-name>]
.endAddress

Refers to the last address within the specified external network

Usage: ${container.externalSegments[<external-segment-name>].endAddress}

externalSegments[<external-segment-name>]
.networkAddress

Refers to the network address of the specified external network

Usage: ${container.externalSegments[<external-segment-name>].networkAddress}

externalSegments[<external-segment-name>]
.startAddress

Refers to the first address within the specified external network

Usage: ${container.externalSegments[<external-segment-name>].startAddress}

externalSegments[<external-segment-name>]
.subnetMask

Refers to the subnet mask of the specified external network

Usage: ${container.externalSegments[<external-segment-name>].subnetMask}

externalSegments[<external-segment-name>]
.subnetMask.CIDR

Refers to the subnet mask of the specified external network in Classless Inter-Domain Routing (CIDR) format

Usage: ${container.externalSegments[<external-segment-name>].subnetMask.CIDR}

id

Refers to the value of Container.id attribute

Usage: ${container.id}

individualFaultHostPair.faultId

Refers to the numeric value of the fault id of the current ContainerIndividualFaultHostPair

Usage: ${container.individualFaultHostPair.faultId}

individualFaultHostPair.guestLocal
CreationPriority

Refers to the priority value of the local guest virtual context (the one that resides on the same host as the active admin context of the current ContainerIndividualFaultHostPair)

Usage: ${container.individualFaultHostPair.guestLocalCreationPriority}

individualFaultHostPair.guestRemote
CreationPriority

Refers to the priority value of the remote guest virtual context (the one that resides on the same host as the standby admin context of the current ContainerIndividualFaultHostPair)

Usage: ${container.individualFaultHostPair.guestRemoteCreationPriority}

individualFaultHostPairs[<pair-name>].faultId

Refers to the numeric value of the fault ID of the specified ContaineIndividualFaultHostPair

Usage: ${container.individualFaultHostPairs[<pair-name>].faultId}

individualFaultHostPairs[<pair-name>]
.guestLocalCreationPriority

Refers to the priority value to use when creating a guest virtual context on the host with the active admin context of the specified ContainerIndividualFaultHostPair

Usage: ${container.individualFaultHostPairs[<pair-name>].guestLocalCreationPriority}

individualFaultHostPairs[<pair-name>]
.guestRemoteCreationPriority

Refers to the priority value to use when creating a guest virtual context on the host which is remote from the host with the active admin context of the specified ContainerIndividualFaultHostPair

Usage: ${container.individualFaultHostPairs[<pair-name>].guestRemoteCreationPriority}

integers[<integer-name>]

Refers to the numeric value of acquired integer identified by <integer-name> in Container.acquiredIntegers

Usage: ${container.integers[<integer-name]}

name

Refers to the value of Container.name attribute

Usage: ${container.name}

nicSegments[<nic-segment-name>].edgeSecurityProfile

Refers to the name of the edge security profile for the ASA1000V firewall

Usage: ${container.nicSegments[<nic-segment-name>].edgeSecurityProfile}

nicSegments[<nic-segment-name>].egressPolicy

Refers to the name of the egress policy associated with the edge security profile

Usage: ${container.nicSegments[<nic-segment-name>].egressPolicy}

nicSegments[<nic-segment-name>].egressPolicySet

Refers to the name of the egress policy set associated with the edge security profile. The Policy-Set for Egress traffic is equivalent  to the Outbound ACL.

Usage: ${container.nicSegments[<nic-segment-name>].egressPolicySet}

nicSegments[<nic-segment-name>].ingressPolicy

Refers to the name of the ingress policy associated with the edge security profile

Usage: ${container.nicSegments[<nic-segment-name>].ingressPolicy}

nicSegments[<nic-segment-name>].ingressPolicySet

Refers to the name of the ingress policy set associated with the edge security profile. The Policy-Set for Ingress traffic is equivalent to the Inbound ACL.

Usage: ${container.nicSegments[<nic-segment-name>].ingressPolicySet}

nicSegments[<nic-segment-name>].policy

Refers to the name of the policy that is created in the Cisco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the policy.

Usage: ${container.nicSegments[<nic-segment-name>].policy}

nicSegments[<nic-segment-name>].policySet

Refers to the name of the policy set that is created in the CIsco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the policy set.

Usage: ${container.nicSegments[<nic-segment-name>].policySet}

nicSegments[<nic-segment-name>].security
Profile

Refers to the name of the security profile that is created in the Cisco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the security profile.

Usage: ${container.nicSegments[<nic-segment-name>].securityProfile}

node.aclName (<= 8.1.05)

Refers to the name of the ACL to which firewall rules are added. This parameter is available only for containers created in or before BMC Network Automation 8.1.05.

Usage: ${container.node.aclName}

node.actions[<action-name>].results
[<result-name>]

Refers to a particular result of an ExternalScriptActionInfo or CustomActionInfo within the current ContainerNode

Usage${container.node.actions[<action-name>].results[<result-name>]}

node.addresses[<address-name>]

Refers to the numeric value of address of specified name for the current ContainerNode

Usage: ${container.node.addresses[<address-name>]}

node.addresses[<address-name>]
.gatewayAddress

Refers to the gateway address of the address pool from which the address has been acquired

Usage: ${container.node.addresses[<address-name>].gatewayAddress}

node.addresses[<address-name>]
.networkAddress

Refers to the network address of the address pool from which the address has been acquired

Usage: ${container.node.addresses[<address-name>].networkAddress}

node.addresses[<address-name>].subnetMask

Refers to the subnet mask of the address pool from which the specified address is derived for the current ContainerNode

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: ${container.node.addresses[<address-name>].subnetMask}

node.addresses[<address-name>]
.subnetMask.CIDR

Refers to the subnet mask of the address pool which the specified address came from for the current ContainerNode in CIDR format

Usage: ${container.node.addresses[<address-name>].subnetMask.CIDR}

node.addresses[<address-name>].subnetMask

Refers to the subnet mask of the address pool from which the specified address is derived for the current ContainerNode.

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: ${container.node.addresses[<address-name>].subnetMask}

node.addresses[<address-name>]
.subnetMask.CIDR

Refers to the subnet mask of the address pool which the specified address came from for the current ContainerNode in CIDR format

Usage: ${container.node.addresses[<address-name>].subnetMask.CIDR}

node.device.address

Refers to the address of the device for the current ContainerNode

Usage: ${container.node.device.address}

node.device.name

Refers to the name of the device for the current ContainerNode

Usage: ${container.node.device.name}

node.device.password

Refers to the password used to log into the device of the current ContainerNode

Usage: ${container.node.device.password}

node.device.priv_password

Refers to the password to be used when switching to the privileged mode to log into the device of the current ContainerNode

Usage: {container.node.device.priv_password}

node.device.securityContext

Refers to the name of the security context the device of the current ContainerNode represents (if any)

Usage: ${container.node.device.securityContext}

node.device.user

Refers to the user name used to log into the device of the current ContainerNode

Usage: ${container.node.device.user}

node.guestDevice.address

Refers to the address of the guest device for the current ContainerHost

Usage: ${container.node.guestDevice.address}

node.guestDevice.name

Refers to the name of the guest device for the current ContainerHost

Usage: ${container.node.guestDevice.name}

node.guestDevice.password

Refers to the password used to log into the guest device of the current ContainerHost

Usage: ${container.node.guestDevice.password}

node.guestDevice.priv_password

Refers to the password to be used when switching to the privileged mode to log into the guest device in privileged mode of the current ContainerHost

Usage: ${container.node.guestDevice.priv_password}

node.guestDevice.securityContext

Refers to the name of the security context the guest device of the current ContainerHost represents (if any)

Usage: ${container.node.guestDevice.securityContext}

node.guestDevice.user

Refers to the user name used to log into the guest device of the current ContainerHost

Usage: ${container.node.guestDevice.user}

node.managedInterfaces[<interface-name>]
.inboundAclName

Refers to the inbound ACL name of the interface identified by <interface-name>

Usage: ${container.node.managedInterfaces[<interface-name>].inboundAclName}

node.managedInterfaces[<interface-name>]
.outboundAclName

Refers to the outbound ACL name of the interface identified by <interface-name>

Usage: ${container.node.managedInterfaces[<interface-name>].outboundAclName}

node.managedInterfaces[<interface-name>]
.sanitizedName

Refers to the name of the interface identified by <interface-name>. The name is sanitized, where any non-alphanumeric character is replaced with a "-".

Usage: ${container.node.managedInterfaces[<interface-name>].sanitizedName}

node.outsideInterfaceName (<= 8.1.05)

Refers to the name of the outside interface in the underlying pod host node. This parameter is available only for containers created in or before BMC Network Automation 8.1.05.

Usage: ${container.node.outsideInterfaceName}

node.podGuestDevice.address

Refers to the address of the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.node.podGuestDevice.address}

node.podGuestDevice.name

Refers to the name of the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.node.podGuestDevice.name}

node.podGuestDevice.password

Refers to the password of the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.node.podGuestDevice.password}

node.podGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode of the reusable guest device defined in the underlying pod host node

Usage: ${container.node.podGuestDevice.priv_password}

node.podGuestDevice.securityContext

Refers to the security context the reusable guest device defined in the underlying pod host node represents

Usage: ${container.node.podGuestDevice.securityContext}

 node.podGuestDevice.user

Refers to the user name used to log into the reusable guest device defined in the underlying pod host node

Usage: ${container.node.podGuestDevice.user}

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

Refers to the port type name used to create port groups in hypervisors. The value of the attribute is <container-name>.<prot-type-name>

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

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

Refers to the VLAN used to configure hypervisors. The VMs created in hypervisors resides in this VLAN for a given container.

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

node.primaryGuestDevice.address

Refers to the address of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.node.primaryGuestDevice.address}

node.primaryGuestDevice.name

Refers to the name of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.node.primaryGuestDevice.name}

node.primaryGuestDevice.password

Refers to the password of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.node.primaryGuestDevice.password}

node.primaryGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.node.primaryGuestDevice.priv_password}

node.primaryGuestDevice.securityContext

Refers to the security context the reusable guest device identified as primary when the VLB is operating in HA mode represents

Usage: ${container.node.primaryGuestDevice.securityContext}

node.primaryGuestDevice.user

Refers to the user name used to log into the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.node.primaryGuestDevice.user}

node.secondaryGuestDevice.address

Refers to the address of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.node.secondaryGuestDevice.address}

node.secondaryGuestDevice.name

Refers to the name of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.node.secondaryGuestDevice.name}

node.secondaryGuestDevice.password

Refers to the password of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.node.secondaryGuestDevice.password}

node.secondaryGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.node.secondaryGuestDevice.priv_password}

node.secondaryGuestDevice.securityContext

Refers to the security context the reusable guest device identified as secondary when the VLB is operating in HA mode represents

Usage: ${container.node.secondaryGuestDevice.securityContext}

node.secondaryGuestDevice.user

Refers to the user name used to log into the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.node.secondaryGuestDevice.user}

nodes[<role-name>].aclName (<=8.1.05)

Refers to the name of the ACL to which firewall rules are added for the specified ContainerNode. This parameter is available only for containers created in or before BMC Network Automation 8.1.05.

Usage:  ${container.nodes[<role-name>].aclName}

nodes[<role-name>].actions[<action-name>]
.results[<result-name>]

Refers to a particular result of an ExternalScriptActionInfo or CustomActionInfo within the specified ContainerNode

Usage: ${container.nodes[<node-name>].actions[<action-name>].results[<result-name>]}

nodes[<role-name>].addresses
[<address-name>]

Refers to the numeric value of the address for the specified name for the specified ContainerNode

Usage: ${container.nodes[<role-name>].addresses[<address-name>]}

nodes[<role-name>].addresses
[<address-name>].gatewayAddress

Refers to the gateway address of the address pool from which the address has been acquired

Usage: ${container.nodes[<role-name>].addresses[<address-name>].gatewayAddress}

nodes[<role-name>].addresses
[<address-name>].networkAddress

Refers to the network address of the address pool from which the address has been acquired

Usage: ${container.nodes[<role-name>].addresses[<address-name>].networkAddress}

nodes[<role-name>].addresses
[<address-name>].subnetMask

Refers to the subnet mask of the address pool from which the specified address is derived for the specified ContainerNode

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: ${container.nodes[<role-name>].addresses[<address-name>].subnetMask}

nodes[<role-name>].addresses
[<address-name>].subnetMask.CIDR

Refers to the subnet mask of the address pool which the specified address came from for the specified ContainerNode in CIDR format

Usage: ${container.nodes[<role-name>].addresses[<address-name>].subnetMask.CIDR}

nodes[<role-name>].device.address

Refers to the address of the device for the specified ContainerNode

Usage: ${container.nodes[<role-name>].device.address}

nodes[<role-name>].device.name

Refers to the name of the device for the specified ContainerNode

Usage: ${container.nodes[<role-name>].device.name}

nodes[<role-name>].device.password

Refers to the password used to log into the device of the specified ContainerNode

Usage: ${container.nodes[<role-name>].device.password}

nodes[<role-name>].device.priv_password}

Refers to the password to be used when switching to the privileged mode   to log into the device of the specified ContainerNode

${container.nodes[<role-name>].device.priv_password}

nodes[<role-name>].device.security
Context

Refers to the name of the security context the device of the specified ContainerNode represents (if any)

Usage: ${container.nodes[<role-name>].device.securityContext}

nodes[<role-name>].device.user

Refers to the user name used to log into the device of the specified ContainerNode

Usage: ${container.nodes[<role-name>].device.username}

nodes[<role-name>].guestDevice.address

Refers to the address of the guest device for the specified ContainerHost

Usage: ${container.nodes[<role-name>].guestDevice.address}

nodes[<role-name>].guestDevice.name

Refers to the name of the guest device for the specified ContainerHost

Usage: ${container.nodes[<role-name>].guestDevice.name}

nodes[<role-name>].guestDevice.password

Refers to the password used to log into the guest device of the specified ContainerHost

Usage: ${container.nodes[<role-name>].guestDevice.password}

nodes[<role-name>].guestDevice
.priv_password

Refers to the password to be used when switching to the privileged mode to log into the guest device in privileged mode of the current ContainerHost

Usage: ${container.nodes[<role-name>].guestDevice.priv_password}

nodes[<role-name>].guestDevice
.securityContext

Refers to the security context the guest device of the current ContainerHost represents (if any)

Usage: ${container.nodes[<role-name>].guestDevice.securityContext}

nodes[<role-name>].guestDevice.user

Refers to the user name used to log into the guest device of the specified ContainerHost

Usage: ${container.nodes[<role-name>].guestDevice.user}

nodes[<role-name>].managedInterfaces
[<interface-name>].inboundAclName

Refers to the inbound ACL name of the interface identified by <interface-name>

Usage: ${container.nodes[<role-name>].managedInterfaces[<interface-name>].inboundAclName}

nodes[<role-name>].managedInterfaces
[<interface-name>].outboundAclName

Refers to the outbound ACL name of interface identified by <interface-name>

Usage: ${container.nodes[<role-name>].managedInterfaces[<interface-name>].outboundAclName}

nodes[<role-name>].managedInterfaces
[<interface-name>].sanitizedName

Refers to the name of interface identified by <interface-name>. The name is sanitized, where any non-alphanumeric character is replaced with a "-".

Usage: ${container.nodes[<role-name>].managedInterfaces[<interface-name>].sanitizedName}

nodes[<role-name>].outsideInterfaceName (<= 8.1.05)

Refers to the name of the outside interface to which the ACL with ${container.node.aclName} will be applied for the specified ContainerNode. This parameter is available only for containers created in or before BMC Network Automation 8.1.05.

Usage: ${container.nodes[<role-name>].outsideInterfaceName}

nodes[<role-name>].podGuestDevice.address

Refers to the address of the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.nodes[<role-name>].podGuestDevice.address}

nodes[<role-name>].podGuestDevice.name

Refers to the name of the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.nodes[<role-name>].podGuestDevice.name}

nodes[<role-name>].podGuestDevice.password

Refers to the password used to log into the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.nodes[<role-name>].podGuestDevice.password}

nodes[<role-name>].podGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode to log into the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.nodes[<role-name>].podGuestDevice.priv_password}

nodes[<role-name>].podGuestDevice.securityContext

Refers to the security context the reusable guest device defined in the underlying pod host node represents

Usage: ${container.nodes[<role-name>].podGuestDevice.securityContext}

nodes[<role-name>].podGuestDevice.user

Refers to the user name used to log into the reusable guest device defined in the underlying pod host node (if any)

Usage: ${container.nodes[<role-name>].podGuestDevice.user}

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

Refers to the port type name used to create port groups in hypervisors. The value of the attribute is <container-name>.<port-type-name>.

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

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

Refers to the VLAN used to configure hypervisors. The VMs created in hypervisors reside in this VLAN for a given container.

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

nodes[<role-name>].primaryGuestDevice.address

Refers to the address of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].primaryGuestDevice.address}

nodes[<role-name>].primaryGuestDevice.name

Refers to the name of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].primaryGuestDevice.name}

nodes[<role-name>].primaryGuestDevice.password

Refers to the password used to log into the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].primaryGuestDevice.password}

nodes[<role-name>].primaryGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode of the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].primaryGuestDevice.priv_password}

nodes[<role-name>].primaryGuestDevice.securityContext

Refers to the security context the reusable guest device identified as primary when the VLB is operating in HA mode  represents

Usage: ${container.nodes[<role-name>].primaryGuestDevice.securityContext}

nodes[<role-name>].primaryGuestDevice.user

Refers to the user name used to log into the reusable guest device identified as primary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].primaryGuestDevice.user}

nodes[<role-name>].secondaryGuestDevice.address

Refers to the address of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].secondaryGuestDevice.address}

nodes[<role-name>].secondaryGuestDevice.name

Refers to the name of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].secondaryGuestDevice.name}

nodes[<role-name>].secondaryGuestDevice.password

Refers to the password used to log into the the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].secondaryGuestDevice.password}

nodes[<role-name>].secondaryGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode of the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].secondaryGuestDevice.priv_password}

nodes[<role-name>].secondaryGuestDevice.securityContext

Refers to the security context the reusable guest device identified as secondary when the VLB is operating in HA mode represents 

Usage: ${container.nodes[<role-name>].secondaryGuestDevice.securityContext}

nodes[<role-name>].secondaryGuestDevice.user}

Refers to the user name used to log into the reusable guest device identified as secondary when the VLB is operating in HA mode

Usage: ${container.nodes[<role-name>].secondaryGuestDevice.user}

pair.actions[<action-name>].results
[<result-name>]

Refers to a particular result of an ExternalScriptActionInfo or CustomActionInfo within the specified ContainerPair

Usage: ${container.pair.actions[<action-name>].results[<result-name>]}

pair.addresses[<address-name>]

Refers to the numeric value of address of specified name for the current ContainerPair

Usage: ${container.pair.addresses[<address-name>]}

pair.addresses[<address-name>].gatewayAddress

Refers to the gateway address of the address pool from which the specified address is derived for the current ContainerPair

Usage: ${container.pair.addresses[<address-name>].gatewayAddress}

pair.addresses[<address-name>].networkAddres

Refers to the network address of the address pool from which the specified address is derived for the current ContainerPair

Usage: ${container.pair.addresses[<address-name>].networkAddress}

pair.addresses[<address-name>]
.subnetMask

Refers to the subnet mask of the address pool from which the specified address is derived for the current ContainerPair

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: ${container.pair.addresses[<address-name>].subnetMask}

pair.addresses[<address-name>]
.subnetMask.CIDR

Refers to the subnet mask of the address pool which the specified address came from for the current ContainerPair in CIDR format

Usage: ${container.pair.addresses[<address-name>].subnetMask.CIDR}

pair.guestDevice.address

Refers to the address of the guest device of the current ContainerPair

Usage: ${container.pair.guestDevice.address}

pair.guestDevice.name

Refers to the name of the guest device of the current ContainerPair

Usage: ${container.pair.guestDevice.name}

pair.guestDevice.password

Refers to the password used to log into the guest device of the current ContainerPair

Usage: ${container.pair.guestDevice.password}

pair.guestDevice.priv_password

Refers to the privileged password used to log into the guest device in privileged mode of the current ContainerPair

Usage: ${container.pair.guestDevice.priv_password}

pair.guestDevice.securityContext

Refers to the security context the guest device of the current ContainerPair represents 

Usage: ${container.pair.guestDevice.securityContext}

pair.guestDevice.user

Refers to the user name used to log into the guest device of the current ContainerPair

Usage: ${container.pair.guestDevice.user}

pair.podGuestDevice.address

Refers to the address of the reusable guest device defined in the underlying pod fault host pair (if any)

Usage: ${container.pair.podGuestDevice.address}

pair.podGuestDevice.name

Refers to the name of the reusable guest device defined in the underlying pod fault host pair (if any)

Usage: ${container.pair.podGuestDevice.name}

pair.podGuestDevice.password

Refers to the password used to log into the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pair.podGuestDevice.password}

pair.podGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode of the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pair.podGuestDevice.priv_password}

pair.podGuestDevice.securityContext

Refers to the security context the reusable guest device defined in the underlying pod fault host pair represents

Usage: ${container.pair.podGuestDevice.priv_securityContext}

pair.podGuestDevice.user

Refers to the user name used to log into the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pair.podGuestDevice.priv_user}

pairs[<pair-name>].addresses
[<address-name>]

Refers to the numeric value of address of specified name for the specified ContainerPair

Usage: ${container.pairs[<pair-name>].addresses[<address-name>]}

pairs[<pair-name>].addresses[<address-name>].gatewayAddress

Refers to the gateway address of the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pairs[<pair-name>].addresses[<address-name>].gatewayAddress}

pairs[<pair-name>].addresses[<address-name>].networkAddress

Refers to the network address of the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pairs[<pair-name>].addresses[<address-name>].networkAddress}

pairs[<pair-name>].addresses
[<address-name>].subnetMask

Refers to the subnet mask of the address pool from which the specified address is derived for the specified ContainerPair

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: ${container.pairs[<pair-name>].addresses[<address-name>].subnetMask}

pairs[<pair-name>].addresses
[<address-name>].subnetMask.CIDR

Refers to the subnet mask of the address pool which the specified address came from for the specified ContainerPair in CIDR format

Usage: ${container.pairs[<pair-name>].addresses[<address-name>].subnetMask.CIDR}

pairs[<pair-name>].guestDevice.address

Refers to the address of the guest device for the specified ContainerPair

Usage: ${container.pairs[<pair-name>].guestDevice.address}

pairs[<pair-name>].guestDevice.name

Refers to the name of the guest device for the specified ContainerPair

Usage: ${container.pairs[<pair-name>].guestDevice.name}

pairs[<pair-name>].guestDevice.password

Refers to the password used to log into the guest device for the specified ContainerPair

Usage: ${container.pairs[<pair-name>].guestDevice.password}

pairs[<pair-name>].guestDevice.priv_password

Refers to the password to be used when switching to the privileged mode to log into the guest device in privileged mode of the specified ContainerPair

Usage: ${container.pairs[<pair-name>].guestDevice.priv_password}

pairs[<pair-name>].guestDevice.user

Refers to the user name used to log into the guest device for the specified ContainerPair

Usage: ${container.pairs[<pair-name>].guestDevice.user}

pairs[<pair-name>].podGuestDevice.address

Refers to the address of the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pairs[<pair-name>].podGuestDevice.address}

pairs[<pair-name>].podGuestDevice.name

Refers to the name of the reusable guest device defined in the underlying pod fault host pair (if any)

Usage: ${container.pairs[<pair-name>].podGuestDevice.name}

pairs[<pair-name>].podGuestDevice.password

Refers to the password used to log into the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pairs[<pair-name>].podGuestDevice.password}

pairs[<pair-name>].podGuestDevice.priv_password

Refers to the password to be used when switching to the privileged mode to log into the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pairs[<pair-name>].podGuestDevice.priv_password}

${container.pairs[<pair-name>].podGuestDevice.securityContext} 

Refers to the security context the reusable guest device defined in the underlying pod fault host pair represents

Usage: ${container.pairs[<pair-name>].podGuestDevice.securityContext}

${container.pairs[<pair-name>].podGuestDevice.user}

Refers to the user name used to log into the reusable guest device defined in the underlying pod fault host pair

Usage: ${container.pairs[<pair-name>].podGuestDevice.user}

pairs[<role-name>].actions[<action-name>]
.results[<result-name>]

Refers to a particular result of an ExternalScriptActionInfo or CustomActionInfo within the specified pair

Usage: ${container.pairs[<role-name>].actions[<action-name>].results[<result-name>]}

type

Refers to the type of the container

Usage: ${container.type}

vlans[<vlan-name>]

Refers to the numeric value of VLAN with a specified name acquired by this container

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

vnmcTenant

Refers to the tenant for the Cisco VNMC

Usage: ${container.vnmcTenant}

vrfIds[<vrf-name>]

Refers to the VRF ID identified by <vrf-name> in Container.vrfIds

Usage: ${container.vrfIds[<vrf-name>]}

zone.name

Refers to the name of the current zone

Usage: ${container.zone.name}

zone.nicSegments[<nic-segment-name>].edgeSecurityProfile

Refers to the name of the edge security profile of ASA1000V firewall.

Usage: ${container.zone.nicSegments[<nic-segment-name>].edgeSecurityProfile}

zone.nicSegments[<nic-segment-name>].egressPolicy

Refers to the name of the egress policy associated with the edge security profile.

Usage: ${container.zone.nicSegments[<nic-segment-name>].egressPolicy}

zone.nicSegments[<nic-segment-name>].egressPolicySet

Refers to the name of the egress policy set associated with the edge security profile. The Policy-Set for Egress traffic is equivalent  to the Outbound ACL.

Usage: ${container.zone.nicSegments[<nic-segment-name>].egressPolicySet}

zone.nicSegments[<nic-segment-name>].ingressPolicy

Refers to the name of the ingress policy associated with the edge security profile

Usage: ${container.zone.nicSegments[<nic-segment-name>].ingressPolicy}

zone.nicSegments[<nic-segment-name>].ingressPolicySet

Refers to the name of the ingress policy set associated with the edge security profile. The Policy-Set for Ingress traffic is equivalent to the Inbound ACL

Usage: ${container.zone.nicSegments[<nic-segment-name>].ingressPolicy}

zone.nicSegments[<nic-segment-name>].policy

Refers to the name of the policy that is created in the Cisco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the policy.

Usage: ${container.zone.nicSegments[<nic-segment-name>].policy}

zone.nicSegments[<nic-segment-name>].policySet

Refers to the name of the policy set that is created in the CIsco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the policy set.

Usage: ${container.zone.nicSegments[<nic-segment-name>].policySet}

zone.nicSegments[<nic-segment-name>].securityProfile

Refers to the name of the security profile that is created in the Cisco VSG to secure this NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the security profile.

Usage: ${container.zone.nicSegments[<nic-segment-name>].securityProfile}

zone.type

Refers to the type of the current zone

Usage: ${container.zone.type}

zones[<zone-name>].name

Refers to the name of of the specified zone name

Usage: ${container.zones[<zone-name>].name}

zones[<zone-name>].nicSegments[<nic-segment-name>].edgeSecurityProfile

Refers to the name of the edge security profile of ASA1000V firewall.

Usage:${container.zones[<zone-name>].nicSegments[<nic-segment-name>].edgeSecurityProfile}

zones[<zone-name>].nicSegments[<nic-segment-name>].egressPolicy

Refers to the name of the egress policy associated with the edge security profile.

Usage: ${container.zones[<zone-name>].nicSegments[<nic-segment-name>].egressPolicy}

zones[<zone-name>].nicSegments[<nic-segment-name>].egressPolicySet

Refers to the name of the egress policy set associated with the edge security profile. The Policy-Set for Egress traffic is equivalent  to the Outbound ACL.

Usage: ${container.zones[<zone-name>].nicSegments[<nic-segment-name>].egressPolicySet}

zones[<zone-name>].nicSegments[<nic-segment-name>].ingressPolicy

Refers to the name of the ingress policy associated with the edge security profile

Usage: ${container.zones[<zone-name>].nicSegments[<nic-segment-name>].ingressPolicy}

zones[<zone-name>].nicSegments[<nic-segment-name>].ingressPolicySetRefers to the name of the ingress policy set associated with the edge security profile. The Policy-Set for Ingress traffic is equivalent to the Inbound ACL.

zones[<zone-name>].nicSegments
[<nic-segment-name>].policy

Refers to the name of the policy that is created in the Cisco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the policy.

Usage: ${container.zones[<zone-name>].nicSegments[<nic-segment-name>].policy}

zones[<zone-name>].nicSegments
[<nic-segment-name>].policySet

Refers to the name of the policy set that is created in the CIsco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the policy set.

Usage: ${container.zones[<zone-name>].nicSegments[<nic-segment-name>].policySet}

zones[<zone-name>].nicSegments
[<nic-segment-name>].securityProfile

Refers to the name of the security profile that is created in the Cisco VSG to secure the NIC segment. This substitution parameter is present so that users do not have to remember the naming convention that BMC Network Automation uses to name the security profile.

Usage: ${container.zones[<zone-name>].nicSegments[<nic-segment-name>].securityProfile}

zones[<zone-name>].type

Refers to the type of of the specified zone name

Usage: ${container.zones[<zone-name>].type}

Was this page helpful? Yes No Submitting... Thank you

Comments