Skip to main content

GET – Dedicated network port properties

Use the GET method to retrieve properties in DedicatedNetworkPorts resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/DedicatedNetworkPorts/{Id}

Request body​

None

Response body​

Field

Type

Description

Id

String

“nic1” or “nic2”

Description

String

A Dedicated Network Port represents a dedicated discrete physical port capable of connecting to a network.

Name

String

Dedicated Network Port X (X = the Id value)

Ethernet

Object

Expanded.

 

LLDPEnabled

Boolean

Enable or disable LLDP globally for an adapter.

 

LLDPTransmit

Object

Expanded.

  

ChassisId

String

Link Layer Data Protocol (LLDP) chassis ID.

  

ChassisIdSubtype

String

The type of identifier used for the chassis ID.

  

ManagementVlanId

String

The management VLAN ID to be transmitted from this endpoint.

  

ManagementAddressIPv4

String

The IPv4 management address to be transmitted from this endpoint.

  

ManagementAddressIPv6

String

The IPv6 management address to be transmitted from this endpoint.

  

ManagementAddressMAC

String

The management MAC address to be transmitted from this endpoint.

  

PortId

String

A colon-delimited string of hexadecimal octets identifying a port to be transmitted from this endpoint.

  

PortIdSubtype

String

The port ID subtype to be transmitted from this endpoint.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#Port.Port",
    "@odata.etag": "\"00A1F15E\"",
    "@odata.id": "/redfish/v1/Managers/1/DedicatedNetworkPorts/nic1",
    "@odata.type": "#Port.v1_8_0.Port",
    "Description": "A Dedicated Network Port represents a dedicated discrete physical                     port capable of connecting to a network.",
    "Ethernet": {
        "AssociatedMACAddresses": [
            "c4:c6:e6:88:bf:b6"
        ],
        "LLDPEnabled": true,
        "LLDPReceive": {
            "ChassisId": "",
            "ManagementAddressIPv4": null,
            "ManagementAddressMAC": null,
            "SystemDescription": "",
            "SystemName": ""
        },
        "LLDPTransmit": {
            "ChassisId": "c4:c6:e6:88:bf:b6",
            "ChassisIdSubtype": "MacAddr",
            "ManagementAddressIPv4": "10.245.22.181",
            "ManagementAddressIPv6": "fec0:bd02::c6c6:e6ff:fe88:bfb6",
            "ManagementAddressMAC": "c4:c6:e6:88:bf:b6",
            "ManagementVlanId": 1,
            "PortId": "eth1",
            "PortIdSubtype": "LocalAssign"
        }
    },
    "Id": "nic1",
    "Name": "Dedicated Network Port 1",
    "Oem": {
        ...
        }
    }
}