Get

/nicports/{id}/

This endpoint returns details of a specified NIC Port.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Responses

200

object

id

integer

NIC port ID

guid

string

NIC port GUID

name

string

NIC port name

state

string

NIC Port state

sn

string

NIC port serial number

model

string

NIC port model

cluster

string

Parent cluster

cluster_id

integer

Parent cluster ID

title

string

NIC port title

display_name

string

NIC port display name

fw_version

string

NIC port firmware version

interface

string

NIC Port interface name

address

string

NIC Port address

enabled

boolean

Whether the NIC Port is enabled

external

boolean

Whether the NIC Port is external

host_id

integer

ID of the host the NIC Port belongs to

port_membership

string

Port membership

failure_reason

string

Reason for port failure if in FAILED state

Return Details of a NIC Port