You can define an on-demand NSX load balancer component to distribute task processing among provisioned vSphere member machines or container machines in a network.

When you add a load balancer component to a blueprint in the design canvas, you can choose either a default or custom option when creating or editing your virtual server definitions in the load balancer component. The default option allows you to specify the virtual server protocol, port, and description and use defaults for all other settings. The custom option allows you to define additional levels of detail.

If the load balancer is provisioned with an external network, the VIP (specified with VIP Network) and member pool (specified with Member Network) must be on the same existing network. If the VIP and pool are not on the same external network, an error occurs during provisioning.


  • Create and configure load balancer settings for NSX. See Checklist for Preparing NSX Network and Security Configuration and NSX Administration Guide.

  • Verify that the NSX inventory has executed successfully for your cluster.

    To use NSX configurations in vRealize Automation, you must run data collection.

  • Create a network profile. See Creating a Network Profile.

  • Log in to the vRealize Automation console as an infrastructure architect.

  • Open a new or existing blueprint in the design canvas by using the Design tab.

  • Verify that at least one vSphere machine component or container component exists in the blueprint.


  1. Click Network & Security in the Categories section to display the list of available network and security components.
  2. Drag an On-Demand Load Balancer component onto the design canvas.
  3. Enter a component name in the ID text box to uniquely label the component in the design canvas.
  4. Select a vSphere machine component or container component name from the Member drop-down menu.

    The list contains only the vSphere machine components and container components in the active blueprint.

  5. Select the NIC to load balance from the Member network drop-down menu.

    The list contains NICs that are defined for the selected vSphere machine member.

  6. Select an available virtual IP address network from the VIP Network drop-down menu. For example, select an available external or NAT network.

    While you can have multiple NSX load balancer and NSX on-demand network components in a blueprint, they must all be associated to the same VIP network.

  7. (Optional) Enter a valid IP address for the NIC in the IP Address text box.

    The default setting is the static IP address that is associated with the VIP network. You can specify another IP address or an IP address range. By default, the next available IP address is allocated from the associated VIP network.

    Leave the IP address field empty to allow the IP address to be allocated from the associated VIP network during provisioning.

    You can only specify an IP address when the VIP is created on a NAT network.

  8. To create a virtual server definition, click New and see Define Virtual Server General Settings.

    Each load balancer component requires at least one virtual server.

    To specify logging options, see Define Load Balancer Logging Options.