HP iLO Universal Orchestrator Extension

Support · Installation · License · Related Integrations

Overview

The HPiLO orchestrator extension allows for management certificates on HP Integrated Lights-Out (iLO) remote server management technology embedded in HPE servers.

HPiLO

The HPiLO store type is used to manage the HTTPS certificate used for connection to the HPiLO UI/API.

Inventory:

• The HTTPS Cert used for connection to this instance of HPiLO Note: At present, only the HTTPS certificate used for connection to the HPiLO system/API can be inventoried, due to the limitations of the HP iLO API.
• iLOLDevID (Certificate used for 802.1x authentication)

This extension also supports inventory of the following factory-installed certificates (with the InventoryAll custom field set to True in Certificate Store Type configuration):

• Platform Cert
• SystemIAK
• SystemIDevID
• iLOIDevID/BMCIDevIDPCA

Management (delete):

• HTTPS Cert
• iLOLDevID (802.1x Cert)

Re-enrollment:

• HTTPS Cert
• iLOLDevID (802.1x Cert)
  Note: Re-enrollment is only supported for certificates hosted on internal manager 1 (a scenario typical for an HPiLO deployment). Please see HP iLO API Reference for reference on managers. Due to the way the HPiLO API is set up, to perform re-enrollment, the CN field must be set to the FQDN of the HPiLO instance. The FQDN typically follows a pattern of ILOXXXXXXXXXX. If re-enrolling the HTTPS Certificate, the CN must be set to include the full FQDN string, including the "ILO" characters, as ILOXXXXXXXXXX. For re-enrollment of the iLOLDevID certificate, it should be just the remaining characters of the FQDN string, without the "ILO", as XXXXXXXXXX.

Compatibility

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

Support

The HP iLO Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed 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.

The account the Universal Orchestrator is running under needs to have read/write access to the .json file.

This orchestrator extension was written to work with HP iLO 6.

Create the 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.

• Create HPiLO using kfutil:

  # HP iLO Cert Store
  kfutil store-types create HPiLO

• Create HPiLO manually in the Command UI:

  Create HPiLO manually in the Command UI

  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	Forbidden	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	Allows for inventory of factory-installed certificates: 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.	Bool	true	✅ 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:

  

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.

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

Defining Certificate Stores

• Manually with the Command UI

  Create Certificate Stores manually in the UI

  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	Runs on a Windows based machine.
     Store Path	Path points to the HPiLO instance address, IP or domain name.
     Orchestrator	Select an approved orchestrator capable of managing HPiLO certificates. Specifically, one with the HPiLO capability.
     InventoryAll	Allows for inventory of factory-installed certificates: Platform Cert,SystemIAK,SystemIDevID, iLOIDevID/BMCIDevIDPCA
     IgnoreValidation	WARNING: Only enable if testing. Used to disable certificate validation checks at the API endpoint.
     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

  Create Certificate Stores with kfutil

  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	Runs on a Windows based machine.
     Store Path	Path points to the HPiLO instance address, IP or domain name.
     Orchestrator	Select an approved orchestrator capable of managing HPiLO certificates. Specifically, one with the HPiLO capability.
     InventoryAll	Allows for inventory of factory-installed certificates: Platform Cert,SystemIAK,SystemIDevID, iLOIDevID/BMCIDevIDPCA
     IgnoreValidation	WARNING: Only enable if testing. Used to disable certificate validation checks at the API endpoint.
     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

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

License

Apache License 2.0, see LICENSE.

Related Integrations

See all Keyfactor Universal Orchestrator extensions.