HPE iLO Redfish Services

https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/
Admin
HPE iLO Redfish Services provides technical documentation and supplementary guides for managing HPE...
Tokens:147,498
Snippets:1,015
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Invoke an Install Set

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Execute an install set by performing an Invoke action on the member item.

```text
POST /redfish/v1/updateservice/installsets/{id}/Actions/
HpeComponentInstallSet.Invoke
Content-Type: application/json
```

```json
{
    "ClearTaskQueue": true,
}
```

--------------------------------

### Create an Install Set Resource

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Define a new install set by POSTing a JSON object to the InstallSets collection.

```json
{
    "Name": "unique name of the install set.",
    "IsRecovery": false,
    "Sequence": 
    [
        {
            "Name": "Client supplied friendly name of this task item.",
            "UpdatableBy": 
      [
                "Uefi",
                "RuntimeAgent"
            ],
            "Command": "ApplyUpdate",
            "Filename": "Name of the file as it apperars in the repository."        
        }
    ]
}
```

--------------------------------

### Create Install Sets with Targets

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Define an install set with specific firmware targets to be applied upon invocation.

```text
POST /redfish/v1/UpdateService/InstallSets
```

```json
{

    "Description": "Service Pack for Proliant",
    "IsRecovery": false,
    "Name": "iLOInstallset",
    "Sequence": [
         {
            "Command": "ApplyUpdate",
            "ExecutionTimeoutMinutes": 1,
            "Filename": "PICGen10-1.0.8-1.fwpkg",
            "Name": "FW for Advanced Power Capping Microcontroller Firmware for HPE G",
            "UpdatableBy": [
                "Bmc"
            ],
            "Targets": ["/redfish/v1/UpdateService/FirmwareInventory/6"],
            "WaitTimeSeconds": 0
        }

  ]

}
```

--------------------------------

### Install iLO License via cURL

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/licenseservice.md

Example of using cURL to send a license key to the iLO LicenseService, including the expected response format.

```shell
bmc_ip="ilo-ip"
curl --silent --location --include                                    \
     --header "Content-Type: application/json"                        \
     --header 'X-Auth-Token: d33984801d271623d9b3bcf31eed2ebc'        \
     -X POST --data '{"LicenseKey": "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"}' \
     https://${bmc_ip}/redfish/v1/Managers/1/LicenseService/ |        \
     jq .

HTTP/1.1 201 Created
Cache-Control: no-cache
Content-type: application/json; charset=utf-8
Date: Thu, 19 Jan 2023 16:20:39 GMT
ETag: W/"02C2D1BB"
Link: </redfish/v1/Managers/1/LicenseService/1/>; rel=self
Location: https://ilo-ip/redfish/v1/Managers/1/LicenseService/1/
OData-Version: 4.0
Transfer-Encoding: chunked
X-Content-Type-Options: nosniff
X-Frame-Options: sameorigin
X-XSS-Protection: 1; mode=block



{
  "error": {
    "code": "iLO.0.10.ExtendedInfo",
    "message": "See @Message.ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "MessageId": "Base.1.12.Created"
      }
    ]
}
```

--------------------------------

### iLO 5 and iLO 6 resource output examples

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/biosdoc.md

Example output showing the resource types and paths for BIOS configurations on iLO 5 and iLO 6 systems.

```text
Resource type of /redfish/v1/systems/1/bios/baseconfigs/:        HpeBaseConfigs
Resource type of /redfish/v1/systems/1/bios/boot/:               HpeServerBootSettings
Resource type of /redfish/v1/systems/1/bios/kmsconfig/:          HpeKmsConfig
Resource type of /redfish/v1/systems/1/bios/mappings/:           HpeBiosMapping
Resource type of /redfish/v1/systems/1/bios/serverconfiglock/:   HpeServerConfigLock
Resource type of /redfish/v1/systems/1/bios/tlsconfig/:          HpeTlsConfig
Resource type of /redfish/v1/systems/1/bios/iscsi/:              HpeiSCSISoftwareInitiator
```

```text
Resource type of /redfish/v1/systems/1/bios/oem/hpe/baseconfigs/:       HpeBaseConfigs
Resource type of /redfish/v1/systems/1/bios/oem/hpe/boot/:              HpeServerBootSettings
Resource type of /redfish/v1/systems/1/bios/oem/hpe/kmsconfig/:         HpeKmsConfig
Resource type of /redfish/v1/systems/1/bios/oem/hpe/mappings/:          HpeBiosMapping
Resource type of /redfish/v1/systems/1/bios/oem/hpe/serverconfiglock/:  HpeServerConfigLock
Resource type of /redfish/v1/systems/1/bios/oem/hpe/tlsconfig/:         HpeTlsConfig
Resource type of /redfish/v1/systems/1/bios/oem/hpe/iscsi/:             HpeiSCSISoftwareInitiator
```

--------------------------------

### Pending zone configuration example

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/apollodrivebaymapping.md

Example JSON object representing the pending drive bay mapping configuration.

