dellemc.openmanage.idrac_os_deployment – Boot to a network ISO image

Note

This plugin is part of the dellemc.openmanage collection (version 3.0.0).

To install it use: ansible-galaxy collection install dellemc.openmanage.

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

New in version 2.1.0: of dellemc.openmanage

Synopsis

  • Boot to a network ISO image.

Requirements

The below requirements are needed on the host that executes this module.

  • omsdk
  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
expose_duration
integer
Default:
1080
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.
idrac_ip
string / required
iDRAC IP Address.
idrac_password
string / required
iDRAC user password.

aliases: idrac_pwd
idrac_port
integer
Default:
443
iDRAC port.
idrac_user
string / required
iDRAC username.
iso_image
string / required
Network ISO name.
share_name
string / required
CIFS or NFS Network share.
share_password
string
Network share user password. This option is mandatory for CIFS Network Share.

aliases: share_pwd
share_user
string
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.

Notes

Note

  • Run this module from a system that has direct access to DellEMC iDRAC.
  • This module does not support check_mode.

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
boot_status
dictionary
always
Details of the boot to network ISO image operation.

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}
msg
string
on error
Over all device information status.

Sample:
Failed to boot to network iso


Authors

  • Felix Stephen (@felixs88)
  • Jagadeesh N V (@jagadeeshnv)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/idrac_os_deployment_module.html