The vRealize Automation custom properties for networking specify configuration for a specific network device on a machine.
Network assignments are performed during machine allocation. vRealize Automation retrieves network information from the blueprint. If you want to assign more than one network, use the VirtualMachine.NetworkN.Name custom property on your machine blueprint. If you do not provide custom properties, allocation only assigns one network which is picked using a round robin method in conjunction with the selected reservation.
With the exception of the following three properties, the properties in the table do not apply to Amazon Web Services:
- agent.download.url
- software.agent.service.url
- software.ebs.url
For machine components that do not have a Network or Security tab, you can add network and security custom properties, such as VirtualMachine.Network0.Name, to their Properties tab in the design canvas. NSX network, security, and load balancer properties are only applicable to vSphere machines.
By default, a machine has one network device configured with the VirtualMachine.Network0.Name property. You can configure additional network devices by using the VirtualMachine.NetworkN.Name custom property, where N is the network number.
The numbering of network properties must be sequential, starting with 0. For example, if you specify custom properties for only VirtualMachine.Network0 and VirtualMachine.Network2, the properties for VirtualMachine.Network2 are ignored, because the preceding network, VirtualMachine.Network1, was not specified.
Although general support for VMware vCloud ® Networking and Security ™ 5.5.x (vCNS) ended in September 2016, the VCNS custom properties continue to be valid for VMware NSX ™ purposes. See the VMware Knowledge Base article End of Availability and End of General Support for VMware vCloud Networking and Security 5.5.x (2144733) at http://kb.vmware.com/kb/2144733 for more information.
| Custom Property | Description |
|---|---|
| agent.download.url | When using port forwarding, specifies the private IP address of your Amazon AWS tunnel machine and port for your software agent file, for example https://Private_IP:1443/software-service/resources/nobel-agent.jar. You can add this property, in combination with software.agent.service.url and software.ebs.url, to a reservation or the compute resource endpoint. You can also use this property to specify a private address and port when using PAT or NAT and port forwarding. |
| software.agent.service.url | When using port forwarding, specifies the private IP address of your Amazon AWS tunnel machine and port for the vRealize Automation software service API, for example https://Private_IP:1443/software-service/api. You can add this property, in combination with software.ebs.url and agent.download.url, to a reservation or the compute resource endpoint. You can also use this property to specify a private address and port when using PAT or NAT and port forwarding. |
| software.ebs.url | When using port forwarding, specifies the private IP address of your Amazon AWS tunnel machine and port for the vRealize Automation event broker service, for example https://Private_IP:1443/event-broker-service/api. You can add this property, in combination with software.agent.service.url and agent.download.url, to a reservation or the compute resource endpoint. You can also use this property to specify a private address and port when using PAT or NAT and port forwarding. |
| VirtualMachine.NetworkN.Address |
Specifies the IP address of network device N in a machine provisioned with a static IP address. For Amazon, see Amazon.elasticIpAddress.ipAddress. |
| VirtualMachine.NetworkN.MacAddressType |
Indicates whether the MAC address of network device N is generated or user-defined (static). This property is available for cloning. The default value is generated. If the value is static, you must also use VirtualMachine.NetworkN.MacAddress to specify the MAC address. VirtualMachine.NetworkN custom properties are specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation. Because blueprints are not guaranteed to be allocated to a specific reservation, do not use this property on a reservation. This property is not supported for on-demand NAT or on-demand routed networks. |
| VirtualMachine.NetworkN.MacAddress |
Specifies the MAC address of a network device N. This property is available for cloning. If the value of VirtualMachine.NetworkN.MacAddressType is generated, this property contains the generated address. If the value of VirtualMachine.NetworkN.MacAddressType is static, this property specifies the MAC address. For virtual machines provisioned on ESX server hosts, the address must be in the range specified by VMware. For details, see vSphere documentation. VirtualMachine.NetworkN custom properties are specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation. Because blueprints are not guaranteed to be allocated to a specific reservation, do not use this property on a reservation. This property is not supported for on-demand NAT or on-demand routed networks. |
| VirtualMachine.NetworkN.Name |
Specifies the name of the network to connect to, for example the network device N to which a machine is attached. This is equivalent to a network interface card (NIC). By default, a network is assigned from the network paths available on the reservation on which the machine is provisioned. Also see VirtualMachine.NetworkN.AddressType. You can ensure that a network device is connected to a specific network by setting the value of this property to the name of a network on an available reservation. For example, if you give properties for N= 0 and 1, you get 2 NICs and their assigned value, provided the network is selected in the associated reservation. VirtualMachine.NetworkN custom properties are specific to blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation. Because blueprints are not guaranteed to be allocated to a specific reservation, do not use this property on a reservation. You can add this property to a vCloud Air or vCloud Director machine component in a blueprint. This property is not supported for on-demand NAT or on-demand routed networks. |
| VirtualMachine.NetworkN.PortID |
Specifies the port ID to use for network device N when using a dvPort group with a vSphere distributed switch. VirtualMachine.NetworkN custom properties are specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation. Because blueprints are not guaranteed to be allocated to a specific reservation, do not use this property on a reservation. This property is not supported for on-demand NAT or on-demand routed networks. |
| VirtualMachine.NetworkN.ProfileName |
Specifies the name of a network profile from which to assign a static IP address to network device N or from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on. When you use the VirtualMachine.NetworkN.ProfileName property, the network profile it points to is used to allocate an IP address. However, the provisioned machine is attached to any network that is selected in the reservation using a round-robin fashion model. Changing this property value after the network is assigned has no effect on the expected IP address values for the designated machines. With WIM-based provisioning for virtual machines, you can use this property to specify a network profile and network interface or you can use the Network section of the Virtual Reservation page. You can also assign the network interface to a virtual network using the VirtualMachine.NetworkN.Name custom property.
The following attributes of the network profile are available to enable static IP assignment in a cloning blueprint:
VirtualMachine.NetworkN custom properties are specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation. Because blueprints are not guaranteed to be allocated to a specific reservation, do not use this property on a reservation. You cannot use this custom property to define an on-demand NAT or on-demand routed network profile name. Because on-demand network profile names are generated at allocation time (during provisioning), their names are unknown when creating or editing the blueprint. To specify NSX on-demand network information, use the applicable network component in the blueprint design canvas for your vSphere machine components. |
|
Configures attributes of the network profile specified in VirtualMachine.NetworkN.ProfileName. VirtualMachine.NetworkN custom properties are specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation. Because blueprints are not guaranteed to be allocated to a specific reservation, do not use this property on a reservation. |
| VCNS.LoadBalancerEdgePool.Names.name |
Specifies the NSX load balancing pools to which the virtual machine is assigned during provisioning. The virtual machine is assigned to all service ports of all specified pools. The value is an edge/pool name or a list of edge/pool names separated by commas. Names are case-sensitive.
Note:
You can add a machine IP address to an existing load balancer by using the VCNS.LoadBalancerEdgePool.Names custom property. vRealize Automation and NSX use the first member of the specified edge load balancer pool to determine the new member port and monitor port settings. However, NSX 6.2 does not require that the member port setting be specified. To avoid provisioning failure when using VCNS.LoadBalancerEdgePool.Names with NSX 6.2 to add a machine to an existing pool, you must specify a port value for the first member of the load balancer pool in NSX.
Appending a name allows you to create multiple versions of a custom property. For example, the following properties might list load balancing pools set up for general use and machines with high, moderate, and low performance requirements:
|
| VCNS.SecurityGroup.Names.name |
Specifies the NSX security group or groups to which the virtual machine is assigned during provisioning. The value is a security group name or a list of names separated by commas. Names are case-sensitive.
Appending a name allows you to create multiple versions of the property, which can be used separately or in combination. For example, the following properties can list security groups intended for general use, for the sales force, and for support:
|
| VCNS.SecurityTag.Names.name |
Specifies the NSX security tag or tags to which the virtual machine is associated during provisioning. The value is a security tag name or a list of names separated by commas. Names are case-sensitive.
Appending a name allows you to create multiple versions of the property, which can be used separately or in combination. For example, the following properties can list security tags intended for general use, for the sales force, and for support:
|