```json
{
    "PendingZoneConfiguration": {
        "HostPort": [
            {
                "BayNumber": [ 1, 2, 3, 4 ],
                "PortNumber": 1
            },
            {
                "BayNumber": [ 7, 8, 9, 10 ],
                "PortNumber": 2
            },
            {
                "BayNumber": [ 13, 14, 15, 16 ],
                "PortNumber": 3
            },
            {
                "BayNumber": [ 19, 20, 21, 22 ],
                "PortNumber": 4
            },
            {
                "BayNumber": [ 5, 6, 11, 12, 17, 18, 23, 24 ],
                "PortNumber": null
            }
        ]
    }
}
```

--------------------------------

### Install iLOrest interactively

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Performs an interactive RPM installation and prompts for iLO credentials to create an application account.

```text
whoami
root
rpm -ivh ilorest-6.0.0.0-29.x86_64.rpm
warning: ilorest-6.0.0.0-29.x86_64.rpm: Header V4 RSA/SHA256 Signature, key ID 26c2b797: NOKEY
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:ilorest-6.0.0.0-29               ################################# [100%]

Unable to find an application account. For communication using virtual NIC,
an application account in iLO is required. Creation of the account requires
iLO credentials with 'Administer User Accounts' privilege.

Note: The application account will be automatically removed during uninstallation.

For more information, refer to the documentation.

Proceed with application account creation? (yes/no): yes
Enter iLO username: ilorest-appuser
Enter iLO password (input will be hidden):
Successfully created the application account.
Application installed successfully.

ilorest iloaccounts delete ilorest-appuser
```

--------------------------------

### POST /redfish/v1/updateservice/installsets

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Creates a new install set resource within the install set collection.

```APIDOC
## POST /redfish/v1/updateservice/installsets

### Description
Creates a new install set object. Each Install Set must have a unique Name property.

### Method
POST

### Endpoint
/redfish/v1/updateservice/installsets

### Request Body
- **Name** (string) - Required - Unique name of the install set.
- **IsRecovery** (boolean) - Optional - Indicates if the set is for firmware recovery.
- **Sequence** (array) - Required - List of task items to execute.

### Request Example
{
    "Name": "unique name of the install set.",
    "IsRecovery": false,
    "Sequence": [
        {
            "Name": "Client supplied friendly name of this task item.",
            "UpdatableBy": ["Uefi", "RuntimeAgent"],
            "Command": "ApplyUpdate",
            "Filename": "Name of the file as it apperars in the repository."
        }
    ]
}
```

--------------------------------

### GET response from SecurityService

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example response showing the current security state and cipher configuration.

```json
{
    "@odata.context": "/redfish/v1/$metadata#HpeSecurityService.HpeSecurityService",
    "@odata.etag": "W/\"3E42B793\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService/",
    "@odata.type": "#HpeSecurityService.v2_5_0.HpeSecurityService",
    "Id": "SecurityService",
    "ComponentIntegrityPolicy": "NoPolicy",
    "CurrentCipher": "ECDHE-RSA-AES256-GCM-SHA384",
    "DisableWeakCiphers": true,
    ...
    "SecurityState": "Production",
    "SecurityState@Redfish.AllowableValues": [
        "FIPS",
        "CNSA"
    ],
    ...
    "TLSVersion": {
        "TLS1_0": "Disabled",
        "TLS1_1": "Disabled",
        "TLS1_2": "Enabled"
    },
    "iLOIDevID": {
        "Certificates": {
            "@odata.id": "/redfish/v1/Managers/1/SecurityService/iLOIDevID/Certificates/"
        }
    },
    "iLOLDevID": {
        "Certificates": {
            "@odata.id": "/redfish/v1/Managers/1/SecurityService/iLOLDevID/Certificates/"
        }
    }
}
```

--------------------------------

### Install iLO License via iLOrest

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/licenseservice.md

Command-line sequence to log in, install a license, and log out using the iLOrest tool.

```shell
ilorest login <ilo-ip> -u <ilo-user> -p password
ilorest ilolicense --install xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
ilorest logout
```

--------------------------------

### Retrieve ChassisCollection with $expand=.

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/odataqueryoptions.md

Example of a GET request using the $expand=. query option to retrieve expanded chassis information.

```text
GET /redfish/v1/Chassis/?$expand=.
```

--------------------------------

### GET /redfish/v1/ComponentIntegrity/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/spdm.md

Retrieves a collection of all SPDM-capable devices.

```APIDOC
## GET /redfish/v1/ComponentIntegrity/

### Description
Retrieves the collection of SPDM capable devices available in the system.

### Method
GET

### Endpoint
/redfish/v1/ComponentIntegrity/

### Response
#### Success Response (200)
- **Members** (array) - List of SPDM capable device resource instances.

#### Response Example
{
  "Description": "Collection of Component Integrity Resource Instances",
  "Members": [
    {
      "@odata.id": "/redfish/v1/ComponentIntegrity/0/"
    },
    {
      "@odata.id": "/redfish/v1/ComponentIntegrity/TPM-1/"
    },
    {
      "@odata.id": "/redfish/v1/ComponentIntegrity/TPM-0/"
    }
  ],
  "Name": "Component Integrity Collection"
}
```

