dellemc.openmanage.idrac_secure_boot module – Import secure boot certificate.
Note
This module is part of the dellemc.openmanage collection (version 9.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.idrac_secure_boot
.
New in dellemc.openmanage 9.6.0
Synopsis
This module allows to import the secure boot certificate.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
A list of absolute paths of the Database certificate file for UEFI secure boot. |
|
A list of absolute paths of the Disallow Database certificate file for UEFI secure boot. |
|
iDRAC IP Address. |
|
iDRAC user password. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
iDRAC port. Default: |
|
iDRAC username. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
Import all the specified key certificates. When import_certificates is Choices:
|
|
Whether to wait till completion of the secure boot certificate operation. This is applicable when restart is Choices:
|
|
The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
|
A list of absolute paths of the Key Exchange Key (KEK) certificate file for UEFI secure boot. |
|
The absolute path of the Platform key certificate file for UEFI secure boot. |
|
Secure boot certificate import operation requires a server restart. This parameter provides an option to restart the server.
restart is applicable when import_certificates is Choices:
|
|
Restart type of the server.
restart_type is applicable when restart is Choices:
|
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Runs task to validate without performing action on the target machine. |
|
Support: none |
Runs the task to report the changes made or to be made. |
Notes
Note
This module will always report changes found to be applied when run in
check mode
.This module does not support idempotency when import_certificates is provided.
This module supports IPv4 and IPv6 addresses.
Examples
---
- name: Import multiple SecureBoot certificate without applying to iDRAC.
dellemc.openmanage.idrac_secure_boot:
idrac_ip: "192.168.1.2"
idrac_user: "user"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
import_certificates: true
platform_key: /user/name/certificates/pk.pem
KEK:
- /user/name/certificates/kek1.pem
- /user/name/certificates/kek2.pem
database:
- /user/name/certificates/db1.pem
- /user/name/certificates/db2.pem
disallow_database:
- /user/name/certificates/dbx1.pem
- /user/name/certificates/dbx2.pem
- name: Import a SecureBoot certificate and restart the server to apply it.
dellemc.openmanage.idrac_secure_boot:
idrac_ip: "192.168.1.2"
idrac_user: "user"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
import_certificates: true
platform_key: /user/name/certificates/pk.pem
restart: true
job_wait_timeout: 600
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Status of the secure boot operation. Returned: always Sample: |