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

"EthernetNetworkInterface" Resource Type

Resource Instances

/rest/v1/Managers/{item}/EthernetInterfaces/{item}

See Resource Map for more details.

The schema definition of a simple Ethernet NIC resource.

"EthernetNetworkInterface" defines the following properties:

"Autosense"

This property is a member of EthernetNetworkInterface

The autosense speed/duplex enabled or disabled. Autosense can only be disabled if the SpeedMbps and FullDuplex values are specified. Autosense is only applicable and modifiable for a dedicated network port and cannot be modified for blade servers.
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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Autosense": true}

The property "Autosense" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"FQDN"

This property is a member of EthernetNetworkInterface

The complete, fully qualified domain name obtained by DNS for this NIC.
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.

"FactoryMacAddress"

This property is a member of EthernetNetworkInterface

The MAC address assigned to the NIC at the factory.
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.

"FrameSize"

This property is a member of EthernetNetworkInterface

The MAC frame size (bytes).
JSON type:
Integer greater than or equal to 0.

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"FrameSize": <integer-value>}

The property "FrameSize" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"FullDuplex"

This property is a member of EthernetNetworkInterface

The connection duplex status. If Autosense is enabled, this property cannot be modified. Autosense is only applicable and modifiable for a dedicated network port and cannot be modified for blade servers.
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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"FullDuplex": true}

The property "FullDuplex" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HostName"

This property is a member of EthernetNetworkInterface

The DNS Host Name, without any domain information.
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.

"IPv4Addresses[]/Address"

This property is a member of EthernetNetworkInterface

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv4Addresses": [{"Address": "<string-value>"}|null, ...]}

The property "IPv4Addresses[]/Address" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv4Addresses[]/AddressOrigin"

This property is a member of EthernetNetworkInterface

How the address was determined.
JSON type:
String containing one of the following supported values:
"DHCP"
"Static"

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.

"IPv4Addresses[]/Gateway"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv4 gateway for this 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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv4Addresses": [{"Gateway": "<string-value>"}|null, ...]}

The property "IPv4Addresses[]/Gateway" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv4Addresses[]/SubnetMask"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv4 Subnet mask.
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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv4Addresses": [{"SubnetMask": "<string-value>"}|null, ...]}

The property "IPv4Addresses[]/SubnetMask" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6AddressPolicyTable[]/Label"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The label value for this table entry, as defined in RFC3484 section 2.1.
JSON type:
Integer from 0 to 100.

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6AddressPolicyTable": [{"Label": <integer-value>}|null, ...]}

The property "IPv6AddressPolicyTable[]/Label" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6AddressPolicyTable[]/Precedence"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The precedence value for this table entry as defined in RFC3484 section 2.1.
JSON type:
Integer from 1 to 100.

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6AddressPolicyTable": [{"Precedence": <integer-value>}|null, ...]}

The property "IPv6AddressPolicyTable[]/Precedence" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6AddressPolicyTable[]/Prefix"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv6 Address Prefix for this table entry as defined in RFC3484 section 2.1.
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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6AddressPolicyTable": [{"Prefix": "<string-value>"}|null, ...]}

The property "IPv6AddressPolicyTable[]/Prefix" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6Addresses[]/Address"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
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.

"IPv6Addresses[]/AddressOrigin"

This property is a member of EthernetNetworkInterface

How the address was determined.
JSON type:
String containing one of the following supported values: "DHCP" "Static" "SLAAC"

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.

"IPv6Addresses[]/AddressState"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The current state of this address as defined in RFC 4862.
JSON type:
String containing one of the following supported values: "Preferred" "Deprecated" "Tentative" "Failed"

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.

"IPv6Addresses[]/PrefixLength"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv6 Address Prefix Length.
JSON type:
Integer from 1 to 128.

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.

"IPv6DefaultGateway"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv6 default gateway address that is currently in use on this interface.
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.

"IPv6StaticAddresses[]/Address"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
A valid 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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6StaticAddresses": [{"Address": "<string-value>"}|null, ...]}

The property "IPv6StaticAddresses[]/Address" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6StaticAddresses[]/PrefixLength"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The Prefix Length of this IPv6 address.
JSON type:
Integer from 1 to 128.

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6StaticAddresses": [{"PrefixLength": <integer-value>}|null, ...]}

The property "IPv6StaticAddresses[]/PrefixLength" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"LinkTechnology"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The link technology, such as Ethernet, for this NIC.
JSON type:
String containing one of the following supported values: "Ethernet"

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.

