dellemc.openmanage.idrac_os_deployment role – Role to deploy operating system on the iDRAC servers

Note

This role is part of the dellemc.openmanage collection (version 9.8.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.

To use it in a playbook, specify: dellemc.openmanage.idrac_os_deployment.

Entry point main – Role to deploy operating system on the iDRAC servers

New in dellemc.openmanage 7.5.0

Synopsis

  • Role to generate the custom iso using the kickstart configuration file and deploy operating system on the idrac servers.

Parameters

Parameter

Comments

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

delete_custom_iso

boolean

Deletes the Custom iso after the OS deployment is finshed.

ISO will be delete if delete_custom_iso is true and wait_for_os_deployment is true.

Choices:

  • false

  • true ← (default)

destination

dictionary

Share path to mount the ISO to iDRAC.

Share needs to have a write permission to copy the generated ISO.

CIFS, NFS, HTTP and HTTPS shares are supported.

destination is ignored when is_custom_iso is true

When the protocol is of http, https custom iso is copied into a destination location/folder where the web server content is served.

When the protocol is of cifs, c(nfs) custom iso is copied into the locally mounted nfs or cifs location location.

hostname

string / required

Target machine address/hostname where the custom iso will be copied.

Address/hostname used to mount the iso as a virtual media.

hostname is applicable to copy iso using ssh when protocol is http or https.

hostname will be defaulted to localhost to copy iso when protocol is nfs, cifs.

hostname will be used to mount the virtual media in idrac when protocol is http, https, nfs or cifs.

iso_name

string

Custom iso file name. If not specified defaulted to hostname-source.iso_name.

iso_path

path / required

Custom iso absolute path to be used to mount as a virtual media in idrac.

mountpoint

path / required

Target machine absolute path where the custom iso will be copied.

mountpoint will be path where http/https is served from when protocol is http, https.

mountpoint will be local folder mounted with nfs/cifs share when protocol is nfs cifs.

os_type

string

HTTP/HTTPS share based on linux/Windows.

Choices:

  • "linux" ← (default)

  • "windows"

password

string

Password of the http/https/cifs share where customized ISO is used to mount as a virtual media.

protocol

string / required

Type of the the transfer protocol used to mount the virtual media on to idrac.

https uses the ssh protocol to copy the custom iso to the mountpoint and uses https protocol to the mount the virtual media.

http uses the ssh protocol to copy the custom iso to the mountpoint and uses https protocol to the mount the virtual media.

nfs copies the the custom iso to the mountpoint mounted localy and uses nfs protocol to the mount the virtual media.

cifs copies the the custom iso to the mountpoint mounted localy and uses cifs protocol to the mount the virtual media.

Choices:

  • "https"

  • "http"

  • "nfs"

  • "cifs"

username

string

Username of the http/https/cifs share where customized ISO is used to mount as a virtual media.

eject_iso

boolean

Eject the virtual media (ISO) after the tracking of OS deployment is finished.

ISO will be ejected if eject_iso is true and wait_for_os_deployment is true.

Choices:

  • false

  • true ← (default)

hostname

string / required

iDRAC IP Address or hostname.

https_port

integer

iDRAC port.

Default: 443

https_timeout

integer

The socket level timeout in seconds.

Default: 30

os_deployment_timeout

integer

Time in minutes to wait for the OS deployment to finish.

Default: 30

os_name

string

The operating system name to match the jinja template of the kickstart file.

Supported os name is versions for RHEL and ESXI.

Jinja template file should exists in the format <os_name_upper>_<os_version_major>.j2

This is required when is_custom_iso is false.

os_version

string

The operating system version to match the jinja template of the kickstart file.

Supported versions for RHEL are 9.x and 8.x and for ESXi is 8.x.

Jinja template file should exists in the format <os_name_upper>_<os_version_major>.j2

This is required when is_custom_iso is false

password

string

iDRAC user password.

source

dictionary / required

HTTP/HTTPS share or local path of the ISO.

hostname

string

HTTP/HTTPS address to download the ISO.

Hostname of the http/https/cifs and nfs to mount the custom iso to virtual media.

hostname is applicable to download iso only when protocol is http or https and is_custom_iso is false.

hostname is ignored to download the iso when protocol is local, nfs or cifs and is_custom_iso is false.

hostname will be used to attach the virtual media when is_custom_iso is true.

is_custom_iso

boolean

Specifies the source iso is a custom iso.

true uses the custom iso and skips the kickstart file generation and custom iso compilation.

when true, destination is ignored and uses the iso_path to mount the virtual media on idrac.

false runs the the kickstart file generation and custom iso compilation

Choices:

  • false ← (default)

  • true

iso_name

string / required

Name of the iso file.

iso_path

path / required

Absolute local path or http/https share path of the iso.

when custom_iso true iso_path should be http, https, nfs or cifs path.

ks_path

path

Absolute local path or http/https share path kickstart file.

When ks_path is provided role skips the generation of kickstart file and uses the one provided in the input.

password

string

Password of the http, https and cifs share.

password is applicable only when protocol is http , https to download the iso file.

password is applicable to mount the custom iso as a virtual media in idrac when protocol is http , https, c(cifs) and is_custom_iso is true.

password is ignored when protocol is local.

protocol

string / required

Type of the the transfer protocol used to download the iso.

https uses the https protocol to download the iso.

http uses the http protocol to download the iso.

nfs uses the locally mounted nfs folder path to download the iso.

cifs uses the locally mounted cifs folder path to download the iso.

local uses the local folder path to download the iso.

If custom_iso_true is true this will be used to mount the custom iso to virtual media.

Choices:

  • "https"

  • "http"

  • "local"

  • "cifs"

  • "nfs"

username

string

Username of the http, https and cifs share.

username is applicable only when protocol is http , https to download the iso file.

username is applicable to mount the custom iso as a virtual media in idrac when protocol is http , https, c(cifs) and is_custom_iso is true.

username is ignored when protocol is local.

username

string

iDRAC username with admin privilages.

validate_certs

boolean

If False, the SSL certificates will not be validated.

Configure False only on personally controlled sites where self-signed certificates are used.

Choices:

  • false

  • true ← (default)

wait_for_os_deployment

boolean

Wait for the OS deployment to finish.

Choices:

  • false

  • true ← (default)