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

"ComputerSystem" Resource Type

Resource Instances

See Resource Map for more details.

The schema definition of a computer system and its properties. A computer system represents a physical or virtual machine and the local resources, such as memory, CPU, and other devices that can be accessed from that machine.

ComputerSystem resources are members of the Systems collection at /rest/v1/Systems. Each ComputerSystem contains an OEM section with HP-specific properties. Because resource types are used in multiple implementations, not all instances of the ComputerSystem type will contain all the properties listed below.

"ComputerSystem" defines the following properties:

"AssetTag"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

A user-definable tag that is used to track this system for inventory or other client 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.
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:

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

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:

{"Boot": {"BootSourceOverrideEnabled": "Once"}}

The property "Boot/BootSourceOverrideEnabled" on resource type ComputerSystem 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.

"Boot/BootSourceOverrideTarget"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is not Disabled.

JSON type:

String containing one of the following supported values: "None" "Pxe" "Floppy" "Cd" "Usb" "Hdd" "BiosSetup" "Utilities" "Diags" "UefiShell" "UefiTarget"

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:

{"Boot": {"BootSourceOverrideTarget": "Hdd"}}

The property "Boot/BootSourceOverrideTarget" on resource type ComputerSystem 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.

"Boot/UefiTargetBootSourceOverride"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

The UEFI device path of the device to boot from when BootSourceOverrideTarget is UefiTarget.

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:

{"Boot": {"UefiTargetBootSourceOverride": "<string-value>"}}

The property "Boot/UefiTargetBootSourceOverride" on resource type ComputerSystem 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.

"HostCorrelation/HostFQDN"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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.

"HostCorrelation/HostName"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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.

"HostName"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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.

"IndicatorLED"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

The state of the indicator LED.

JSON type:

String containing one of the following supported values: "Unknown" "Lit" "Blinking" "Off"

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:

{"IndicatorLED": "Lit"}

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

"Oem/Hp/DeviceDiscoveryComplete/AMSDeviceDiscovery"

This property is a member of ComputerSystem

This property indicates the current AMS Device Discovery Status.

JSON type:

String containing one of the following supported values:

"Busy" "Complete" "NoAMS" "Initial"

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/DeviceDiscoveryComplete/DeviceDiscovery"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

This property indicates the current device discovery status of devices that are not Smart Array or AMS related.

JSON type:

String containing one of the following supported values: "Busy" "vAuxDeviceDiscoveryComplete" "vMainDeviceDiscoveryComplete" "DataIncomplete" "Initial"

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/DeviceDiscoveryComplete/SmartArrayDiscovery"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

This property indicates the current Smart Array Storage Device Discovery Status

JSON type:

String containing one of the following supported values: "Busy" "PendingSoftwareRAID" "Complete" "Initial"

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/EndOfPostDelaySeconds"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

Supported on UEFI based systems only. The number of seconds to delay before finalizing POST with the Mode action (e.g. delay before shutdown).

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:

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

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": {"PostMode": "PostToShutdown"}}}

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": {"PowerAutoOn": "PowerOn"}}}

The property "Oem/Hp/PowerAutoOn" on resource type ComputerSystem 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/PowerOnDelay"

This property is a member of [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

The PowerAutoOn policy delay that can also be found in the HpBios::PowerOnDelay object. Will be null if PowerAutoOn is set to RemainOff.

JSON type:

String containing one of the following supported values: "Minimum" "15Sec" "30Sec" "45Sec" "60Sec" "RandomUpTo120Sec"

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": {"PowerOnDelay": "45Sec"}}}

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.

POST Action "Reset"

Resets the computer system using one of the listed methods below:

Parameter "ResetType"

"ResetType" must be one of the following value(s):

"On"
"ForceOff"
"ForceRestart"
"Nmi"
"PushPowerButton"

Example

HTTP POST to resource with request JSON:

{ "Action": "Reset", "ResetType": "On"}

POST Action "PowerButton"

The Action to be performed.

Simulates pressing the power button. The PushType parameter simulates a quick button press or a press and hold operation.

Parameter "PushType"

"PushType" must be one of the following value(s):

"Press"
"PressAndHold"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "PowerButton", "PushType": "Press", "Target": "/Oem/Hp"}

POST Action "SystemReset"

The Action to be performed.

Resets the computer system using a cold boot operation.

Parameter "ResetType"

"ResetType" must be one of the following value(s):

"ColdBoot"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "SystemReset", "ResetType": "ColdBoot", "Target": "/Oem/Hp"}

POST Action "ServerSigRecompute"

The Action to be performed.

Causes iLO 4 to recalculate the signature of the computer's configuration. This affects the "ServerSignature" and "ServerSignatureStatus" properties.

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "ServerSigRecompute", "Target": "/Oem/Hp"}

"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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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}

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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, ...]}

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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>"}

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-resource-type)

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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>}}}}

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 [ComputerSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ComputerSystem-Resource-Type)#computersystem-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>}}}

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>}

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.

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

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

"ComputerSystem" Resource Type

Resource Instances

"AssetTag"

HTTP Operations

PATCH Example

"BIOSPOSTCode"

HTTP Operations

"Bios/Current/VersionString"

HTTP Operations

"BiosVersion"

HTTP Operations

"Boot/BootSourceOverrideEnabled"

HTTP Operations

PATCH Example

"Boot/BootSourceOverrideTarget"

HTTP Operations

PATCH Example

"Boot/UefiTargetBootSourceOverride"

HTTP Operations

PATCH Example

"HostCorrelation/HostFQDN"

HTTP Operations

"HostCorrelation/HostName"

HTTP Operations

"HostName"

HTTP Operations

"IndicatorLED"

HTTP Operations

PATCH Example

"Manufacturer"

HTTP Operations

"Memory/Status/Health"

HTTP Operations

"Memory/Status/HealthRollUp"

HTTP Operations

"Memory/Status/HealthRollup"

HTTP Operations

"Memory/Status/State"

HTTP Operations

"Memory/TotalSystemMemoryGB"

HTTP Operations

"MemorySummary/Status/Health"

HTTP Operations

"MemorySummary/Status/HealthRollUp"

HTTP Operations

"MemorySummary/Status/HealthRollup"

HTTP Operations

"MemorySummary/Status/State"

HTTP Operations

"MemorySummary/TotalSystemMemoryGiB"

HTTP Operations

"Model"

HTTP Operations

"Oem/Hp/Battery[]/Condition"

HTTP Operations

"Oem/Hp/Battery[]/ErrorCode"

HTTP Operations

"Oem/Hp/Battery[]/FirmwareVersion"

HTTP Operations

"Oem/Hp/Battery[]/Index"

HTTP Operations

"Oem/Hp/Battery[]/MaxCapWatts"

HTTP Operations

"Oem/Hp/Battery[]/Model"

HTTP Operations

"Oem/Hp/Battery[]/Present"

HTTP Operations

"Oem/Hp/Battery[]/ProductName"

HTTP Operations

"Oem/Hp/Battery[]/SerialNumber"

HTTP Operations

"Oem/Hp/Battery[]/Spare"

HTTP Operations

"Oem/Hp/Bios/Backup/BuildNumber"

HTTP Operations

"Oem/Hp/Bios/Backup/BuildNumberString"

HTTP Operations

"Oem/Hp/Bios/Backup/Date"