Developer Documentation


Information on the Network interfaces present on the partner appliance that needs to be configured by the NSX Manager.


Required Property Name Type Description
required interface_index integer

Network Interface index.

required interface_label string

Network Interface label.

required interface_type string

Interface that needs to be configured on the partner appliance. Ex. MANAGEMENT, DATA1, DATA2, HA1, HA2, CONTROL.

optional transports array of string

Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP. Here, the transports array specifies the kinds of transport where this particular NIC is user configurable. If nothing is specified, and the “user_configurable” flag is true, then user configuration will be allowed for all transports. If any transport is/are specified, then it will be considered as user configurable for the specified transports only.”

optional user_configurable boolean

Used to specify if the given interface needs configuration. Management nics will always need the configuration, for others it will be use case specific. For example, a DATA NIC may be user configurable if the appliance is deployed in certain mode, such as L3_ROUTED.

Property of


Was this page helpful?