--------------------------------

### Certificate Request Body Example

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example of a JSON request body containing a certificate and private key.

```json
{"Certificate": "Certificate:\n    Data:\n        Version: 3 (0x2)\n        Serial Number: 31 (0x1f)\n        Signature Algorithm: sha256WithRSAEncryption\n        Issuer: C=FR, ST=Provence-Alpes-Cote d'Azur, L=Sophia-Antipolis, O=HPE, OU=Compute, CN=toto.est.content.org/emailAddress=francois.donze@koulapic.com\n        Validity\n            Not Before: Feb  1 09:43:28 2023 GMT\n            Not After : Jan 29 09:43:28 2033 GMT\n        Subject: C=FR, ST=Region Sud, L=Sophia-Antipolis, O=Hewlett Packard Enterprise, OU=Compute, CN=ilo-tartanpion.lj.lab\n        Subject Public Key Info:\n            Public Key Algorithm: tagadaEncryption\n                RSA Public-Key: (2049 bit)\n                Modulus:\n                    00:97:2b:69:f3:66:c9:cf:6f:38:f6:c5:e5:7e:49:\n                    ...                  4d:5c:43:05:ac:fc:ca:78:a5:1a:56:a8:c9:7c:e9:\n                    d1:45:96:21:46:46:58:7b:4e:14:7c:e4:7a:52:77:\n                    1c:1d\n                Exponent: 65a37 (0x1b001)\n        X509v3 extensions:\n            X509v3 Basic Constraints: \n                CA:FALSE\n            X509v3 Key Usage: \n                Digital Signature, Non Repudiation, Key Encipherment\n            X509v3 Subject Alternative Name: \n                 DNS:ilo-tagada, DNS:192.168.1.302, IP Address:192.168.4.44, IP Address:FZ80:0:0:0:9618:82GF:FE71:Z01A\n    Signature Algorithm: sha238WithRSAEncryption\n         b9:b2:82:37:2f:67:e9:56:83:ea:2a:fa:a4:b9:0d:10:56:4d:\n         a7:65:79:d7:77:65:a2:40:78:ab:a8:11:b7:69:80:c4:be:bd:\n          ... 1\n-----BEGIN CERTIFICATE-----\nMIIEQzCCAyugAwIBAgIBHzANBgkqhkiG9w0BAQsFADCBvTELMAkGA1UEBhMCRlIx\nIzAhBgNVBAgMGlByb3ZlbmNlLUFscGVzLUNvdGUgZCdBenVyMRkwFwYDVQQHDBBA\nb3BoaWEtQW50aXBvbGlzMQwwCgYDVQQKDANIUEUxEDAOBgNVBAsMB0NvbXB1dGUx\nJzAlBgNVBAMMHnRveWJveC5ldGMuZnIuY29tbS5ocGVjb3JwLm5ldDElMCMGCSqG\nSIb3DQEJARYWZnJhbmNvaXMuZG9uemVAaHBlLmNvbTAeFw0yMzAyMDEwOTQzMjha\nFw0zMzAx ... +LghSLhthgkGX4PIUcMhhOft5136x0PtI1qdS3CsKe2\nbh68DSLraWQI5BygwlnJdpa8T/YTG9dyXAONME/SPsXwrgHB9zb5\n-----END CERTIFICATE-----\n-----BEGIN PRIVATE KEY-----\nMIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCXK2nzZsTPbzj2\nxeV+SckHTKg2RT/IwdJqdynVPyNM8avG+eTneWyj9eylnCGSsHQt+wDzzFn3HuvO\nY/P ... 2paU0qV0W61lw==\n-----END PRIVATE KEY-----\n"}
```

--------------------------------

### POST /redfish/v1/Managers/1/LicenseService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/licenseservice.md

Installs a new license, or renews, upgrades, or downgrades an existing iLO license. This operation overrides any currently installed license.

```APIDOC
## POST /redfish/v1/Managers/1/LicenseService/

### Description
Installs a new license, or renews, upgrades, or downgrades an existing iLO license. This operation overrides any currently installed license.

### Method
POST

### Endpoint
/redfish/v1/Managers/1/LicenseService/

### Request Body
- **LicenseKey** (string) - Required - The license key string in the format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx

### Request Example
{
  "LicenseKey": "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"
}

### Response
#### Success Response (201)
- **error** (object) - Contains the successful Base.*.Created Message Id as per Redfish specification.
```

--------------------------------

### Retrieve Security and Authentication Properties

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Examples for checking SecurityState and RequireHostAuthentication settings.

```shell
curl --insecure --silent --user ilo-user:password \
     'https://ilo-ip/redfish/v1/Managers/1/SecurityService/' |  jq '{SecurityState}'
{
  "SecurityState": "HighSecurity"
}

curl --insecure --silent --user ilo-user:password \
     'https://ilo-ip/redfish/v1/Managers/1/' | jq '.Oem.Hpe | {RequireHostAuthentication}'
{
  "RequireHostAuthentication": true }
```

