HP iLO Universal Orchestrator Extension

Support · Installation · License · Related Integrations

Overview

This is an HP iLO orchestrator extension.

⚠️ Important Notice

Cert Store Type has been changed from version 1.0. Please update existing stores to include the new entry parameter, enable Add job functionality and make sure the default values for custom fields and entry parameters align, then run an inventory job afterwards. Please see Changelog for the full list of many changes. See store type documentation below for reference.

Compatibility

This integration is compatible with Keyfactor Universal Orchestrator version 25.2 and later.

Support

The HP iLO Universal Orchestrator extension is open source and there is no SLA. Keyfactor will address issues and feature requests as resources become available. Keyfactor customers may request escalation by opening up a support ticket through their Keyfactor representative.

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute bug fixes or additional enhancements, use the Pull requests tab.

Requirements & Prerequisites

Before installing the HP iLO Universal Orchestrator extension, we recommend that you install kfutil. Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.

• Target Platform: HP iLO 6
• Tested HPiLO Firmware Versions: 1.58 and 1.69

HPiLO Certificate Store Type

To use the HP iLO Universal Orchestrator extension, you must create the HPiLO Certificate Store Type. This only needs to happen once per Keyfactor Command instance.

This document details supported certificate operations for HP iLO.

IncludeIP entry parameter should be set to false outside of HTTPSCert reenrollment/ODKG operation.

CertType entry parameter is required for all operations and should be set to the type of certificate the operation is carried out on.

Please review the description of each supported operation below to understand the requirements and limitations.

Supported Operations

Operation	Is Supported
Add	✅ Checked
Remove	✅ Checked
Discovery	🔲 Unchecked
Reenrollment	✅ Checked
Create	🔲 Unchecked

Store Type Creation

Using kfutil:

kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. For more information on kfutil check out the docs

Click to expand HPiLO kfutil details

Using online definition from GitHub:

This will reach out to GitHub and pull the latest store-type definition

# HP iLO Cert Store
kfutil store-types create HPiLO

Offline creation using integration-manifest file:

If required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.

kfutil store-types create --from-file integration-manifest.json

Manual Creation

Below are instructions on how to create the HPiLO store type manually in the Keyfactor Command Portal

Click to expand manual HPiLO details

Create a store type called HPiLO with the attributes in the tables below:

Basic Tab

Attribute	Value	Description
Name	HP iLO Cert Store	Display name for the store type (may be customized)
Short Name	HPiLO	Short display name for the store type
Capability	HPiLO	Store type name orchestrator will register with. Check the box to allow entry of value
Supports Add	✅ Checked	Check the box. Indicates that the Store Type supports Management Add
Supports Remove	✅ Checked	Check the box. Indicates that the Store Type supports Management Remove
Supports Discovery	🔲 Unchecked	Indicates that the Store Type supports Discovery
Supports Reenrollment	✅ Checked	Indicates that the Store Type supports Reenrollment
Supports Create	🔲 Unchecked	Indicates that the Store Type supports store creation
Needs Server	✅ Checked	Determines if a target server name is required when creating store
Blueprint Allowed	🔲 Unchecked	Determines if store type may be included in an Orchestrator blueprint
Uses PowerShell	🔲 Unchecked	Determines if underlying implementation is PowerShell
Requires Store Password	🔲 Unchecked	Enables users to optionally specify a store password when defining a Certificate Store.
Supports Entry Password	✅ Checked	Determines if an individual entry within a store can have a password.

The Basic tab should look like this:

Advanced Tab

Attribute	Value	Description
Supports Custom Alias	Optional	Determines if an individual entry within a store can have a custom Alias.
Private Key Handling	Optional	This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid.
PFX Password Style	Default	'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.)

The Advanced tab should look like this:

For Keyfactor Command versions 24.4 and later, a Certificate Format dropdown is available with PFX and PEM options. Ensure that PFX is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.

Custom Fields Tab

Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:

Name	Display Name	Description	Type	Default Value/Options	Required
InventoryAll	InventoryAll	If true, allows for inventory of additional factory-installed certificates and their chains: Platform Cert,SystemIAK,SystemIDevID, iLOIDevID/BMCIDevIDPCA	Bool	false	✅ Checked
IgnoreValidation	IgnoreValidation	WARNING: Only enable if testing. Used to disable certificate validation checks at the API endpoint. Should be set to false in any production scenario.	Bool	false	✅ Checked
HTTPSCertWaitTime	HTTPS Cert Wait Time	The HPiLO API requires the user to wait while the HTTPS Cert CSR is generated. HP suggests a time of 60 seconds, as is the default setting, but it can be adjusted.	String	60	✅ Checked

