iLO 4 REST API Data Model (BaseNetworkAdapter Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki

HP RESTful API Data Model Reference for iLO 4—Redfish 1.0 Conformance (Cont)

"BaseNetworkAdapter" Resource Type

Resource Instances

/rest/v1/AccountService

See Resource Map for more details.

"BaseNetworkAdapter" defines the following properties:

"Firmware/Current/VersionString"

This property is a member of BaseNetworkAdapter

This string represents the version of the firmware image.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PartNumber"

This property is a member of BaseNetworkAdapter

The device part number.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/FullDuplex"

This property is a member of BaseNetworkAdapter

Full-duplex data transmission means that data can be transmitted in both directions on a signal carrier at the same time.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/IPv4Addresses[]/Address"

This property is a member of BaseNetworkAdapter

This is the IPv4 Address.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/IPv6Addresses[]/Address"

This property is a member of BaseNetworkAdapter

This is the IPv6 Address.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/MacAddress"

This property is a member of BaseNetworkAdapter

The port MAC address.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Oem/Hp/BadReceives"

This property is a member of BaseNetworkAdapter

A count of frames that were received by the adapter but which had an error. This counter is the sum of mib items cpqNicIfPhysAdapterAlignmentErrors, cpqNicIfPhysAdapterFCSErrors, cpqNicIfPhysAdapterFrameTooLongs, and cpqNicIfPhysAdapterInternalMacReceiveErrors. If this counter increments frequently, check the more detailed error statistics and take appropriate action.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Oem/Hp/BadTransmits"

This property is a member of BaseNetworkAdapter

A count of frames that were not transmitted by the adapter because of an error. This counter is the sum of MIB items cpqNicIfPhysAdapterDeferredTransmissions, cpqNicIfPhysAdapterLateCollisions, cpqNicIfPhysAdapterExcessiveCollisions, cpqNicIfPhysAdapterCarrierSenseErrors, and cpqNicIfPhysAdapterInternalMacTransmitErrors. If this counter increments frequently, check the more detailed error statistics and take appropriate action.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Oem/Hp/GoodReceives"

This property is a member of BaseNetworkAdapter

A count of frames successfully received by the physical adapter.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Oem/Hp/GoodTransmits"

This property is a member of BaseNetworkAdapter

A count of frames successfully transmitted by the physical adapter.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Oem/Hp/StructuredName"

This property is a member of BaseNetworkAdapter

PCI device structured name in UTF-8 format (e.g. 'NIC.LOM.1.1' - see PCIDevices in /rest/v1/Systems/x/PCIDevices - this comes from SMBIOS
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Oem/Hp/Team"

This property is a member of BaseNetworkAdapter

If a port is configured for NIC teaming, the name of the configured link between the physical ports that form a logical network adapter. This value is displayed for system NICs only (embedded and stand-up).
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/SpeedMbps"

This property is a member of BaseNetworkAdapter

An estimate of the interface's current bandwidth in Megabits per second. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/Health"

This property is a member of BaseNetworkAdapter

This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values:

"OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/HealthRollUp"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/HealthRollup"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/State"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This indicates the known state of the resource, such as if it is enabled.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled" "Offline" "InTest" "Starting" "Absent"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/UEFIDevicePath"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
UEFIDevice Path for correlation purposes
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialNumber"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
The device serial number.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values: "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
This indicates the known state of the resource, such as if it is enabled.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled" "Offline" "InTest" "Starting" "Absent"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"StructuredName"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
PCI device structured name in UTF-8 format (e.g. 'NIC.LOM.1.1' - see PCIDevices in /rest/v1/Systems/x/PCIDevices - this comes from SMBIOS
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"UEFIDevicePath"

This property is a member of [BaseNetworkAdapter](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(BaseNetworkAdapter-Resource-Type)#basenetworkadapter-resource-type)
UEFIDevice Path for correlation purposes
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
⚠️ **GitHub.com Fallback** ⚠️