Read Fabric Node Interface

Read Fabric Node Interface

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

Request
URI
GET
https://nsxmanager.your.domain/api/v1/fabric/nodes/{node-id}/network/interfaces/{interface-id}
COPY
Path Parameters
string
node-id
Required

node-id

string
interface-id
Required

interface-id

Query Parameters
string
source
Optional

Data source type.

Possible values are : realtime, cached,
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns NodeInterfaceProperties of type(s) application/json 
{
    "source": "string",
    "admin_status": "string",
    "link_status": "string",
    "interface_alias": [
        {
            "ip_configuration": "string",
            "netmask": "string",
            "ip_address": "string",
            "physical_address": "string",
            "broadcast_address": "string"
        }
    ],
    "interface_type": "string",
    "interface_id": "string",
    "connected_switch": "string",
    "mtu": 0
}
string
source
Optional

Source of status data

Possible values are : realtime, cached,
string
admin_status
Optional

admin_status

Possible values are : UP, DOWN,
string
link_status
Optional

link_status

Possible values are : UP, DOWN,
array of NodeInterfaceAlias
interface_alias
Optional

interface_alias

string
interface_type
Optional

interface_type

Possible values are : PHYSICAL, VIRTUAL,
string
interface_id
Optional

interface_id

string
connected_switch
Optional

connected_switch

integer As int64 As int64
mtu
Optional

mtu


default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Fabric Operations
POST
Add Node
DELETE
Delete Node
GET
Get Fabric Node Modules
GET
Get Fabric Node State
GET
List Fabric Node Interfaces
GET
List Node Capabilities
GET
List Nodes
GET
List Vifs
GET
List Virtual Machines
POST
Perform Host Node Upgrade Action
POST
Perform Node Action
GET
Read Fabric Node Interface
GET
Read Fabric Node Interface Statistics
GET
Read Node
GET
Read Nodes Status
GET
Read Node Status
POST
Restart Inventory Sync
PUT
Update Node
POST
Update Virtual Machine Tags