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

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

"AccountService" Resource Type

Resource Instances

/rest/v1/AccountService

See Resource Map for more details.

This is the schema definition for the Account service. It represents the properties for this service and has links to the list of accounts.

You may create an iLO account by building a request JSON object of type ManagerAccount and POSTing it to the Collection pointed to by the "Accounts" link. For Example:

POST {"UserName": "newuser", "Password": "newpassword", "Oem": {"Hp": {"Privileges": {"RemoteConsolePriv": true, "VirtualMediaPriv": true, "UserConfigPriv": true, "iLOConfigPriv": true, "VirtualPowerAndResetPriv": true}, "LoginName": "newuser"}}}

"AccountService" defines the following properties:

"Oem/Hp/AuthFailureDelayTimeSeconds"

This property is a member of AccountService

The time in seconds to delay after AuthFailuresBeforeDelay+1 authentication attempts have failed. Values of 2, 5, 10, and 30 seconds are valid.
JSON type:
Integer

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": {"AuthFailureLoggingThreshold": <integer-value>}}}

The property "Oem/Hp/AuthFailureLoggingThreshold" on resource type AccountService 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/AuthFailureLoggingThreshold"

This property is a member of AccountService

This property enables you to view and configure logging criteria for failed authentications. A failed login log entry is recorded after the configured number of attempts. 0 = feature disabled; 1-3 and 5 are allowable values.

"AuthFailureLoggingThreshold" may be PATCHed to the values 0, 1, 2, 3, or 5. The value of 4 is not supported by iLO 4.

JSON type:
Integer

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": {"AuthFailureLoggingThreshold": <integer-value>}}}

The property "Oem/Hp/AuthFailureLoggingThreshold" on resource type AccountService 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/AuthFailuresBeforeDelay"

This property is a member of AccountService

The number of failed authentication attempts allowed before authentication is delayed by AuthFailureDelayTimeSeconds. Values of 0, 1, 3, and 5 are valid, with 0 indicating delay after each authentication failure.
JSON type:
Integer

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": {"AuthFailuresBeforeDelay": <integer-value>}}}

The property "Oem/Hp/AuthFailuresBeforeDelay" on resource type AccountService 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/MinPasswordLength"

This property is a member of AccountService

This property specifies the minimum number of characters allowed when a user password is set or changed. It must be a value from 0 to 39.
JSON type:
Integer from 0 to 39.

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": {"MinPasswordLength": <integer-value>}}}

The property "Oem/Hp/MinPasswordLength" on resource type AccountService 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.

⚠️ **GitHub.com Fallback** ⚠️