"MacAddress"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The effective current MAC address. If the assignable MAC address is not supported, this is a read-only alias of FactoryMacAddress.
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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"MacAddress": "<string-value>"}

The property "MacAddress" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"MaxIPv6StaticAddresses"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The maximum number of IPv6 static addresses that can be configured on this interface.
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.

"Oem/Hp/ConfigurationSettings"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The state of the currently displayed configuration settings.
JSON type:
String containing one of the following supported values: "Current" "SomePendingReset"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/DHCPv4/Enabled"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether DHCPv4 is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"Enabled": true}}}}

The property "Oem/Hp/DHCPv4/Enabled" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseDNSServers"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use DHCPv4-supplied DNS servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseDNSServers": true}}}}

The property "Oem/Hp/DHCPv4/UseDNSServers" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseDomainName"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use a DHCPv4-supplied domain name. Can only be enabled when DHCPv4 is also enabled; otherwis,e this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseDomainName": true}}}}

The property "Oem/Hp/DHCPv4/UseDomainName" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseGateway"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use a DHCPv4-supplied gateway. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseGateway": true}}}}

The property "Oem/Hp/DHCPv4/UseGateway" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseNTPServers"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use DHCPv4-supplied NTP servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseNTPServers": true}}}}

The property "Oem/Hp/DHCPv4/UseNTPServers" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseStaticRoutes"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use DHCPv4-supplied static routes. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseStaticRoutes": true}}}}

The property "Oem/Hp/DHCPv4/UseStaticRoutes" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseWINSServers"

This property is a member of EthernetNetworkInterface

Determines whether to use DHCPv4-supplied WINS servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseWINSServers": true}}}}

The property "Oem/Hp/DHCPv4/UseWINSServers" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/StatefulModeEnabled"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether DHCPv6 Stateful mode is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"StatefulModeEnabled": true}}}}

The property "Oem/Hp/DHCPv6/StatefulModeEnabled" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/StatelessModeEnabled"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether DHCPv6 Stateless mode is enabled. Always enabled by default whenever DHCPv6 Stateful mode is also enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"StatelessModeEnabled": true}}}}

The property "Oem/Hp/DHCPv6/StatelessModeEnabled" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseDNSServers"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use DHCPv6-supplied DNS servers. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseDNSServers": true}}}}

The property "Oem/Hp/DHCPv6/UseDNSServers" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseDomainName"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use a DHCPv6-supplied domain name. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseDomainName": true}}}}

The property "Oem/Hp/DHCPv6/UseDomainName" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseNTPServers"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use DHCPv6-supplied NTP servers. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to false and will be read-only.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseNTPServers": true}}}}

The property "Oem/Hp/DHCPv6/UseNTPServers" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseRapidCommit"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to use DHCPv6 rapid commit mode. Can only be enabled when DHCPv6 Stateful mode is also enabled; otherwise, this property will be set to false and will be read-only. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseRapidCommit": true}}}}

The property "Oem/Hp/DHCPv6/UseRapidCommit" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DomainName"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Domain name of the network to which this management processor belongs. This property can only be modified when the management processor is not configured to use a DHCP supplied domain name; otherwise this property is read-only indicating the value is provided by DHCP.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DomainName": "<string-value>"}}}

The property "Oem/Hp/DomainName" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/HostName"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The management processor host name.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"HostName": "<string-value>"}}}

The property "Oem/Hp/HostName" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/DDNSRegistration"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether DDNS registration is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"DDNSRegistration": true}}}}

The property "Oem/Hp/IPv4/DDNSRegistration" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/StaticRoutes[]/Destination"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
An IPv4 static route destination. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"StaticRoutes": [{"Destination": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/Destination" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/StaticRoutes[]/Gateway"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
An IPv4 static route gateway. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"StaticRoutes": [{"Gateway": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/Gateway" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/StaticRoutes[]/SubnetMask"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
An IPv4 static route subnet mask. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"StaticRoutes": [{"SubnetMask": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/SubnetMask" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/WINSRegistration"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether WINS registration is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"WINSRegistration": true}}}}

The property "Oem/Hp/IPv4/WINSRegistration" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/DDNSRegistration"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether IPv6 DDNS registration is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"DDNSRegistration": true}}}}

The property "Oem/Hp/IPv6/DDNSRegistration" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/SLAACEnabled"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether StateLess Address Auto-Configuration is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"SLAACEnabled": true}}}}

The property "Oem/Hp/IPv6/SLAACEnabled" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticDefaultGateway"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv6 static default gateway entry.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticDefaultGateway": "<string-value>"}}}}