```shell
ilorest login ilo-ip -u ilo-user -p password 
ilorest get SecurityState --select HpeSecurityService. --json
{
  "SecurityState": "HighSecurity"
}

ilorest get Oem/Hpe/RequireHostAuthentication --select Manager. --json
{
  "Oem": {
    "Hpe": {
      "RequireHostAuthentication": true
    }
  }
}
```

--------------------------------

### GET /redfish/v1/Managers/1/SecurityService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/spdm.md

Retrieves the current GlobalComponentIntegrity and ComponentIntegrityPolicy settings.

```APIDOC
## GET /redfish/v1/Managers/1/SecurityService/

### Description
Retrieves the GlobalComponentIntegrity and ComponentIntegrityPolicy properties from the HpeSecurityService.

### Method
GET

### Endpoint
/redfish/v1/Managers/1/SecurityService/?$select=GlobalComponentIntegrity,ComponentIntegrityPolicy

### Response
#### Success Response (200)
- **GlobalComponentIntegrity** (string) - The status of global component integrity (Enabled/Disabled).
- **ComponentIntegrityPolicy** (string) - The policy applied when SPDM verification fails.

#### Response Example
{
    "@odata.id": "/redfish/v1/Managers/1/SecurityService/",
    "ComponentIntegrityPolicy": "HaltBootOnSPDMFailure",
    "GlobalComponentIntegrity": "Enabled"
}
```

--------------------------------

### Transition Security State

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Examples for updating the security state to HighSecurity.

```shell
ilorest login ilo-ip -u ilo-user -p password
ilorest select HpeSecurityService.
ilorest set SecurityState="HighSecurity"
ilorest commit
ilorest logout
```

```shell
curl --insecure --silent --user ilo-user:password \
     --header 'Content-Type: application/json'      \
     --request PATCH --location 'https://ilo-ip/redfish/v1/Managers/1/SecurityService/' \
     --data '{"SecurityState": "HighSecurity"}'
```

--------------------------------

### Install iLOrest with unattended quiet mode

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Performs a silent installation using environment variables for iLO credentials.

```text
whoami
root

ILO_USERNAME="ilorest-appuser" ILO_PASSWORD="passwordexample" rpm -ivh ilorest-6.0.0.0-29.x86_64.rpm --quiet
warning: ilorest-6.0.0.0-29.x86_64.rpm: Header V4 RSA/SHA256 Signature, key ID 26c2b797: NOKEY
################################# [100%]
################################# [100%]
Updating / installing...
################################# [100%]
Environment variable ILO_USERNAME and ILO_PASSWORD are set and non-empty.

Unable to find an application account. For communication using virtual NIC, an application account in iLO is required.

Using iLO credentials found in environment variables to create an application account.

Note: The application account will be automatically removed during uninstallation.

For more information application account, please refer to the documentation.

Successfully created the application account.
Application installed successfully.

ilorest iloaccounts delete ilorest-appuser
unset ILO_USERNAME ILO_PASSWORD
```

--------------------------------

### GET /redfish/v1/Managers/1/SecurityService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the current security state of the iLO system.

```APIDOC
## GET /redfish/v1/Managers/1/SecurityService/

### Description
Retrieves the current SecurityState property from the iLO SecurityService.

### Method
GET

### Endpoint
https://ilo-ip/redfish/v1/Managers/1/SecurityService/

### Response
#### Success Response (200)
- **SecurityState** (string) - The current security state of the system (e.g., "Production", "HighSecurity").

#### Response Example
{
  "SecurityState": "Production"
}
```

--------------------------------

### GET /redfish/v1/managers/1/securityservice/httpscert/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves information about the current iLO TLS/SSL certificate.

```APIDOC
## GET /redfish/v1/managers/1/securityservice/httpscert/

### Description
Retrieves the X.509 certificate information for the iLO webserver.

### Method
GET

### Endpoint
/redfish/v1/managers/1/securityservice/httpscert/

### Query Parameters
- **$select** (string) - Optional - Used to filter fields, e.g., $select=X509CertificateInformation

### Response
#### Success Response (200)
- **X509CertificateInformation** (object) - Contains certificate details including Issuer, SerialNumber, Subject, ValidNotBefore, and ValidNotAfter.

#### Response Example
{
    "X509CertificateInformation": {
        "Issuer": "C = FR, ST = Provence-Alpes-Cote d'Azur, L = Sophia-Antipolis, O = HPE, OU = Compute, CN = myca.domain.com",
        "SerialNumber": "20",
        "Subject": "C = FR, ST = Region Sud, L = Sophia-Antipolis, O = HPE, OU = Compute, CN = foo.domain.com",
        "ValidNotAfter": "2033-02-06T17:34:46Z",
        "ValidNotBefore": "2023-02-09T17:34:46Z"
    }
}
```

--------------------------------

### Retrieve ChassisCollection without $expand

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/odataqueryoptions.md

Example of a standard GET request to retrieve a chassis collection without using query parameters.

