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

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

"HpiLOActiveHealthSystem" Resource Type

Resource Instances

/rest/v1/Managers/{item}/ActiveHealthSystem

See Resource Map for more details.

"HpiLOActiveHealthSystem" defines the following properties:

"AHSEnabled"

This property is a member of HpiLOActiveHealthSystem

Determines whether HP Active Health System logging is enabled or disabled.

When this property is enabled by PATCHing the value to true, iLO 4 will respond with "ResetRequired" and iLO 4 must be reset for the setting to take effect. PATCHing the value to false does not require an iLO 4 reset.

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:

{"AHSEnabled": true}

The property "AHSEnabled" on resource type HpiLOActiveHealthSystem 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.

"LocationParameters/case_no"

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

This query parameter may be added to the AHS location URI to insert the case number into the AHS log header. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?downloadAll=1&&case_no=abc123.

JSON type String

HTTP Operations

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

"LocationParameters/co_name"

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

This query parameter may be added to the AHS location URI to insert the company name into the AHS log header. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?downloadAll=1&&co_name=myCompany.

JSON type:
String

HTTP Operations

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

"LocationParameters/contact_name"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
This query parameter may be added to the AHS location URI to insert the contact name into the AHS log header. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?downloadAll=1&&contact_name=JohnDoe.
JSON type:
String

HTTP Operations

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

"LocationParameters/downloadAll"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
This query parameter should be used to download entire AHS log. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?downloadAll=1.
JSON type:
String

HTTP Operations

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

"LocationParameters/email"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
This query parameter may be added to the AHS location URI to insert the contacts email address into the AHS log header. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?downloadAll=1&&[email protected].
JSON type:
String

HTTP Operations

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

"LocationParameters/from"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
This query parameter may be added with the 'to' query parameter to the AHS location URI to limit the range of data returned. The default range is the last seven days of the log and the format is (yyyy-mm-dd). 'downloadAll' parameter should not be used with this query parameter. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?from=2014-03-01&&to=2014-03-30.
JSON type:
String

HTTP Operations

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

"LocationParameters/phone"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
This query parameter may be added to the AHS location URI to insert the contacts phone number into the AHS log header. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?downloadAll=1&&contact_name=JohnDoe&&phone=555-555-5555.
JSON type:
String

HTTP Operations

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

"LocationParameters/to"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
This query parameter may be added with the 'from' query parameter to the AHS location URI to limit the range of data returned. The default range is the last seven days of the log and the format is (yyyy-mm-dd). 'downloadAll' parameter should not be used with this query parameter. For example, http://iloname.example.net/ahsdata/HP_xxxxxxxxxx_20140821.ahs?from=2014-03-01&&to=2014-03-30.
JSON type:
String

HTTP Operations

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

"links/AHSLocation/extref"

This property is a member of [HpiLOActiveHealthSystem](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOActiveHealthSystem-Resource-Type)#----------hpiloactivehealthsystem-resource-type--------)
The URI of an external resource.
JSON type:
String

HTTP Operations

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

POST Action "ClearLog"

Clears the Active Health System Log. When this action is invoked, iLO 4 will respond with "ResetRequired" and iLO 4 must be reset for the setting to take effect.

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearLog"}
⚠️ **GitHub.com Fallback** ⚠️