The property "Oem/Hp/IPv6/StaticDefaultGateway" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/Destination"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv6 static route destination address.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticRoutes": [{"Destination": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv6/StaticRoutes[]/Destination" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/Gateway"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The IPv6 static route gateway.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticRoutes": [{"Gateway": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv6/StaticRoutes[]/Gateway" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/PrefixLength"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The prefix length of the IPv6 static route destination address.
JSON type:
Integer from 1 to 128.

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticRoutes": [{"PrefixLength": <integer-value>}|null, ...]}}}}

The property "Oem/Hp/IPv6/StaticRoutes[]/PrefixLength" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/Status"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Status of this static route entry.
JSON type:
String containing one of the following supported values: "Unknown" "Pending" "Active" "Failed"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/NICEnabled"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether this NIC is enabled or disabled. Enabling one NIC will disable the others. If no NIC is enabled, this management processor is not accessible over the network.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"NICEnabled": true}}}

The property "Oem/Hp/NICEnabled" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/NICSupportsIPv6"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates whether or not this NIC can support the IPv6 protocol.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/PingGatewayOnStartup"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether to ping the IPv4 gateway on startup.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"PingGatewayOnStartup": true}}}

The property "Oem/Hp/PingGatewayOnStartup" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SharedNetworkPortOptions/NIC"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Selects the system NIC that is to be shared with this management processor.
JSON type:
String containing one of the following supported values: "LOM" "FlexibleLOM"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SharedNetworkPortOptions": {"NIC": "FlexibleLOM"}}}}

The property "Oem/Hp/SharedNetworkPortOptions/NIC" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SharedNetworkPortOptions/Port"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.
JSON type:
Integer from 1 to 2.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SharedNetworkPortOptions": {"Port": <integer-value>}}}}

The property "Oem/Hp/SharedNetworkPortOptions/Port" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SupportsFlexibleLOM"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates whether this system supports FlexibleLOM. Only applies to Shared Network Port.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/SupportsLOM"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates whether this system supports LOM. Only applies to Shared Network Port.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/VLANEnabled"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Determines whether VLAN is enabled. Only applies to Shared Network Port.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"VLANEnabled": true}}}

The property "Oem/Hp/VLANEnabled" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/VLANId"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The VLAN ID/tag. Only applies to Shared Network Port.
JSON type:
Integer from 1 to 4094.

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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"VLANId": <integer-value>}}}

The property "Oem/Hp/VLANId" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SettingsResult/ETag"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
ETag of this resource after the settings have been applied.
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.

"SettingsResult/Messages[]/Message"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Human-readable message.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/Messages[]/MessageID"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Key for this message, which is used to look up the message in a message registry. The key is in the format <registry>.<majorver>.<minorver>:<messagekey>.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/Messages[]/Resolution"

This property is a member of EthernetNetworkInterface

Instructions for resolving the issue that caused the error.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/Messages[]/Severity"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
This is the severity of the errors.
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.

"SettingsResult/Operation"

This property is a member of EthernetNetworkInterface

Details about the results of applying the settings.
JSON type:
String containing one of the following supported values: "SettingsApply"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/Time"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Time at which the settings were applied.
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.

"SpeedMbps"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The link speed of the Ethernet interface. If Autosense is enabled, this property cannot be modified. This property can only be modified on a dedicated network port. It cannot be modified for blade servers.
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.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SpeedMbps": <integer-value>}

The property "SpeedMbps" on resource type EthernetNetworkInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates the health state of this resource without considering 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.

"Status/HealthRollUp"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates the known state of this resource (for example, if the resource is enabled). Enabled indicates that the resource is available. Disabled indicates that the resource has been made unavailable intentionally, but it can be enabled. Offline indicates that the resource is unavailable intentionally and requires action to be made available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates that the resource is physically unavailable.
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.

"UEFIDevicePath"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The UEFI device path for this NIC.
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.

"VLANEnable"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
Indicates if VLANs are enabled. If this NIC supports more than one VLAN, this property will not be present and the client should look for VLANs collection in the link section of this resource.
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.

"VLANId"

This property is a member of [EthernetNetworkInterface](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EthernetNetworkInterface-Resource-Type)#ethernetnetworkinterface-resource-type)
The VLAN identifier for this NIC. The VLANId is only present when the VLANEnable is used and when the NIC supports only a single VLAN.
JSON type:
Integer from 0 to 4095.

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** ⚠️