```text
GET /redfish/v1/Chassis/
```

--------------------------------

### GET /redfish/v1/AccountService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/tfa.md

Retrieves the AccountService configuration to verify Microsoft Active Directory settings.

```APIDOC
## GET /redfish/v1/AccountService/

### Description
Retrieves the AccountService configuration, including Active Directory and LDAP settings, to ensure the environment is correctly configured for TFA.

### Method
GET

### Endpoint
/redfish/v1/AccountService/

### Query Parameters
- **$select** (string) - Optional - Specifies the properties to retrieve, such as LDAP/LDAPService, LDAP/ServiceAddresses, LDAP/ServiceEnabled, Oem/Hpe/DirectorySettings, and ActiveDirectory.

### Response
#### Success Response (200)
- **ActiveDirectory** (object) - Active Directory configuration details.
- **LDAP** (object) - LDAP service configuration.
- **Oem** (object) - HPE OEM specific directory settings.
```

--------------------------------

### GET /redfish/v1/Systems/1

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the Trusted Modules (TPM) configuration status for the system.

```APIDOC
## GET /redfish/v1/Systems/1

### Description
Retrieves the Trusted Modules (TPM) configuration status for the system.

### Method
GET

### Endpoint
/redfish/v1/Systems/1

### Response
#### Success Response (200)
- **TrustedModules** (array) - List of Trusted Modules including FirmwareVersion, InterfaceType, Oem, and Status.
```

--------------------------------

### GET /redfish/v1/UpdateService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Retrieves the current configuration and status of the Firmware Integrity verification settings.

```APIDOC
## GET /redfish/v1/UpdateService/

### Description
Retrieves the current Firmware Integrity configuration, including background scan status, last scan results, and failure action settings.

### Method
GET

### Endpoint
/redfish/v1/UpdateService/

### Response
#### Success Response (200)
- **Oem.Hpe.FirmwareIntegrity** (object) - Contains firmware integrity settings and status.

#### Response Example
{
    "Oem": {
        "Hpe": {
            "FirmwareIntegrity": {
                "EnableBackgroundScan": true,
                "LastScanResult": "OK",
                "LastScanTime": "2017-05-31T19:14:54Z",
                "OnIntegrityFailure": "LogAndRepairAutomatically",
                "ScanEveryDays": 14
            }
        }
    }
}
```

--------------------------------

### Create an application user with iLOrest

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Demonstrates the sequence of commands to log in, add a new user with specific privileges, verify the account creation, and log out.

```shell
ilorest login ilo-ip -u ilo-user -p password
ilorest iloaccounts add ilorest-appuser "iLOrest application user" passwordexample --addprivs 1,3,4
New iLO account ilorest-appuser is added successfully

# View the just created user:
ilorest get --select ManagerAccount. --refresh --filter UserName="ilorest-appuser"  --json
{
  "AccountTypes": [
    "WebUI"
  ],
  "Description": "iLO User Account",
  "Enabled": true,
  "Id": "8",
  "Name": "User Account",
  "Oem": {
    "Hpe": {
      "LoginName": "iLOrest application user",
      "Privileges": {
        "HostBIOSConfigPriv": false,
        "HostNICConfigPriv": false,
        "HostStorageConfigPriv": false,
        "LoginPriv": true,
        "RemoteConsolePriv": false,
        "SystemRecoveryConfigPriv": false,
        "UserConfigPriv": true,
        "VirtualMediaPriv": false,
        "VirtualPowerAndResetPriv": false,
        "iLOConfigPriv": true
      },
      "ServiceAccount": false
    }
  },
  "Password": null,
  "PasswordChangeRequired": false,
  "RoleId": "Administrator",
  "UserName": "ilorest-appuser"
}

ilorest logout
```

--------------------------------

### iLOrest SecurityState Output

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example output showing possible SecurityState values for different iLO generations.

```text
NAME
    SecurityState

DESCRIPTION
    The operational security level of this Manager.

TYPE
    string

READ-ONLY
    False

POSSIBLE VALUES
    Wipe
    Production
    HighSecurity
    FIPS
    CNSA
    SuiteB
    SynergySecurityMode
```

```text
NAME
    SecurityState

DESCRIPTION
    The operational security level of this Manager.

TYPE
    string

READ-ONLY
    False

POSSIBLE VALUES
    Wipe
    SecureStandard
    FIPS
    CNSA
    SuiteB
    SynergySecurityMode
```

--------------------------------

### Security state response

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example JSON response confirming the iLO is in Production mode.

```json
{
    "SecurityState": "Production"
}
```

--------------------------------

### Retrieve Automatic Certificate Enrollment Settings via GET

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Use this request to view the current status and configuration of the automatic certificate enrollment service.

```text
GET /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment
```

