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.

BasicAuth

Responses

200

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"
        }
    ],
    "ens_enabled": false,
    "interface_type": "string",
    "interface_id": "string",
    "connected_switch": "string",
    "ens_capable": false,
    "mtu": 0
}

string

source

Optional

Source of status data

Possible values are : realtime, cached,

string

admin_status

Optional

Interface administration status

Possible values are : UP, DOWN,

string

link_status

Optional

Interface administration status

Possible values are : UP, DOWN,

array of NodeInterfaceAlias

interface_alias

Optional

IP Alias

boolean

ens_enabled

Optional

Indicates whether interface is enabled for Enhanced Networking Stack

string

interface_type

Optional

Interface Type

Possible values are : PHYSICAL, VIRTUAL,

string

interface_id

Optional

Interface ID

string

connected_switch

Optional

Connected switch

boolean

ens_capable

Optional

Interface capability for Enhanced Networking Stack

integer As int64 As int64

mtu

Optional

Interface MTU

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error