Skip to main content

GET – HostBootStrap account properties

Use the GET method to retrieve properties in HostBootStrap Account resource for Redfish service. HostBootStrap account follows DMTF defined “Redfish Host Interface Specification” to implement, please refer to DSP0270_1.3.0 for how to create it and more details.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/AccountService/Accounts/HostBootStrap

Request body​

None

Response body​

FieldTypeDescription

Name

String“Host Boot Strap Account”

Id

String“HostBootStrap”

Password

StringThe password of the account. Display null on a GET.

RoleId

StringThe value of this property is the ID of the Role resource that configured for this account.

Enabled

BooleanIndicates if this account is enabled.

PasswordChangeRequired

Boolean

The value of this property is true if the password for this account must be changed before further access is allowed.

Always set to false.

PasswordExpiration

String

This property indicates the date and time when this account password expires. If the value is null, the account password never expires.

Always set to null.

UserName

StringThe value of this property is the user name for this account.

Locked

BooleanThis property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. When set to true, the account is locked. The account service will unlock it once the lockout duration period has passed.

Description

StringThis resource is used to represent an account for the manager for a Redfish implementation.

Links

ObjectExpand
 

Role

LinkLink to the Role instance which this account is mapped to.

AccountTypes

Array

This property contains an array of the various manager services that the account is allowed to access.

Items: string

Item count: 5

 

AccountTypes[N]

String“Redfish”, “SNMP”, “ManagerConsole”, “IPMI”, “WebUI”

AccountTypes@Redfish. AllowableValues

Array

Items: string

Item count: 5

 

AccountTypes@Redfish. AllowableValues[N]

String[“Redfish”, “SNMP”, “ManagerConsole”, “IPMI”, “WebUI”]

HostBootstrapAccount

Boolean

Indicates whether this account is a bootstrap account for the host interface.

Always set to true.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "RoleId": "Administrator",
    "PasswordChangeRequired": false,
    "AccountTypes@Redfish.AllowableValues": [
        "WebUI",
        "Redfish",
        "ManagerConsole",
        "IPMI",
        "SNMP"
    ],
    "Description": "This resource is used to represent an account for the manager for a Redfish implementation.",
    "PasswordExpiration": null,
    "AccountTypes": [
        "WebUI",
        "Redfish",
        "ManagerConsole",
        "IPMI",
        "SNMP"
    ],
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "HostBootstrapAccount": true,
    "Locked": false,
    "Id": "HostBootStrap",
    "Name": "Host Boot Strap Account",
    "@odata.type": "#ManagerAccount.v1_8_1.ManagerAccount",
    "@odata.id": "/redfish/v1/AccountService/Accounts/HostBootStrap",
    "UserName": "wjNPLZankQvBQtY",
    "Password": null,
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        }
    },
    "@odata.etag": "\"5be9012edf46272eecc\"",
    "Enabled": true
}