The Custom Fields tab should look like this:

Entry Parameters Tab

Name	Display Name	Description	Type	Default Value	Entry has a private key	Adding an entry	Removing an entry	Reenrolling an entry
IncludeIP	IncludeIP	Enables the addition of the device IP as a SAN to the CSR during reenrollment. Used particularly during HTTPSCert reenrollment, where it can be set as desired, and should be set to false during all other operations.	Bool	false	🔲 Unchecked	🔲 Unchecked	🔲 Unchecked	✅ Checked

The Entry Parameters tab should look like this:

Installation

1. Download the latest HP iLO Universal Orchestrator extension from GitHub.

   Navigate to the HP iLO Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine whether the net6.0 or net8.0 asset should be downloaded. Then, click the corresponding asset to download the zip archive.

   Universal Orchestrator Version	Latest .NET version installed on the Universal Orchestrator server	rollForward condition in Orchestrator.runtimeconfig.json	hp-ilo-orchestrator .NET version to download
   Older than 11.0.0			net6.0
   Between 11.0.0 and 11.5.1 (inclusive)	net6.0		net6.0
   Between 11.0.0 and 11.5.1 (inclusive)	net8.0	Disable	net6.0
   Between 11.0.0 and 11.5.1 (inclusive)	net8.0	LatestMajor	net8.0
   11.6 and newer	net8.0		net8.0

   Unzip the archive containing extension assemblies to a known location.

   Note If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for net6.0.

2. Locate the Universal Orchestrator extensions directory.

   • Default on Windows - C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions
   • Default on Linux - /opt/keyfactor/orchestrator/extensions

3. Create a new directory for the HP iLO Universal Orchestrator extension inside the extensions directory.

   Create a new directory called hp-ilo-orchestrator.

   The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.

4. Copy the contents of the downloaded and unzipped assemblies from step 2 to the hp-ilo-orchestrator directory.

5. Restart the Universal Orchestrator service.

   Refer to Starting/Restarting the Universal Orchestrator service.

6. (optional) PAM Integration

   The HP iLO Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.

   To configure a PAM provider, reference the Keyfactor Integration Catalog to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote).

The above installation steps can be supplemented by the official Command documentation.

Defining Certificate Stores

Store Creation

Manually with the Command UI

Click to expand details

1. Navigate to the Certificate Stores page in Keyfactor Command.

   Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.

2. Add a Certificate Store.

   Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.

   Attribute	Description
   Category	Select "HP iLO Cert Store" or the customized certificate store name from the previous step.
   Container	Optional container to associate certificate store with.
   Client Machine	Should contain a copy of the store path for compatibility reasons but is currently unused.
   Store Path	This should contain the path pointing to the HPiLO instance address, IP or domain name.
   Store Password	Password to use when reading/writing to store
   Orchestrator	Select an approved orchestrator capable of managing HPiLO certificates. Specifically, one with the HPiLO capability.
   InventoryAll	If true, allows for inventory of additional factory-installed certificates and their chains: Platform Cert,SystemIAK,SystemIDevID, iLOIDevID/BMCIDevIDPCA
   IgnoreValidation	WARNING: Only enable if testing. Used to disable certificate validation checks at the API endpoint. Should be set to false in any production scenario.
   HTTPSCertWaitTime	The HPiLO API requires the user to wait while the HTTPS Cert CSR is generated. HP suggests a time of 60 seconds, as is the default setting, but it can be adjusted.

Using kfutil CLI

Click to expand details

1. Generate a CSV template for the HPiLO certificate store

   kfutil stores import generate-template --store-type-name HPiLO --outpath HPiLO.csv

2. Populate the generated CSV file

   Open the CSV file, and reference the table below to populate parameters for each Attribute.

   Attribute	Description
   Category	Select "HP iLO Cert Store" or the customized certificate store name from the previous step.
   Container	Optional container to associate certificate store with.
   Client Machine	Should contain a copy of the store path for compatibility reasons but is currently unused.
   Store Path	This should contain the path pointing to the HPiLO instance address, IP or domain name.
   Store Password	Password to use when reading/writing to store
   Orchestrator	Select an approved orchestrator capable of managing HPiLO certificates. Specifically, one with the HPiLO capability.
   Properties.InventoryAll	If true, allows for inventory of additional factory-installed certificates and their chains: Platform Cert,SystemIAK,SystemIDevID, iLOIDevID/BMCIDevIDPCA
   Properties.IgnoreValidation	WARNING: Only enable if testing. Used to disable certificate validation checks at the API endpoint. Should be set to false in any production scenario.
   Properties.HTTPSCertWaitTime	The HPiLO API requires the user to wait while the HTTPS Cert CSR is generated. HP suggests a time of 60 seconds, as is the default setting, but it can be adjusted.

