dellemc.openmanage.idrac_os_deployment (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

Boot to a network ISO image.

Requirements

• omsdk >= 1.2.488
• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Boot to Network ISO
  dellemc.openmanage.idrac_os_deployment:
      idrac_ip: "192.168.0.1"
      idrac_user: "user_name"
      idrac_password: "user_password"
      ca_path: "/path/to/ca_cert.pem"
      share_name: "192.168.0.0:/nfsfileshare"
      iso_image: "unattended_os_image.iso"
      expose_duration: 180

Inputs

    
ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

iso_image:
    description: Network ISO name.
    required: true
    type: str

idrac_port:
    default: 443
    description: iDRAC port.
    type: int

idrac_user:
    description:
    - iDRAC username.
    - If the username is not provided, then the environment variable C(IDRAC_USERNAME)
      is used.
    - 'Example: export IDRAC_USERNAME=username'
    required: true
    type: str

share_name:
    description: CIFS or NFS Network share.
    required: true
    type: str

share_user:
    description: Network share user in the format 'user@domain' or 'domain\\user' if user
      is part of a domain else 'user'. This option is mandatory for CIFS Network Share.
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description:
    - iDRAC user password.
    - If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
      is used.
    - 'Example: export IDRAC_PASSWORD=password'
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description: Network share user password. This option is mandatory for CIFS Network
      Share.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

expose_duration:
    default: 1080
    description: It is the time taken in minutes for the ISO image file to be exposed
      as a local CD-ROM device to the host server. When the time expires, the ISO image
      gets automatically detached.
    type: int

Outputs

boot_status:
  description: Details of the boot to network ISO image operation.
  returned: always
  sample:
    DeleteOnCompletion: 'false'
    InstanceID: DCIM_OSDConcreteJob:1
    JobName: BootToNetworkISO
    JobStatus: Success
    Message: The command was successful.
    MessageID: OSD1
    Name: BootToNetworkISO
    Status: Success
    file: 192.168.0.0:/nfsfileshare/unattended_os_image.iso
    retval: true
  type: dict
msg:
  description: Over all device information status.
  returned: on error
  sample: Failed to boot to network iso
  type: str