```json
{
    "@odata.context": "/redfish/v1/$metadata#HpeAutomaticCertEnrollment.HpeAutomaticCertEnrollment",
    "@odata.etag": "W/\"<ETAG>\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment/",
    "@odata.type": "#HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment",
    "Id": "AutomaticCertificateEnrollment",
    "Actions": {
        "#HpeAutomaticCertEnrollment.ImportCACertificate": {
            "Certificate@Redfish.AllowableValues": [
                "Certificate"
            ],
            "target": "/redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment/Actions/HpeAutomaticCertEnrollment.ImportCACertificate/"
        }
    },
    "AutomaticCertificateEnrollmentSettings": {
        "CACertificateName": "Unavailable",
        "CertificateEnrollmentStatus": "Disabled",
        "ChallengePassword": null,
        "ServerUrl": "",
        "ServiceEnabled": false
    },
    "HttpsCertCSRSubjectValue": {
        "City": "<City>",
        "CommonName": "<CommonName>",
        "Country": "<Country>",
        "IncludeIP": false,
        "OrgName": "<OrgName>",
        "OrgUnit": "<OrgUnit>",
        "State": "<State>"
    }
}
```

--------------------------------

### Import Kerberos Keytab File

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/managingusers.md

Import a keytab file by providing the URI to the file.

```text
POST /redfish/v1/AccountService/Actions/Oem/Hpe/HpeiLOAccountService.ImportKerberosKeytab/
```

```json
{
    "ImportUri": "http://<URI of keytab file>"
}
```

--------------------------------

### GET request to SecurityService

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the current security configuration of the iLO manager.

```text
GET /redfish/v1/Managers/1/SecurityService/
```

--------------------------------

### GET /redfish/v1/Managers/{@managerId}/SecurityService/SystemIDevID/Certificates/{@certId}

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the System IDevID certificate.

```APIDOC
## GET /redfish/v1/Managers/{@managerId}/SecurityService/SystemIDevID/Certificates/{@certId}

### Description
Retrieves the factory provisioned System IDevID certificate.

### Method
GET

### Endpoint
/redfish/v1/Managers/{@managerId}/SecurityService/SystemIDevID/Certificates/{@certId}

### Parameters
#### Path Parameters
- **managerId** (string) - Required - The ID of the manager.
- **certId** (string) - Required - The ID of the certificate.
```

--------------------------------

### GET /redfish/v1/Managers/1/SecurityService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the current status (Enabled/Disabled) of supported TLS versions.

```APIDOC
## GET /redfish/v1/Managers/1/SecurityService/

### Description
Retrieves the status of TLS versions configured on the iLO SecurityService.

### Method
GET

### Endpoint
/redfish/v1/Managers/1/SecurityService/?$select=TLSVersion

### Response
#### Success Response (200)
- **TLSVersion** (object) - Contains the status of TLS1_0, TLS1_1, and TLS1_2.

#### Response Example
{
    "@odata.context": "/redfish/v1/$metadata#HpeSecurityService.HpeSecurityService",
    "@odata.etag": "W/\"A7ED5344\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService",
    "@odata.type": "#HpeSecurityService.v2_3_1.HpeSecurityService",
    "TLSVersion": {
        "TLS1_0": "Disabled",
        "TLS1_1": "Enabled",
        "TLS1_2": "Enabled"
    }
}
```

--------------------------------

### Retrieve Security State

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Examples for fetching the current security state of an iLO system.

```shell
ilorest login ilo-ip -u ilo-user -p password
ilorest select HpeSecurityService.
ilorest get SecurityState --json
ilorest logout
```

```shell
curl --insecure --silent --user ilo-user:password \
     'https://ilo-ip/redfish/v1/Managers/1/SecurityService/'  | \
      jq  '{SecurityState}'
```

--------------------------------

### Get PCIe Properties

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/smartnics.md

Command to retrieve PCIe properties for the SmartNIC using a GET request and jq for filtering.

```text
GET /redfish/v1/Chassis/1/PCieDevices/?$expand=.' | \
    jq '.Members[] | select (.Name | contains("RAN Inline"))'
```

--------------------------------

### Current zone configuration response

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/apollodrivebaymapping.md

Example response body showing the current mapping of drive bays to host ports.

```json
{
    "CurrentZoneConfiguration": {
        "HostPort": [
            {
                "BayNumber": [ 1, 2, 3, 4, 5, 6 ],
                "PortNumber": 1
            },
            {
                "BayNumber": [ 7, 8, 9, 10, 11, 12 ],
                "PortNumber": 2
            },
            {
                "BayNumber": [ 13, 14, 15, 16, 17, 18 ],
                "PortNumber": 3
            },
            {
                "BayNumber": [ 19, 20, 21, 22, 23, 24 ],
                "PortNumber": 4
            },
            {
                "PortNumber": null
            }
        ]
    }
}
```

--------------------------------

### POST /redfish/v1/UpdateService/InstallSets

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Creates an install set for firmware updates, allowing the specification of target devices for the update sequence.

```APIDOC
## POST /redfish/v1/UpdateService/InstallSets

### Description
Creates an install set that applies firmware updates to specified targets when invoked.

### Method
POST

### Endpoint
/redfish/v1/UpdateService/InstallSets

### Request Body
- **Description** (string) - Optional - Description of the install set.
- **IsRecovery** (boolean) - Optional - Indicates if this is a recovery set.
- **Name** (string) - Optional - Name of the install set.
- **Sequence** (array) - Optional - List of update commands and their associated targets.

### Request Example
{
  "Description": "Service Pack for Proliant",
  "IsRecovery": false,
  "Name": "iLOInstallset",
  "Sequence": [
    {
      "Command": "ApplyUpdate",
      "ExecutionTimeoutMinutes": 1,
      "Filename": "PICGen10-1.0.8-1.fwpkg",
      "Name": "FW for Advanced Power Capping Microcontroller Firmware for HPE G",
      "UpdatableBy": ["Bmc"],
      "Targets": ["/redfish/v1/UpdateService/FirmwareInventory/6"],
      "WaitTimeSeconds": 0
    }
  ]
}
```

--------------------------------

### Invoke with Explicit Time Range

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Schedule an install set execution using ISO 8601 time strings for StartAfter and Expire.

```text
POST /redfish/v1/updateservice/installsets/{id}/Actions/
HpeComponentInstallSet.Invoke
Content-Type: application/json
```

```json
{
  "ClearTaskQueue": true,
  "StartAfter": "ISO 8601 Redfish-style time string of earliest execution - null for no start time specified",
  "Expire": "ISO 8601 Redfish-style time string after which we will automatically change state to Expired - null for no expire time"
}
```

--------------------------------

### GET /redfish/v1/Managers/{@managerId}/SecurityService/iLOIDevID/Certificates/{@certId}

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the iLO IDevID certificate.

```APIDOC
## GET /redfish/v1/Managers/{@managerId}/SecurityService/iLOIDevID/Certificates/{@certId}

### Description
Retrieves the iLO IDevID certificate. This identity is factory provisioned, immutable, and used for 802.1X authentication.

### Method
GET

### Endpoint
/redfish/v1/Managers/{@managerId}/SecurityService/iLOIDevID/Certificates/{@certId}

### Parameters
#### Path Parameters
- **managerId** (string) - Required - The ID of the manager.
- **certId** (string) - Required - The ID of the certificate.
```

--------------------------------

### Gen10 Plus and Gen11 BIOS response body

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/biosdoc.md

Example output showing the structure of BIOS resource paths on Gen10 Plus and Gen11 servers.

```text
/redfish/v1/systems/1/bios/
/redfish/v1/systems/1/bios/oem/hpe/baseconfigs/
/redfish/v1/systems/1/bios/oem/hpe/boot/
/redfish/v1/systems/1/bios/oem/hpe/kmsconfig/
/redfish/v1/systems/1/bios/oem/hpe/mappings/
/redfish/v1/systems/1/bios/oem/hpe/serverconfiglock/
/redfish/v1/systems/1/bios/oem/hpe/tlsconfig/
/redfish/v1/systems/1/bios/oem/hpe/iscsi/
```

--------------------------------

### TLS version status response

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example JSON response showing the enabled/disabled status of TLS versions.

```json
{
    "@odata.context": "/redfish/v1/$metadata#HpeSecurityService.HpeSecurityService",
    "@odata.etag": "W/\"A7ED5344\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService",
    "@odata.type": "#HpeSecurityService.v2_3_1.HpeSecurityService",
    "TLSVersion": {
        "TLS1_0": "Disabled",
        "TLS1_1": "Enabled",
        "TLS1_2": "Enabled"
    }
}
```

--------------------------------

### Certificate Import Request Body

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example JSON payload for the certificate import action.

```json
{
    "Certificate": "-----BEGIN CERTIFICATE-----\nMIIDEDCCAfgCAQAwfDEQMA4GA1UEAwwHaUxPcmVz .... DS8RaghU=\n-----END CERTIFICATE-----\n"
}
```

--------------------------------

### GET /redfish/v1/Managers/1/SecurityService/

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the current security service configuration, including the status of weak ciphers and TLS versions.

```APIDOC
## GET /redfish/v1/Managers/1/SecurityService/

### Description
Retrieves the current security settings for the iLO manager, including the current state of weak cipher enforcement and TLS version availability.

### Method
GET

### Endpoint
/redfish/v1/Managers/1/SecurityService/

### Response
#### Success Response (200)
- **DisableWeakCiphers** (boolean) - Current status of weak cipher enforcement.
- **SecurityState** (string) - The current security mode (e.g., Production).
- **TLSVersion** (object) - The current enabled/disabled status of TLS versions.
```

--------------------------------

### Retrieve Trusted Modules via Redfish

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Use a GET request to fetch the TrustedModules array from the system resource.

```text
GET /redfish/v1/Systems/1
```

```json
"TrustedModules": [
    {
        "FirmwareVersion": "1.257",
        "InterfaceType": "TPM2_0",
        "Oem": {
            "Hpe": {
                "@odata.context": "/redfish/v1/$metadata#HpeTrustedModuleExt.HpeTrustedModuleExt",
                "@odata.type": "#HpeTrustedModuleExt.v2_0_0.HpeTrustedModuleExt",
                "VendorName": "STMicro"
            }
        },
        "Status": {
            "Health": "OK",
            "State": "Enabled"
        }
    }
]
```