3. Import the CSV file to create the certificate stores

   kfutil stores import csv --store-type-name HPiLO --file HPiLO.csv

PAM Provider Eligible Fields

Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator

If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.

Attribute	Description
ServerUsername	Username to use when connecting to server
ServerPassword	Password to use when connecting to server
StorePassword	Password to use when reading/writing to store

Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.

Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.

The content in this section can be supplemented by the official Command documentation.

Inventory

The following certificates can be inventoried:

• HTTPS Certificate

  The TLS certificate used for connections to this iLO instance.

  Note: Only the HTTPS certificate used for iLO system/API connection via TLS can be inventoried, due to HP iLO API limitations.

• iLOLDevID

  Certificate used for 802.1X authentication.

• Additional Factory‑Installed Certificates
  (Require InventoryAll = True in Certificate Store Type)

  • Platform Cert
  • SystemIAK
  • SystemIDevID
  • iLOIDevID / BMCIDevIDPCA

Management Add (Addition to certificate store)

The following certificate supports addition to an HPiLO cert store:

• HTTPS Certificate:

  Performing this operation will import a specified PFX certificate and store the certificate and its private key in HPiLO. Only PFX certificates can be added. After the operation is complete, HPiLO will reboot. HP iLO will take in a cert with an RSA 2084 based key, similarly to HTTPS Cert reenrollment/ODKG.

  • Alias: HTTPSCert
  • Overwrite: Yes
    • Overwrite needs to be enabled.
  • IncludeIP: False

Management Remove (Removal from certificate store)

The following certificates can be deleted from an HPiLO cert store:

• HTTPS Certificate
  • IncludeIP: false
• iLOLDevID (802.1X Certificate)
  • IncludeIP: false

Reenrollment / ODKG

The following certificates can be undergo reenrollment/ODKG using an HPiLO cert store:

• HTTPS Certificate
  Following the reenrollment of an HTTPS certificate, HP iLO will reboot. The CSR produced by HP iLO for this purpose will utilize a RSA 2084 key. Please ensure your CA supports this algorithm and has an appropriate template configured.
  • Alias: HTTPSCert
  • Subject String Format:

    CN=test.demo.local, L=Example, ST=Example, C=Example, OU=Example, O=Example
    

    • Supported attributes: CN, O, OU, L, ST, C.
    • The CN must match the iLO FQDN.
    • Note: iLO will reboot after the certificate is installed.
  • IncludeIP If set to true, iLO will automatically add its IPv4/IPv6 addresses as SANs. The CN is added as a SAN automatically.
• iLOLDevID
  802.1X Certificate reenrollment. The CSR produced by HPiLO will utilize ECC 384 based key. Please setup an appropriate template and make sure your CA supports this algorithm.
  • Alias: 1/iLOLDevID
  • IncludeIP false
  • Subject String Format:
    The subject string contents depend on the version of HP iLO firmware you are using.

    Versions Below HPiLO 6 1.60

     CN=CZJ3199GDZ, O=Hewlett Packard Enterprise, OU=Servers, L=Houston, ST=TX, C=US
    

    • CN must match the iLO serial number, e.g. CZJ3199GDZ
    • Other attributes must match exactly for Keyfactor to correlate the CSR and resulting certificate.

    Versions HPiLO 6 1.60 and Above

     CN=P98765-B21, SURNAME=PYNXHC2ZGIE11U, GIVENNAME=P12345-001, SERIALNUMBER=CZJ3199GDZ, OU=Servers, O=Hewlett Packard Enterprise Development, L=Houston, ST=Texas, C=US
    

    • For complete details on the contents of these attributes, please see the HP iLO LDevID CSR documentation. There is a chart explaining the contents of these fields and their required values.

Manager Limitation:
Reenrollment and deletion are only supported on internal manager 1 (common in typical HP iLO deployments).
See the HP iLO API Reference for details.

License

Apache License 2.0, see LICENSE.

Related Integrations

See all Keyfactor Universal Orchestrator extensions.