Update the Node's Network Interface

Updates the specified interface properties. You cannot change
the properties ip_configuration,
ip_addresses, or plane. NSX
Manager must have a static IP address.
You must use NSX CLI to configure a controller or an edge node.

Request:

Method:

PUT

URI Path(s):

/api/v1/node/network/interfaces/<interface-id>
/api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
/api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NodeNetworkInterfaceProperties+

NodeNetworkInterfaceProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
admin_status	Interface administration status	string	Readonly Enum: up, down
bond_cur_active_slave	Bond's currently active slave device	string	Readonly
bond_lacp_rate	Bond's rate at which we'll ask our link partner to transmit LACPDU packets in 802.3ad mode	string	Readonly
bond_mode	Bond mode	string	Enum: ACTIVE_BACKUP, 802_3AD, ROUND_ROBIN, BROADCAST, XOR, TLB, ALB
bond_primary	Bond's primary device name in active-backup bond mode	string
bond_primary_slave	Bond's primary device name in active-backup bond mode	string	Readonly
bond_slaves	Bond's slave devices	array of string
bond_xmit_hash_policy	Bond's transmit hash policy for balance-xor and 802.3ad modes	string	Readonly Enum: layer2, layer2+3, layer3+4, encap2+3, encap3+4
broadcast_address	Interface broadcast address	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
default_gateway	Interface's default gateway	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id	Interface ID	string	Required Readonly
ip_addresses	Interface IP addresses	array of IPv4AddressProperties	Maximum items: 1
ip_configuration	Interface configuration	string	Required Enum: dhcp, static, not configured
is_kni	Interface is a KNI	boolean	Readonly
link_status	Interface administration status	string	Readonly Enum: up, down
mtu	Interface MTU	integer
physical_address	Interface MAC address	string	Readonly Pattern: "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$"
plane	Interface plane	string	Enum: mgmt, debug, none
vlan	VLAN Id	integer	Readonly Minimum: 1 Maximum: 4094

Example Request:

PUT https://<nsx-mgr>/api/v1/node/network/interfaces/eth0 { "interface_id": "eth0", "mtu": 1600 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeNetworkInterfaceProperties+

NodeNetworkInterfaceProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
admin_status	Interface administration status	string	Readonly Enum: up, down
bond_cur_active_slave	Bond's currently active slave device	string	Readonly
bond_lacp_rate	Bond's rate at which we'll ask our link partner to transmit LACPDU packets in 802.3ad mode	string	Readonly
bond_mode	Bond mode	string	Enum: ACTIVE_BACKUP, 802_3AD, ROUND_ROBIN, BROADCAST, XOR, TLB, ALB
bond_primary	Bond's primary device name in active-backup bond mode	string
bond_primary_slave	Bond's primary device name in active-backup bond mode	string	Readonly
bond_slaves	Bond's slave devices	array of string
bond_xmit_hash_policy	Bond's transmit hash policy for balance-xor and 802.3ad modes	string	Readonly Enum: layer2, layer2+3, layer3+4, encap2+3, encap3+4
broadcast_address	Interface broadcast address	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
default_gateway	Interface's default gateway	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id	Interface ID	string	Required Readonly
ip_addresses	Interface IP addresses	array of IPv4AddressProperties	Maximum items: 1
ip_configuration	Interface configuration	string	Required Enum: dhcp, static, not configured
is_kni	Interface is a KNI	boolean	Readonly
link_status	Interface administration status	string	Readonly Enum: up, down
mtu	Interface MTU	integer
physical_address	Interface MAC address	string	Readonly Pattern: "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$"
plane	Interface plane	string	Enum: mgmt, debug, none
vlan	VLAN Id	integer	Readonly Minimum: 1 Maximum: 4094

Example Response:

{ "admin_status": "up", "broadcast_address": "10.160.31.255", "default_gateway": "10.160.31.253", "interface_id": "eth0", "ip_addresses": [ { "ip_address": "10.160.30.117", "netmask": "255.255.224.0" } ], "ip_configuration": "static", "link_status": "up", "mtu": 1600, "physical_address": "02:00:16:60:c7:8f" }

Update the Node's Network Interface

Request:

NodeNetworkInterfaceProperties (schema)

Example Request:

Successful Response:

NodeNetworkInterfaceProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: