NicMetadata

NicMetadata
NicMetadata

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

JSON Example
{
    "interface_index": 0,
    "interface_label": "string",
    "interface_type": "string",
    "transports": [
        "string"
    ],
    "user_configurable": false
}
integer As int64 As int64
interface_index
Required

Network Interface index.

string
interface_label
Required

Network Interface label.

string
interface_type
Required

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

Possible values are : MANAGEMENT, DATA1, DATA2, HA1, HA2, CONTROL,
array of string
transports
Optional

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."

Possible values are : L2_BRIDGE, L3_ROUTED, NSH,
boolean
user_configurable
Optional

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.