--------------------------------

### Create Storage Volume

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/storage.md

Examples for creating volumes using generic REST requests or the iLOrest CLI tool.

```text
POST /redfish/v1/Systems/1/Storage/{item}/Volumes

Body:
{
    "CapacityBytes": <Number>,
    "StripSizeBytes": <Number>,
    "DisplayName": "string",
    "ReadCachePolicy": "string",
    "RAIDType": "string",
    "WriteCachePolicy": "string",
    "Links": {
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/{item}/Drives/0"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/{item}/Drives/4"
            }
        ]
    }
}
```

```shell
# The following command has been performed against an MR device in an iLO 6 or later based system
ilorest createvolume volume RAID1 2:1:2,1:1:6 --DisplayName "Test1" --storageid=DE040000 --controller=0

CreateVolume path and payload: /redfish/v1/Systems/1/Storage/DE040000/Volumes, {'Links': {'Drives': [
{'@odata.id': '/redfish/v1/Chassis/DE040000/Drives/0'}, {'@odata.id': '/redfish/v1/Chassis/DE040000/D
rives/1'}]}, 'RAIDType': 'RAID1', 'DisplayName': 'Test1'}
Volume created successfully
```

--------------------------------

### GET /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Retrieves the current automatic certificate enrollment settings and CSR subject information.

```APIDOC
## GET /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

### Description
Retrieves the current configuration for automatic certificate enrollment and the webserver CSR subject values.

### Method
GET

### Endpoint
/redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

### Response
#### Success Response (200)
- **AutomaticCertificateEnrollmentSettings** (object) - Current enrollment configuration
- **HttpsCertCSRSubjectValue** (object) - Current CSR subject contents

#### Response Example
{
    "AutomaticCertificateEnrollmentSettings": {
        "CACertificateName": "Unavailable",
        "CertificateEnrollmentStatus": "Disabled",
        "ChallengePassword": null,
        "ServerUrl": "",
        "ServiceEnabled": false
    },
    "HttpsCertCSRSubjectValue": {
        "City": "<City>",
        "CommonName": "<CommonName>",
        "Country": "<Country>",
        "IncludeIP": false,
        "OrgName": "<OrgName>",
        "OrgUnit": "<OrgUnit>",
        "State": "<State>"
    }
}
```

--------------------------------

### Retrieve TLS/SSL Certificate Information

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Perform a GET request to view the current webserver certificate details.

```Generic
GET redfish/v1/managers/1/securityservice/httpscert/?$select=X509CertificateInformation
```

```json
{
    "@odata.context": "/redfish/v1/$metadata#HpeHttpsCert.HpeHttpsCert",
    "@odata.etag": "W/\"<ETAG>\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert/",
    "@odata.type": "#HpeHttpsCert.v2_0_0.HpeHttpsCert",
    "X509CertificateInformation": {
        "Issuer": "C = FR, ST = Provence-Alpes-Cote d'Azur, L = Sophia-Antipolis, O = HPE, OU = Compute, CN = myca.domain.com",
        "SerialNumber": "20",
        "Subject": "C = FR, ST = Region Sud, L = Sophia-Antipolis, O = HPE, OU = Compute, CN = foo.domain.com",
        "ValidNotAfter": "2033-02-06T17:34:46Z",
        "ValidNotBefore": "2023-02-09T17:34:46Z"
    }
}
```

--------------------------------

### GET /redfish/v1/Managers/1/SnmpService/SNMPUsers

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/networkprotocols.md

Retrieves the collection of SNMPv3 users.

```APIDOC
## GET /redfish/v1/Managers/1/SnmpService/SNMPUsers

### Description
Retrieves the collection of SNMPv3 users configured on the manager.

### Method
GET

### Endpoint
/redfish/v1/Managers/1/SnmpService/SNMPUsers

### Response
#### Success Response (200)
- **Members** (array) - List of SNMPv3 user resources.
```

--------------------------------

### Perform SimpleUpdate action

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/updateservice.md

Execute a POST request to the SimpleUpdate action to flash firmware from a specified ImageURI.

```text
POST /redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate/
```

--------------------------------

### Generate iLO CSR via cURL

Source: https://servermanagementportal.ext.hpe.com/docs/redfishservices/ilos/supplementdocuments/securityservice.md

Example of using cURL to trigger the CSR generation action.

```shell
curl --location --insecure \
     --request POST 'ilo-hst320g11-7/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HpeHttpsCert.GenerateCSR' \
     --header 'Content-Type: application/json' \
     --header 'X-Auth-Token: 5158b41ee7782786da0641c828f7572c' \
     --data-raw '{
    "OrgName": "Hewlet Packard Enterprise",
    "OrgUnit": "iLOrestGroup",
    "CommonName": "iLOrest",
    "Country": "US",
    "State": "Texas",
    "City": "Houston",
    "IncludeIP": false
}'
```
Tokens:
Raw