The Edge workflows are used to create and manage Edge configurations. You can access the workflows from Library > NSX > Edge Features on the Workflows view in the Orchestrator client. You can run these workflows from the Run and Design modes.

Table 1. Edge Features Workflows
Workflow Description
Add Interface

Use this workflow to add an interface to an NSX Edge.

To run this workflow, complete the following parameters:

  • Select the NSX Connection object (NSX endpoint).
  • Select the NSX Edge object.
  • Enter the name of the interface.
  • Enter the index of the router interface.
  • Enter the logical switch or the Network or Portgroup connected to the interface.
  • Enter the IP address specification of the interface.
  • Enter the type of interface (uplink, internal, trunk).
  • Enter the MTU value.
  • Choose whether to indicate if the interface is connected.
Compose Edge

Use this workflow to create a service edge (ESG) on NSX. This workflow completes only after the Edge is successfully created and configured in NSX.

To run this workflow, complete the following parameters:

  • Enter the common parameters.
  • Select the appliances.
  • Enter the Edge vNICs.
  • Enter the CLI settings.
  • Enter the default gateway settings.
  • Enter the HA settings.
  • Enter Syslog settings.
Configure Appliance Size

Use this workflow to configure the size of the NSX Edge appliance (or both appliances if HA). Typical sizes are compact, large, x-large and quad-large.

To run this workflow, complete the following parameters:

  • NSX Connection object.
  • NSX Edge object.
  • Enter the appliance size (compact, large or x-large).
Configure Default Gateway

Use this workflow to configure the default gateway.

To run this workflow, complete the following parameters:

  • Select the NSX Connection endpoint.
  • Select the NSX Edge object.
  • Enter the NSX Edge vNIC index.
  • Enter the IP address of the gateway.
  • Enter the MTU value.
  • Enter a description of the gateway.
Configure Edge Appliance

Use this workflow to configure the size of the NSX Edge appliance (or both appliances if HA). Typical sizes are compact, large, x-large and quad-large.

To run this workflow, complete the following parameters:

  • Choose whether you want to deploy appliances.
  • Enter the HA index.
  • Enter the IDs of the resource pool or cluster, datastore, host and VM folder.
Configure Edge CLI Settings

Use this workflow to configure the CLI settings on the edge.

To run this workflow, complete the following parameters:

  • Enter a user name and password for CLI access.
  • Choose whether to enable SSH and auto rule generation.
  • Enter the log level values.
Configure Edge Syslog

Use this workflow to configure syslog servers for an NSX Edge.

To run this workflow, complete the following parameters:

  • Enter the protocol.
  • Enter the server IP address of the syslog servers.
Configure HA

Use this workflow to configure HA (High Availability) settings on the NSX Edge. This workflow completes only after the HA is successfully configured on NSX.

To run this workflow, complete the following parameters:

  • Select the NSX Connection object.
  • Select NSX Edge object.
  • Choose whether to enable HA.
  • Set a declared dead time (time to listen for a heartbeat). The default value is 15 seconds.
  • Select the management IP addresses (must be in CIDR format with /30 subnet and must not overlap with any vNIC subnets).
  • Choose whether to enable logging.
  • Enter the log level. Typical values are Emergency, Alert, Critical, Error, Warning, Notice and Debug. The default value is Info.
Delete Interface

Use this workflow to delete an NSX Edge interface.

To run this workflow, complete the following parameters:

  • Select the NSX Connection object.
  • Select the NSX Edge object.
  • Enter the NSX Edge vNIC or interface to be deleted (inventory selection).
  • Enter the NSX Edge vNIC or interface index to be deleted (user-provided index).
    Note: The interface index is ignored if the interface to be deleted is selected.
Get Edge

Use this workflow to return the NSX Edge inventory object.

To run this workflow, complete the following parameters:

  • Select the NSX Edge object.
Get Interface

Use this workflow to return an edge interface from inventory.

To run this workflow, complete the following parameters:

  • Select the NSX Connection object.
  • Select the NSX Edge object.
  • Select the NSX Edge vNIC (inventory selection).
  • Select the NSX Edge vNIC Index (user-provided index).
Note: The vNIC Index is ignored if the Edge vNIC is selected.
Modify Interface

Use this workflow to modify an interface of an NSX Edge.

To run this workflow, complete the following parameters:

  • Select the NSX Connection object.
  • Select the NSX Edge object.
  • Select the NSX Edge Interface to be modified (inventory selection).
  • Select the NSX Edge Interface Index to be modified (user-provided index).
Note: The NSX Edge Interface Index is ignored if NSX Edge Interface is selected.
  • Enter the name of the interface.
  • Enter the logical switch or the Network or Portgroup connected to the interface.
  • Enter the IP address specification for the interface.
  • Enter the type of interface (uplink, internal or trunk).
  • Enter the MTU value.
  • Choose whether to indicate if the interface is connected.
Redeploy Edge

Use this workflow to redeploy an NSX Edge.

To run this workflow, complete the following parameters:

  • Select the NSX Connection object.
  • Select the NSX Edge object.
Update Edge

Use this workflow to update a service edge (ESG) on NSX. This workflow completes only after the NSX Edge has been successfully updated and configured in NSX.

To run this workflow, complete the following parameters:
  • Enter the common parameters.
  • Select the appliances.
  • Select the interface.
  • Enter the CLI settings.
  • Enter the default gateway settings.
  • Enter the HA settings.
  • Enter the Syslog settings.