Dell EMC OpenManage Ansible Modules Version 1.1 User’s Guide OMAM Users

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 48

Dell EMC OpenManage Ansible Modules
Version 1.1 User’s Guide
Notes, cautions, and warnings
NOTE: A NOTE indicates important information that helps you make better use of your product.
CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem.
WARNING: A WARNING indicates a potential for property damage, personal injury, or death.
Dell EMC OpenManage Ansible Modules
Version 1.1
© Copyright 2018 Dell Inc.
GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective
owners.
2018 - 11
Rev. A00
Contents
1 Overview........................................................................................................................................................5
Key Features....................................................................................................................................................................... 5
What's new?.......................................................................................................................................................................5
2 Getting Started..............................................................................................................................................7
How OpenManage Ansible Modules works.................................................................................................................... 7
Running your rst Playbook.............................................................................................................................................. 7
3 Updating Firmware........................................................................................................................................ 8
Viewing Firmware Inventory............................................................................................................................................. 8
Installing Firmware............................................................................................................................................................. 9
4 Conguring PowerEdge Servers................................................................................................................... 11
Viewing LC Status............................................................................................................................................................. 11
Exporting Server Conguration Prole.......................................................................................................................... 12
Importing Server Conguration Prole.......................................................................................................................... 13
Conguring iDRAC............................................................................................................................................................15
Conguring iDRAC Users...........................................................................................................................................15
Conguring iDRAC Timezone.................................................................................................................................... 17
Conguring iDRAC Eventing..................................................................................................................................... 18
Conguring iDRAC Services..................................................................................................................................... 20
Conguring iDRAC Network.....................................................................................................................................22
Conguring BIOS............................................................................................................................................................. 25
Conguring RAID............................................................................................................................................................. 28
Conguring storage volume......................................................................................................................................30
Conguring Collect System Inventory on Restart....................................................................................................... 34
Conguring Syslog...........................................................................................................................................................35
5 Deploying operating system......................................................................................................................... 37
Boot to a Network ISO Image........................................................................................................................................ 37
6 Server Inventory..........................................................................................................................................39
Viewing the System Inventory....................................................................................................................................... 39
7 Server Administration Tasks.........................................................................................................................40
Conguring the Power State on the PowerEdge Servers..........................................................................................40
Resetting iDRAC............................................................................................................................................................... 41
Viewing LC Job Status.................................................................................................................................................... 42
Exporting LC Logs........................................................................................................................................................... 42
Deleting LC Job................................................................................................................................................................43
Deleting LC Job Queue................................................................................................................................................... 44
Conguring System Lockdown Mode........................................................................................................................... 45
Contents 3
8 Troubleshooting........................................................................................................................................... 47
9 Accessing documents from the Dell EMC support site.................................................................................48
4 Contents
Overview
Dell EMC OpenManage Ansible Modules allows data center and IT administrators to use RedHat Ansible to automate and orchestrate the
conguration, deployment, and update of Dell EMC PowerEdge Servers (12th generation of PowerEdge servers and later) by leveraging
the management automation capabilities in-built into the Integrated Dell Remote Access Controller (iDRAC).
This user guide provides information about using Dell EMC OpenManage Ansible Modules and its dierent use cases.
In addition to dell.com/support, you can download Ansible modules from https://github.com/dell/Dell-EMC-Ansible-Modules-for-iDRAC.
Modules that are downloaded from this GitHub location are supported by Dell EMC.
Topics:
• Key Features
• What's new?
Key Features
The key features in OpenManage Ansible Modules are:
• Export a server conguration prole (SCP) containing either the entire server conguration or component level conguration (iDRAC,
BIOS, RAID, NIC) to a local le path on Ansible controller or a remote network share.
• Import an SCP from a local le path on Ansible controller or a remote network share.
• Support for conguration of BIOS, Integrated Dell Remote Access Controller (iDRAC), NIC, and RAID.
• Support for rmware update using a Firmware Repository hosted on a remote network share.
• Support for viewing rmware inventory details.
• Support for Windows, Linux, and ESXi operating system deployments.
• Support for conguring power controls, resetting iDRAC, viewing Lifecycle Controller (LC) job status, deleting LC job, deleting LC job
queue, exporting LC logs, and conguring system lockdown mode.
• Retrieve the system inventory details.
NOTE: These features are supported only on iDRAC with enterprise license.
What's new?
• Added support for streaming the Server Conguration Prole (SCP) within the HTTP or HTTPS messages for import or export
operation to/from an iDRAC using Local le path on Ansible controller.
• A new and feature rich Storage Volume module (dellemc_idrac_storage_volume) to:
– Support RAID volume creation on BOSS Controller.
– View all the volumes for a RAID controller.
– Create multiple RAID volumes on a storage controller using a single Ansible task.
– Select physical disks either the respective Slot locations or Physical Disk IDs while creating a RAID volume.
– Support multiple VD creation on a disk group.
• The dellemc_congure_raid module is deprecated and all the functionality are added to the new dellemc_idrac_storage_volume
module.
• Enhanced BIOS conguration module to:
– Support conguration of all the BIOS attributes (such as boot settings, processor settings, memory settings, system and workload
proles, system security etc).
1
Overview 5
– Support Boot Source State modication using Redsh APIs — reorder, enable or disable boot source devices.
• Added support for providing a Custom Catalog le name while using rmware update from a DRM repository.
• Support for check mode — nd out whether conguration changes are available to be made to the servers.
• New and updated playbook examples.
6 Overview
Getting Started
How OpenManage Ansible Modules works
OpenManage Ansible modules uses iDRAC REST APIs based on Redsh standards and Server Conguration Proles (SCP) for automated
conguration, deployment and update of PowerEdge servers. An SCP contains all BIOS, iDRAC, Network and Storage settings of a
PowerEdge server. You can apply them to multiple servers, enabling rapid, reliable, and reproducible conguration.
You can perform an SCP operation using any of the following methods:
• Export to or import from a remote network share via CIFS, NFS. Ensure that the remote network share is mounted on the Ansible
controller with read-write privileges for user running the Ansible playbooks.
• Export or import via local le streaming (for iDRAC rmware 2.50.50.50 and above).
Setting up a local mount point for a remote network share
Mount the remote network share (CIFS or NFS) locally on the Ansible controller where you want to run the playbook or modules. Local
mount point should have read-write privileges in order for OpenManage Ansible modules to write an SCP le to remote network share that
will be imported by iDRAC.
NOTE: Refer to Linux man pages for mounting an NFS or CIFS network share on Ansible control machine.
Running your rst Playbook
To run a playbook:
1 Run the following command on the Ansible control machine:
ansible-playbook playbookname.yml
2 Press Enter.
With OpenManage Ansible Modules, you can construct a playbook with a set of modules resulting in a automation workow for
conguration, deployments, and updates of PowerEdge Servers.
To view the list of all available modules:
1 Run the following command on the Ansible control machine:
ansible-doc -l | grep "dellemc"
2 Press Enter.
List of the available modules is displayed.
To view the documentation of a module:
1 Run the following command on the Ansible control machine:
ansible-doc <module name>
2 Press Enter.
2
Getting Started 7
Updating Firmware
You can maintain up-to-date rmware versions of Dell EMC server components to get better eciency, security protection and enhanced
features. Create update sources to do the rmware update.
Following are the tasks for the rmware update activities:
Topics:
• Viewing Firmware Inventory
• Installing Firmware
Viewing Firmware Inventory
Command: dellemc_get_rmware_inventory
Synopsis
You can view the rmware inventory of a server using this module. This module displays components of a server and the corresponding
rmware versions.
Check_mode support: No
Options
Table 1. dellemc_get_rmware_inventory
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_username Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
Table 2. Return Values
Name Description Returned Type Sample
Firmware Inventory
• Components of a
server and their
rmware versions.
• List of dictionaries, 1
dictionary per
rmware.
Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_get_rmware_inventory.md
Examples
-name: Get Installed Firmware Inventory
dellemc_get_firmware_inventory:
3
8 Updating Firmware
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
Installing Firmware
Command: dellemc_install_rmware
Synopsis
You can install the rmware from a repository on a network share (CIFS, NFS) to keep the system updated.
• For 12th and 13th generation of PowerEdge servers, rmware update from a network repository is performed using WS-Man APIs.
• For 14th generation of PowerEdge servers, rmware update from a network repository is performed using the SCP.
To install the rmware:
• Make sure the network share contains a valid repository of Dell Update Packages (DUPs) and a catalog le that consists the latest
DUPs.
• All applicable updates contained in the repository are applied to the system.
Check_mode support: No
Options
Table 3. dellemc_install_rmware
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
job_wait Yes True • True
• False
• If the value is True, it
waits for update JOB
to get completed
• If the value is False, it
returns immediately
with a JOB ID after
queuing the update
JOB in the job queue
catalog_le_name No Catalog.xml NA Catalog le name relative
to the I(share_name).
reboot No False • True
• False
• If the value is True,
the system reboots
after applying the
updates
• If the value is False,
the system does not
reboot after applying
the updates
share_name Yes NA NA CIFS or NFS Network
share
Updating Firmware 9
Parameter Required Default Choices Comments
share_user No NA NA
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.
share_pwd No NA NA
Network share user
password. This option is
mandatory for CIFS
Network share.
share_mnt Yes NA NA
Local mount path of the
network share with read-
write permission for
ansible user. This option is
mandatory for Network
share.
Table 4. Return Values
Name Description Returned Type Sample
Firmware Updates rmware from a repository
on a network share (CIFS, NFS) Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_install_rmware.md
Example
-name: Update firmware from a repository on a Network Share
dellemc_install_firmware:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
share_mnt: "/mnt/share"
reboot: "True"
job_wait: "True"
catalog_file_name: "Catalog.xml"
10 Updating Firmware
Conguring PowerEdge Servers
Integrated Dell Remote Access Controller (iDRAC) with LC provide the ability to generate a human-readable representation of server
conguration using Server Conguration Prole (SCP) feature. This le contains BIOS, iDRAC, LC, network, and RAID conguration
settings. You can modify this le as per your need and apply to other servers.
The SCP feature is used in the Ansible module to automate the conguration activity of PowerEdge servers and their components.
NOTE: OpenManage Ansible Modules version 1.1 supports iDRAC rmware version 2.50.50.50 and later.
Topics:
• Viewing LC Status
• Exporting Server Conguration Prole
• Importing Server Conguration Prole
•Conguring iDRAC
•Conguring BIOS
•Conguring RAID
•Conguring Collect System Inventory on Restart
•Conguring Syslog
Viewing LC Status
Module: dellemc_get_lcstatus
Synopsis
You can view the LC status on a PowerEdge server using this module. You must check the readiness of the LC before carrying out any
conguration or update. This module returns the LC readiness as True or False and its status.
Check_mode support: No
Options
Table 5. dellemc_get_lcstatus
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
4
Conguring PowerEdge Servers 11
Table 6. Return Values
Name Description Returned Type Sample
LC status Displays the LC status on
a PowerEdge server Success String
https://github.com/dell/Dell-EMC-
Ansible-Modules-for-iDRAC/blob/
master/samples/
dellemc_get_lcstatus.md
Example
-name: Get LC Status
dellemc_get_lcstatus:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
Exporting Server Conguration Prole
Module: dellemc_export_server_cong_prole
Synopsis
You can export Server Conguration Prole (SCP) with various components such as iDRAC, BIOS, NIC, RAID together or with one of
these components. You can export SCP from iDRAC to a local or a network shared location. For shared location, make sure that a network
share path is established.
Check_mode support: No
Options
Table 7. dellemc_export_server_cong_prole
Parameter Required Default Choices Comments
export_format No XML • JSON
• XML The output le format
export_use No Default
• Default
• Clone
• Replace
• If C(Default), will export the SCP using
the Default method
• If C(Clone), will export the SCP using the
Clone method
• If C(Replace), will export the SCP using
the Replace method
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
job_wait Yes NA • True
• False
• If the value is True, it waits for the SCP
export job to nish and returns the job
completion status
• If the value is False, it returns immediately
with a JOB ID after queuing the SCP
export job in LC job queue
12 Conguring PowerEdge Servers
Parameter Required Default Choices Comments
share_name Yes NA NA CIFS or NFS network share or a local path
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
scp_components No ALL
• ALL
• iDRAC
• BIOS
• NIC
• RAID
Specify the hardware components
conguration to be exported
• If ALL, the module exports all components
congurations in SCP le
• If iDRAC, the module exports iDRAC
conguration in SCP le
• If BIOS, the module exports BIOS
conguration in SCP le
• If NIC, the module exports NIC
conguration in SCP le
• If RAID, the module exports RAID
conguration in SCP le
Table 8. Return Values
Name Description Returned Type Sample
Export SCP Exports the SCP to the provided
network share or to the local path Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-
for-iDRAC/blob/master/samples/
dellemc_export_server_cong_prole.md
Example
-name: Export Server Configuration Profile (SCP)
dellemc_export_server_config_profile:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
export_format: "XML"
export_use: "Default"
job_wait: "True"
Importing Server Conguration Prole
Module: dellemc_import_server_cong_prole
Synopsis
You can import an SCP le (in an XML or JSON format) exported from a golden PowerEdge server conguration to one or more servers,
thus achieving an eortless, consistent, and automated deployment. Importing an SCP le is useful in restoring the conguration of the
server to the state stored in the prole.
You can import SCP from a local or a remote share to iDRAC. For a remote share, make sure that a network share path and the le name
are available. If there are component congurations (such as BIOS, RAID, NIC, iDRAC, and so on) present in the SCP le that require a
server restart, you can use the I(shutdown_type) argument to specify whether a Graceful or Forced shutdown of the server is required.
Conguring PowerEdge Servers 13
Check_mode support: No
Options
Table 9. dellemc_import_server_cong_prole
Parameter Required Default Choices Comments
end_host_power_state No On • On
•O
• If On, End host power is on
• If O, End host power is o
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
job_wait Yes NA • True
• False
• If the value is True, it waits for the SCP
import job to nish and returns the job
completion status
• If the value is False, it returns immediately
with a JOB ID after queuing the SCP
import job in LC job queue
scp_components No ALL
• ALL
• iDRAC
• BIOS
• NIC
• RAID
• If ALL, the module imports all components
congurations from SCP le
• If iDRAC, the module imports iDRAC
conguration from SCP le
• If BIOS, the module imports BIOS
conguration from SCP le
• If NIC, the module imports NIC
conguration from SCP le
• If RAID, the module imports RAID
conguration from SCP le
scp_le Yes NA NA Server Conguration Prole le name
share_name Yes NA NA Network share or a local path
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
shutdown_type No Graceful
• Graceful
• Forced
• NoReboot
• If Graceful, it gracefully shuts down the
server
• If Forced, it forcefully shuts down the
system
• If NoReboot, it does not reboot the server
14 Conguring PowerEdge Servers
Table 10. Return Values
Name Description Returned Type Sample
Import SCP Imports SCP from a network
share or from a local le Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_import_server_cong_prole.md
Example
-name: Import Server Configuration Profile
dellemc_import_server_config_profile
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
scp_file: "scp_file.xml"
scp_components: "ALL"
job_wait: "True"
Conguring iDRAC
Following are the modules responsible for conguring specic iDRAC attributes.
Conguring iDRAC Users
Module: dellemc_congure_idrac_users
Synopsis
This module creates, modies or deletes an iDRAC local user.
Check_mode support: Yes
Options
Table 11. dellemc_congure_idrac_users
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share or a local path
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
Conguring PowerEdge Servers 15
Parameter Required Default Choices Comments
share_mnt No NA NA
Local mount path of the network share with
read-write permission for Ansible user. This
option is mandatory for CIFS or NFS Network
share.
action No create
• create
• delete
• modify
This value decides whether to create or
delete or modify iDRAC user
user_name No NA NA Provide the username to be created or
deleted or modied
user_password No NA NA Provide the password for the user to be
created or modied
privilege_users No NA
• NoAccess
• Readonly
• Operator
• Administrator
Privilege user access is congurable
ipmilanprivilege_users No NA
• No_Access
• Administrator
• Operator
• User
IPMI Lan Privilege user access is congurable
ipmiserialprivilege_users No NA
• No_Access
• Administrator
• Operator
• User
IPMI Serial Privilege user access is
congurable
NOTE: This parameter is not
supported by PowerEdge Modular
servers.
enable_users No NA • Enabled
• Disabled Enabling or Disabling the new iDRAC user
solenable_users No NA • Enabled
• Disabled Enabling or Disabling SOL for iDRAC user
protocolenable_users No NA • Enabled
• Disabled Enabling or Disabling protocol for iDRAC user
authenticationprotocol_u
sers No NA
• T_None
• SHA
• MD5
Conguring authentication protocol for
iDRAC user
privacyprotocol_users No NA
• T_None
• DES
• AES
Conguring privacy protocol for iDRAC user
16 Conguring PowerEdge Servers
Table 12. Return Values
Name Description Returned Type Sample
iDRAC users Congures the iDRAC users
attributes Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-for-
iDRAC/blob/master/samples/
dellemc_congure_idrac_users.md
Example
-name: Configure the iDRAC users attributes
dellemc_configure_idrac_users:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_pwd: "xxxxxxxx"
share_user: "xxxx"
share_mnt: "/mnt/share"
action: "create"
user_name: "username"
user_password: "xxxxxxxx"
privilege_users: "Administrator"
ipmilanprivilege_users: "Administrator"
ipmiserialprivilege_users: "Administrator"
enable_users: "Enabled"
solenable_users: "Enabled"
protocolenable_users: "Enabled"
authenticationprotocol_users: "SHA"
privacyprotocol_users: "AES"
Conguring iDRAC Timezone
Module: dellemc_congure_idrac_timezone
Synopsis
This module congures the iDRAC timezone related attributes.
Check_mode support: Yes
Options
Table 13. dellemc_congure_idrac_timezone
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share or a local path
share_user No NA NA
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.
Conguring PowerEdge Servers 17
Parameter Required Default Choices Comments
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
share_mnt No NA NA
Local mount path of the network share with
read-write permission for Ansible user. This
option is mandatory for CIFS or NFS Network
share.
setup_idrac_timezone No NA NA Conguring the timezone for iDRAC
enable_ntp No NA NA Whether to Enable or Disable NTP for iDRAC
ntp_server_1 No NA NA NTP conguration for iDRAC
ntp_server_2 No NA NA NTP conguration for iDRAC
ntp_server_3 No NA NA NTP conguration for iDRAC
Table 14. Return Values
Name Description Returned Type Sample
iDRAC Timezone Congures the iDRAC timezone
attributes Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_congure_idrac_timezone.md
Example
-name: Configure the iDRAC timezone attributes
dellemc_configure_idrac_timezone:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_pwd: "xxxxxxxx"
share_user: "xxxx"
share_mnt: "/mnt/share"
setup_idrac_timezone: "UTC"
enable_ntp: "Enabled"
ntp_server_1: "x.x.x.x"
ntp_server_2: "x.x.x.x"
ntp_server_3: "x.x.x.x"
Conguring iDRAC Eventing
Module: dellemc_congure_idrac_eventing
Synopsis
This module congures iDRAC eventing related attributes.
Check_mode support: Yes
Options
18 Conguring PowerEdge Servers
Table 15. dellemc_congure_idrac_eventing
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share or a local
path
share_user No NA NA
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.
share_pwd No NA NA
Network share user password. This
option is mandatory for CIFS Network
share.
share_mnt No NA NA
Local mount path of the network share
with read-write permission for Ansible
user. This option is mandatory for CIFS
or NFS Network share.
destination_number No None NA Destination number for SNMP Trap
destination No None NA Destination for SNMP Trap
snmp_v3_username No NA NA SNMP v3 username for SNMP Trap
snmp_trap_state No NA • Enabled
• Disabled
Whether to Enable or Disable SNMP
alert
email_alert_state No NA • Enabled
• Disabled Whether to Enable or Disable Email alert
alert_number No None NA Alert number for Email conguration
address No NA NA Email address for SNMP Trap
custom_message No NA NA Custom message for SNMP Trap
reference
enable_alerts No NA • Enabled
• Disabled
Whether to Enable or Disable iDRAC
alerts
authentication No NA • Enabled
• Disabled
Simple Mail Transfer Protocol
Authentication
smtp_ip_address No NA NA SMTP IP address for communication
smtp_port No None NA SMTP Port number for access
username No None NA Username for SMTP authentication
Conguring PowerEdge Servers 19
Parameter Required Default Choices Comments
password No None NA Password for SMTP authentication
Table 16. Return Values
Name Description Returned Type Sample
iDRAC eventing Congures the iDRAC eventing
attributes
Success String https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_congure_idrac_eventing.md
Example
-name: Configure the iDRAC eventing attributes
dellemc_configure_idrac_eventing:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_pwd: "xxxxxxxx"
share_user: "xxxx"
share_mnt: "/mnt/share"
destination_number: "xxxx"
destination: "xxxx"
snmp_v3_username: "xxxx"
snmp_trap_state: "xxxx"
email_alert_state: "xxxx"
alert_number: "xxxx"
address: "xxxxxxxxxx"
custom_message: "xxxx"
enable_alerts: "xxxxxx"
authentication: "xxxxxx"
smtp_ip_address: "x.x.x.x"
smtp_port: "xxxx"
username: "xxxx"
password: "xxxxxxxx"
Conguring iDRAC Services
Module: dellemc_congure_idrac_services
Synopsis
This module congures the iDRAC services related attributes.
Check_mode support: Yes
Options
Table 17. dellemc_congure_idrac_services
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
20 Conguring PowerEdge Servers
Parameter Required Default Choices Comments
share_name Yes NA NA CIFS or NFS Network share or a local
path
share_user No NA NA
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.
share_pwd No NA NA
Network share user password. This
option is mandatory for CIFS Network
share.
share_mnt No NA NA
Local mount path of the network share
with read-write permission for Ansible
user. This option is mandatory for CIFS
or NFS Network share.
enable_web_server No NA • Enabled
• Disabled
Whether to Enable or Disable web
server conguration for iDRAC
ssl_encryption No NA
• Auto_Negotiate
• T_128_Bit_or_higher
• T_168_Bit_or_higher
• T_256_Bit_or_higher
Secure Socket Layer encryption for
web server
tls_protocol No NA
• TLS_1_0_and_Higher
• TLS_1_1_and_Higher
• TLS_1_2_Only
Transport Layer Security for web
server
https_port No NA NA HTTPS access port
http_port No NA NA HTTP access port
timeout No NA NA Timeout value
snmp_enable No NA • Enabled
• Disabled
Whether to Enable or Disable SNMP
protocol for iDRAC
snmp_protocol No NA • All
• SNMPv3 Type of the SNMP protocol
community_name No test NA SNMP community name for iDRAC
alert_port No None NA SNMP alert port for iDRAC
discovery_port No 162 NA SNMP discovery port for iDRAC
trap_format No None NA SNMP trap format for iDRAC
Conguring PowerEdge Servers 21
Table 18. Return Values
Name Description Returned Type Sample
iDRAC services Congures the iDRAC services
attributes Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_congure_idrac_services.md
Example
-name: Configure the iDRAC services attributes
dellemc_configure_idrac_services:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_pwd: "xxxxxxxx"
share_user: "xxxx"
share_mnt: "/mnt/share"
enable_web_server: "Enabled"
http_port: "80"
https_port: "443"
ssl_encryption: "Auto_Negotiate"
tls_protocol: "TLS_1_2_Only"
timeout: "1800"
snmp_enable: "Enabled"
snmp_protocol: "SNMPv3"
community_name: "test"
alert_port: "None"
discovery_port: "162"
trap_format: "None"
Conguring iDRAC Network
Module: dellemc_congure_idrac_network
Synopsis
This module congures the iDRAC networking attributes.
Check_mode support: Yes
Options
Table 19. dellemc_congure_idrac_network
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share or a local path
share_user No NA NA
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.
22 Conguring PowerEdge Servers
Parameter Required Default Choices Comments
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
share_mnt No NA NA
Local mount path of the network share with
read-write permission for Ansible user. This
option is mandatory for CIFS or NFS Network
share.
setup_idrac_nic_vlan No NA NA Conguring the VLAN-related setting for
iDRAC
register_idrac_on_dns No NA • Enabled
• Disabled Registering Domain Name System for iDRAC
dns_idrac_name No NA NA DNS Name for iDRAC
auto_cong No NA • Enabled
• Disabled Automatically creates the records for DNS
static_dns No NA NA Static conguration for DNS
vlan_id No None NA Conguring the VLAN ID for iDRAC
vlan_priority No None NA Conguring the VLAN priority for iDRAC
enable_nic No NA • Enabled
• Disabled
Whether to Enable or Disable Network
Interface Controller for iDRAC
nic_selection No NA
• Dedicated
• LOM1
• LOM2
• LOM3
• LOM4
Selecting Network Interface Controller types
for iDRAC
failover_network No NA
• ALL
• LOM1
• LOM2
• LOM3
• LOM4
• T_None
Failover Network Interface Controller types for
iDRAC
auto_detect No NA • Enabled
• Disabled
Auto detect Network Interface Controller
types for iDRAC
auto_negotiation No NA • Enabled
• Disabled
Auto negotiation of Network Interface
Controller for iDRAC
network_speed No NA
• T_10
• T_100
• T_1000
Network speed for Network Interface
Controller types for iDRAC
Conguring PowerEdge Servers 23
Parameter Required Default Choices Comments
duplex_mode No NA • Full
• Half
Transmission of data Network Interface
Controller types for iDRAC
nic_mtu No None NA NIC Maximum Transmission Unit
ip_address No NA NA IP Address needs to be dened
enable_dhcp No NA NA Whether to Enable or Disable DHCP Protocol
for iDRAC
dns_from_dhcp No NA • Enabled
• Disabled
Specifying Domain Name System from
Dynamic Host Conguration Protocol
enable_ipv4 No NA • Enabled
• Disabled
Whether to Enable or Disable IPv4
conguration
static_dns_1 No NA NA Specify Domain Name System Conguration
static_dns_2 No NA NA Specify Domain Name System Conguration
static_gateway No None NA Interfacing the network with another protocol
static_net_mask No None NA Determine whether IP address belongs to host
Table 20. Return Values
Name Description Returned Type Sample
iDRAC network Congures the iDRAC network
attributes Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-
for-iDRAC/blob/master/samples/
dellemc_congure_idrac_network.md
Example
-name: Configure the iDRAC network attributes
dellemc_configure_idrac_network:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_pwd: "xxxxxxxx"
share_user: "xxxx"
share_mnt: "/mnt/share"
register_idrac_on_dns: "Enabled'
dns_idrac_name: "None"
auto_config: "None"
static_dns: "None"
setup_idrac_nic_vlan: "Enabled"
vlan_id: "0"
vlan_priority: "1"
enable_nic: "Enabled"
nic_selection: "Dedicated"
failover_network: "T_None"
auto_detect: "Disabled"
auto_negotiation: "Enabled"
network_speed: "T_1000"
duplex_mode: "Full"
nic_mtu: "1500"
ip_address: "x.x.x.x"
enable_dhcp: "Enabled"
24 Conguring PowerEdge Servers
dns_from_dhcp: "Enabled"
enable_ipv4: "Enabled"
static_dns_1: "x.x.x.x"
static_dns_2: "x.x.x.x"
static_gateway: "None"
static_net_mask: "None"
Conguring BIOS
Module: dellemc_congure_bios
Synopsis
This module congures the BIOS attributes for PowerEdge servers.
Check_mode support: Yes
Options
Table 21. dellemc_congure_bios
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name No NA NA CIFS or NFS network share or a local path
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option
is mandatory for CIFS Network share.
share_mnt No NA NA
Local mount path of the network share with
read-write permission for Ansible user. This
option is mandatory for CIFS or NFS
Network share.
boot_mode No NA • Bios
•Ue
(deprecated) Congures the boot mode to
BIOS or UEFI.
NOTE: This option has been
deprecated, and will be removed in
the later version. Please use the
I(attributes) for BIOS attributes
conguration instead.
NOTE: I(boot_mode) is mutually
exclusive with I(boot_sources).
boot_sequence No NA NA
(deprecated) Boot devices' FQDDs in the
sequential order for BIOS or UEFI Boot
Sequence.
Conguring PowerEdge Servers 25
Parameter Required Default Choices Comments
Provide the I(boot_mode) option to
determine the appropriate boot sequence
to be applied.
NOTE: This option has been
deprecated, and will be removed in
the later version. Please use the
I(attributes) or I(boot_sources) for
Boot Sequence modication
instead.
NOTE: I(boot_sequence) is
mutually exclusive with
I(boot_sources).
nvme_mode No NA • NonRaid
• Raid
(deprecated) Congures the NVME mode
in the 14th generation of PowerEdge
servers.
NOTE: This option has been
deprecated, and will be removed in
the later version. Please use the
I(attributes) for BIOS attributes
conguration instead.
NOTE: I(nvme_mode) is mutually
exclusive with I(boot_sources).
secure_boot_mode No NA
• AuditMode,
• DeployedMode
• SetupMode
• UserMode
(deprecated) Congures how the BIOS
uses the Secure Boot Policy Objects in the
14th generation of PowerEdge servers.
NOTE: This option has been
deprecated, and will be removed in
the later version. Please use the
I(attributes) for BIOS attributes
conguration instead.
NOTE: I(secure_boot_mode) is
mutually exclusive with
I(boot_sources).
onetime_boot_mode No NA
• Disabled
• OneTimeBootSeq
• OneTimeCustomBootSeqSt
r
• OneTimeCustomHddSeqStr
•OneTimeCustomUeBootS
eqStr
• OneTimeHddSeq
•OneTimeUeBootSeq
(deprecated) Congures the one time boot
mode setting.
NOTE: This option has been
deprecated, and will be removed in
the later version. Please use the
I(attributes) for BIOS attributes
conguration instead.
NOTE: I(onetime_boot_mode) is
mutually exclusive with
I(boot_sources).
attributes No NA NA
Dictionary of BIOS attributes and value pair.
Attributes should be part of the Redsh Dell
BIOS Attribute Registry. Redsh URI to
26 Conguring PowerEdge Servers
Parameter Required Default Choices Comments
view BIOS attributes: (https://I(idrac_ip)/
redsh/v1/Systems/System.Embedded.1/
Bios).
If deprecated options are given and the
same are repeated in I(attributes) then
values in I(attributes) will take precedence.
NOTE: I(attributes) is mutually
exclusive with I(boot_sources).
boot_sources No NA NA
List of boot devices to set the boot sources
settings. Boot devices are dictionary.
While applying boot sequence, Index of at
least one boot device should be 0.
NOTE: I(boot_sources) is mutually
exclusive with I(attributes),
I(boot_sequence),
I(onetime_boot_mode),
I(secure_boot_mode),
I(nvme_mode), and I(boot_mode).
NOTE: When user does not provide
Index or Enabled value in
boot_sources option,
dellemc_congure_bios module
uses the current Index or
Enabled value from the target
server for the specied boot source
while applying boot sources.
NOTE: In case the selected Index
or Enabled value from the target
server conicts with any of the
boot_sources option values to be
applied, dellemc_congure_bios
module may fail to apply with
appropriate error message.
Table 22. Return Values
Name Description Returned Type Sample
BIOS Congures the BIOS conguration
attributes Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_congure_bios.md
Examples
-name: Configure BIOS Generic attributes
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
attributes:
BootMode : "Bios"
Conguring PowerEdge Servers 27
OneTimeBootMode: "Enabled"
BootSeqRetry: "Enabled"
- name: Configure PXE Generic Attributes
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
attributes:
PxeDev1EnDis: "Enabled"
PxeDev1Protocol: "IPV4"
PxeDev1VlanEnDis: "Enabled"
PxeDev1VlanId: x
PxeDev1Interface: "NIC.Embedded.x-x-x"
PxeDev1VlanPriority: x
- name: Configure Boot Sources
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
boot_sources:
- Name : "NIC.Integrated.x-x-x"
Enabled : True
Index : 0
- name: Configure Boot Sources
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
boot_sources:
- Name : "NIC.Integrated.x-x-x"
Enabled : True
Index : 0
- Name : "NIC.Integrated.x-x-x"
Enabled : true
Index : 1
- Name : "NIC.Integrated.x-x-x"
Enabled : true
Index : 2
- name: Configure Boot Sources - Enabled
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
boot_sources:
- Name : "NIC.Integrated.x-x-x"
Enabled : True
- name: Configure Boot Sources - Index
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
boot_sources:
- Name : "NIC.Integrated.x-x-x"
Index : 0
Conguring RAID
Module: dellemc_congure_raid
Synopsis
This module hosts the RAID conguration related attributes.
NOTE: This module is deprecated and replaced with dellemc_idrac_storage_volume.
28 Conguring PowerEdge Servers
Options
Table 23. dellemc_congure_raid
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share or a local
path
share_user No NA NA
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.
share_pwd No NA NA
Network share user password. This
option is mandatory for CIFS
Network share.
share_mnt No NA NA
Local mount path of the network
share with read-write permission for
Ansible user. This option is mandatory
for Network share.
vd_name No NA NA
Virtual disk name
• Optional, if we perform create
operations
• Mandatory, if we perform remove
operations
span_depth No 1 NA Span Depth
span_length No 2 NA Span Length
number_dedicated_hot_spare No 0 NA Number of Dedicated Hot Spare
number_global_hot_spare No 0 NA Number of Global Hot Spare
raid_level No RAID 0
• RAID 0
• RAID 1
• RAID 5
• RAID 6
• RAID 10
• RAID 50
• RAID 60
Provide the required RAID level
disk_cache_policy No Default
• Default
• Enabled
• Disabled
Disk Cache Policy
Conguring PowerEdge Servers 29
Parameter Required Default Choices Comments
write_cache_policy No WriteThrough
• WriteThrough
• WriteBack
• WriteBackForce
Write cache policy
read_cache_policy No NoReadAhead
• NoReadAhead
• ReadAhead
• Adaptive
Read cache policy
stripe_size No 65536 NA Provide stripe size value in multiples
of 64 * 1024
controller_fqdd Yes NA NA
Fully Qualied Device Descriptor
(FQDD) of the storage controller, for
e.g. RAID.Integrated.1-1
media_type No HDD • HDD
• SSD Media type
bus_protocol No SATA • SAS
• SATA Bus protocol
state Yes NA • present
• absent
• If the value is 'present', the
module will perform 'create'
operations
• If the value is 'absent', the module
will perform 'remove' operations
Table 24. Return Values
Name Description Returned Type Sample
RAID
conguration
Congures the RAID conguration
attributes Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_congure_raid.md
Example
-name: Configure the RAID attributes
dellemc_configure_raid:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_pwd: "xxxxxxxx"
share_user: "xxxx"
share_mnt: "xxxxxx"
controller_fqdd: "xxxxxxxx"
vd_name: "xxxxxx"
Conguring storage volume
Module: dellemc_idrac_storage_volume
Synopsis
30 Conguring PowerEdge Servers
This module hosts the RAID conguration related attributes.
Check_mode support: Yes
Options
Table 25. dellemc_idrac_storage_volume
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
span_depth No 1 NA Span Depth
span_length No 1 NA Span Length
number_dedicated_hot_s
pare
No 0 NA Number of Dedicated Hot Spare
volume_type No RAID 0 • RAID 0
• RAID 1
• RAID 5
• RAID 6
• RAID 10
• RAID 50
• RAID 60
Provide the required RAID level
disk_cache_policy No Default • Default
• Enabled
• Disabled
Disk Cache Policy
write_cache_policy No WriteThrough • WriteThrough
• WriteBack
• WriteBackForce
Write Cache Policy
read_cache_policy No NoReadAhead • NoReadAhead
• ReadAhead
• AdaptiveReadAhead
Read Cache Policy
stripe_size No 65536 NA Provide stripe size value in multiples of 64 *
1024
controller_id No NA NA Fully Qualied Device Descriptor (FQDD) of
the storage controller, for example:
RAID.Integrated.1-1
NOTE: Controller FQDD is required for
C(create) RAID conguration.
Conguring PowerEdge Servers 31
Parameter Required Default Choices Comments
volume_id No NA NA Fully Qualied Device Descriptor (FQDD) of
the virtual disk, for example:
Disk.virtual.0:RAID.Slot.1-1
NOTE: This option is used to get the
virtual disk information.
media_type No None • HDD
• SDD
Media type
protocol No None • SAS
• SATA
Bus protocol
state Yes view • create
• delete
• view
• If C(create), the module will perform
create operations
• If C(delete), the module will perform
remove operations
• If C(view), the module will return storage
view
volumes No NA NA A list of virtual disk-specic iDRAC attributes.
This is applicable for C(create) and C(delete)
operations.
• For C(create) operation, name and drives
are applicable options, other volume
options can also be specied.
NOTE: The drives is a required
option for C(create) operation and
accepts either location (list of
drive slot) or id (list of drive fqdd).
• For C(delete) operation, only name option
is applicable.
capacity No NA NA Virtual disk size in GB
raid_reset_cong No NA NA This option represents whether a Reset Cong
operation needs to be performed on the RAID
controller. Reset Cong operation deletes all
the virtual disks present on the RAID controller.
raid_init_operation No None • None
• Fast
This option represents Initialization
Conguration operation to be performed on
the virtual disk.
Table 26. Return Values
Name Description Returned Type Sample
Storage volume
conguration
Congures the RAID conguration
related attributes Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_idrac_storage_volume.md
Examples
-name: Create single volume
dellemc_idrac_storage_volume:
32 Conguring PowerEdge Servers
idrac_ip: "xx.xxx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
controller_id: "RAID.Slot.1-1"
state: "create"
volumes:
- drives:
location: [5]
-name: Create multiple volume
dellemc_idrac_storage_volume:
idrac_ip: "xx.xxx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
raid_reset_config: "True"
state: "create"
controller_id: "RAID.Slot.1-1"
volume_type: "RAID 1"
span_depth: 1
span_length: 2
number_dedicated_hot_spare: 1
disk_cache_policy: "Enabled"
write_cache_policy: "WriteBackForce"
read_cache_policy: "ReadAhead"
stripe_size: 65536
capacity: 100
raid_init_operation: "Fast"
volumes:
- name: "volume_1"
drives:
id: ["Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1",
"Disk.Bay.2:Enclosure.Internal.0-1:RAID.Slot.1-1"]
- name: "volume_2"
volume_type: "RAID 5"
span_length: 3
span_depth: 1
drives:
location: [7,3,5]
disk_cache_policy: "Disabled"
write_cache_policy: "WriteBack"
read_cache_policy: "NoReadAhead"
stripe_size: 131072
capacity: 200
raid_init_operation: "None"
-name: View all volume details
dellemc_idrac_storage_volume:
idrac_ip: "xx.xxx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
state: "view"
-name: View specific volume details
dellemc_idrac_storage_volume:
idrac_ip: "xx.xxx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
state: "view"
controller_id: "RAID.Slot.1-1"
volume_id: "Disk.Virtual.0:RAID.Slot.1-1"
-name: Delete single volume
dellemc_idrac_storage_volume:
idrac_ip: "xx.xxx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
state: "delete"
Conguring PowerEdge Servers 33
volumes:
- name: "volume_1"
-name: Delete multiple volume
dellemc_idrac_storage_volume:
idrac_ip: "xx.xxx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
state: "delete"
volumes:
- name: "volume_1"
- name: "volume_2"
Conguring Collect System Inventory on Restart
Module: dellemc_idrac_lc_attributes
Synopsis
This module is responsible for enabling or disabling of Collect System Inventory on Restart (CSIOR) property for all iDRAC or LC jobs.
When you enable the CSIOR property, hardware inventory and part conguration information are discovered and compared with previous
system inventory information on every system restart.
Check_mode support: Yes
Options
Table 27. dellemc_idrac_lc_attributes
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS network share or a local path
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
share_mnt No NA NA
Local mount path of the network share with
read-write permission for Ansible user. This option
is mandatory for CIFS or NFS Network share.
csior Yes NA • Enabled
• Disabled
Whether to Enable or Disable Collect System
Inventory on Restart (CSIOR) property for all
iDRAC or LC jobs
34 Conguring PowerEdge Servers
Table 28. Return Values
Name Description Returned Type Sample
iDRAC CSIOR Congures CSIOR property for all
iDRAC or LC jobs Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_idrac_lc_attributes.md
Example
-name: Set up iDRAC LC Attributes
dellemc_idrac_lc_attributes:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxxx"
share_pwd: "xxxxxxxx"
share_mnt: "/mnt/share"
csior: "xxxxxxx"
Conguring Syslog
Module: dellemc_setup_idrac_syslog
Synopsis
This module enables or disables syslog parameters for iDRAC.
Check_mode support: Yes
Options
Table 29. dellemc_setup_idrac_syslog
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share or a
local path
share_user No NA NA
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.
share_pwd No NA NA
Network share user password.
This option is mandatory for
CIFS Network share.
share_mnt No NA NA
Local mount path of the network
share with read-write permission
for Ansible user. This option is
Conguring PowerEdge Servers 35
Parameter Required Default Choices Comments
mandatory for CIFS or NFS
Network share.
syslog Yes NA • Enabled
• Disabled
Whether to Enable or Disable
iDRAC syslog
Table 30. Return Values
Nam Description Returned Type Sample
iDRAC Syslog Congures iDRAC Syslog
parameters Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_setup_idrac_syslog.md
Example
-name: Configure iDRAC Syslog Parameters
dellemc_setup_idrac_syslog:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
share_mnt: "/mnt/share"
syslog: "xxxxxxx"
36 Conguring PowerEdge Servers
Deploying operating system
To provision a bare metal server, it is essential to deploy the required operating system in the device before you start using it. This section
describes the process of deploying the operating system on the PowerEdge servers using Ansible.
To automate the process of operating system deployment in an unattended manner using Ansible, the iDRAC's capability is utilized to
transfer the customized ISO to iDRAC for boot.
To perform OS deployment, ensure:
• Operating system image is injected with required Dell drivers, and unattended response le.
• iDRAC is enabled, congured, and reachable.
• RAID is congured.
Boot to a Network ISO Image
Module: dellemc_boot_to_network_iso
Synopsis
This module facilitates the operating system deployment. You can run this module to boot the target system to a bootable ISO image on a
CIFS or NFS share. This module looks for the customized ISO in the congured share location and transfers the image to iDRAC to load it.
On the system reboot, the OS deployment begins.
Check_mode support: No
Options
Table 31. dellemc_boot_to_network_iso
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC password
idrac_port No 443 NA iDRAC port
iso_image Yes NA NA Network ISO name
share_name Yes NA NA CIFS or NFS Network share
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option is
mandatory for CIFS Network share.
5
Deploying operating system 37
Table 32. Return Values
Name Description Returned Type Sample
Boot to Network ISO Boots to a network ISO
Image Success String
https://github.com/dell/Dell-EMC-
Ansible-Modules-for-iDRAC/blob/
master/samples/
dellemc_boot_to_network_iso.md
Example
-name: Boot to Network ISO
dellemc_boot_to_network_iso:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
iso_image: "uninterrupted_os_installation_image.iso"
38 Deploying operating system
Server Inventory
This section describes the process of retrieving the server inventory of the PowerEdge Servers using Ansible Modules.
Viewing the System Inventory
Module: dellemc_get_system_inventory
Synopsis
System inventory provides basic and component level detailed inventory information. You can run this module when you want to verify the
asset, congured state, inventory, and health-related information for the system and its component.
Check_mode support: No
Options
Table 33. dellemc_get_system_inventory
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
Table 34. Return Values
Name Description Returned Type Sample
System
Inventory
Displays the PowerEdge Server
System Inventory Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-
for-iDRAC/blob/master/samples/
dellemc_get_system_inventory.md
Example
-name: Get System Inventory
dellemc_get_system_inventory:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
6
Server Inventory 39
Server Administration Tasks
This section describes the tasks that you can run using OpenManage Ansible Modules version 1.1.
NOTE: OpenManage Ansible Modules version 1.1 supports iDRAC rmware version 2.50.50.50 and later.
Topics:
•Conguring the Power State on the PowerEdge Servers
• Resetting iDRAC
• Viewing LC Job Status
• Exporting LC Logs
• Deleting LC Job
• Deleting LC Job Queue
•Conguring System Lockdown Mode
Conguring the Power State on the PowerEdge
Servers
Module: dellemc_change_power_state
Synopsis
This module congures the power control options on a PowerEdge server. You can run this module:
• To turn on the server.
• To turn o the server.
• To reboot the server.
• For hard reset of the server.
Check_mode support: Yes
Options
Table 35. dellemc_change_power_state
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
change_power Yes NA
• On
•ForceO
• GracefulRestart
Desired power state
7
40 Server Administration Tasks
Parameter Required Default Choices Comments
• GracefulShutdown
• PushPowerButton
• Nmi
Table 36. Return Values
Name Description Returned Type Sample
Power state of a
server
Congures the power control
options on a PowerEdge
server
Success String
https://github.com/dell/Dell-EMC-Ansible-
Modules-for-iDRAC/blob/master/samples/
dellemc_change_power_state.md
Example
-name: Change Power State
dellemc_change_power_state:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
change_power: "xxxxxxx"
Resetting iDRAC
Module: dellemc_idrac_reset
Synopsis
You can reset the iDRAC using this module.
Check_mode support: Yes
Options
Table 37. dellemc_idrac_reset
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
Table 38. Return Values
Name Description Returned Type Sample
Reset
iDRAC
Resets the iDRAC Success String https://github.com/dell/Dell-EMC-Ansible-Modules-for-
iDRAC/blob/master/samples/dellemc_idrac_reset.md
Example
-name: Reset iDRAC
dellemc_idrac_reset:
idrac_ip: "xx.xx.xx.xx"
Server Administration Tasks 41
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
idrac_port: "xxx"
Viewing LC Job Status
Module: dellemc_get_lc_job_status
Synopsis
You can view the iDRAC or LC job status using this module. To view information about a job status, a job id is required. After a job is
initiated, the system stages the job request information and sends a job id back to the system. You can query the progress and status of
the job by using the job id.
Check_mode support: No
Options
Table 39. dellemc_get_lc_job_status
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
job_id Yes NA NA JOB ID in the format
"JID_123456789012"
Table 40. Return Values
Name Description Returned Type Sample
LC Job Status Displays the status of an
LC job Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-for-
iDRAC/blob/master/samples/
dellemc_get_lc_job_status.md
Example
-name: Get LC Job Status
dellemc_get_lc_job_status
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
job_id: "JID_1234567890"
Exporting LC Logs
Module: dellemc_export_lc_logs
Synopsis
LC logs provide records of past activities on a managed system. These log les are useful for the server administrators since they provide
detailed information about recommended actions and some other technical information that is useful for troubleshooting purposes.
42 Server Administration Tasks
The various types of information available in LC logs are alerts-related, conguration changes on the system hardware components,
rmware changes due to an upgrade or downgrade, replaced parts, temperature warnings, detailed timestamps of when the activity has
started, severity of the activity, and so on.
Check_mode support: No
Options
Table 41. dellemc_export_lc_logs
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS Network share
share_user No NA NA
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.
share_pwd No NA NA Network share user password. This option is mandatory
for CIFS Network share.
job_wait Yes NA • True
• False
• If the value is True, it waits for the job to complete
and returns the job completion status
• If the value is False, it returns immediately with a
JOB ID after queuing the job in LC job queue
Table 42. Return Values
Name Description Returned Type Sample
LC logs Exports the LC logs to the given
network share Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-
for-iDRAC/blob/master/samples/
dellemc_export_lc_logs.md
Example
-name: Export Lifecycle Controller Logs
dellemc_export_lc_logs:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
idrac_port: "xxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
job_wait: "True"
Deleting LC Job
Module: dellemc_delete_lc_job
Synopsis
This module deletes an LC job for a given valid JOB ID from the job queue.
Server Administration Tasks 43
You can delete an LC job:
• after the job is completed.
• if you do not want to perform the job or if it is taking long to execute.
Check_mode support: Yes
Options
Table 43. dellemc_delete_lc_job
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
job_id Yes NA NA JOB ID in the format
"JID_XXXXXXXXX"
Table 44. Return Values
Name Description Returned Type Sample
Delete LC job Deletes an LC job for a given a
JOB ID Success String https://github.com/dell/Dell-EMC-Ansible-Modules-for-
iDRAC/blob/master/samples/dellemc_delete_lc_job.md
Examples
-name: Delete LC Job
dellemc_delete_lc_job:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxx"
idrac_port: "xxx"
job_id: "JID_XXXXXXXX"
Deleting LC Job Queue
Module: dellemc_delete_lc_job_queue
Synopsis
You can delete all the jobs in the LC job queue using this module. All the jobs in the job queue are terminated when you delete a job queue.
Check_mode support: No
Options
Table 45. dellemc_delete_lc_job_queue
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
44 Server Administration Tasks
Parameter Required Default Choices Comments
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
Table 46. Return Values
Name Description Returned Type Sample
LC Job Queue Deletes the LC job
queue Success String https://github.com/dell/Dell-EMC-Ansible-Modules-for-iDRAC/
blob/master/samples/dellemc_delete_lc_job_queue.md
Example
-name: Delete LC Job Queue
dellemc_delete_lc_job_queue:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxx"
idrac_port: "xxx"
Conguring System Lockdown Mode
Module: dellemc_system_lockdown_mode
Synopsis
System Lockdown Mode provides a mechanism to protect conguration from any unintentional or accidental changes after the system is
provisioned to a certain level.
This module is responsible for enabling or disabling the lockdown mode of a system. When System Lockdown Mode is enabled, the
system’s conguration is locked and system cannot be congured or updated until the lockdown mode is disabled.
Check_mode support: No
Options
Table 47. dellemc_system_lockdown_mode
Parameter Required Default Choices Comments
idrac_ip Yes NA NA iDRAC IP Address
idrac_user Yes NA NA iDRAC username
idrac_pwd Yes NA NA iDRAC user password
idrac_port No 443 NA iDRAC port
share_name Yes NA NA CIFS or NFS network share or a local path
share_user No NA NA
Network share user in the format 'user@domain'
or user\domain if user is part of a domain else
'user'. This eld is mandatory for CIFS Network
Share.
share_pwd No NA NA Network share user password. This eld is
mandatory for CIFS Network Share.
Server Administration Tasks 45
Parameter Required Default Choices Comments
share_mnt No NA NA
Local mount path of the network share with read-
write permission for Ansible user. This option is
mandatory for CIFS or NFS Network share.
lockdown_mode Yes NA • Enabled
• Disabled
Whether to Enable or Disable system lockdown
mode
Table 48. Return Values
Name Description Returned Type Sample
System Lockdown
Mode
Congures lockdown
mode of the system Success String
https://github.com/dell/Dell-EMC-Ansible-Modules-for-
iDRAC/blob/master/samples/
dellemc_system_lockdown_mode.md
Example
-name: Configure System Lockdown Mode
dellemc_system_lockdown_mode:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "xx.xx.xx.xx:/share"
share_user: "xxxx"
share_pwd: "xxxxxxxx"
share_mnt: "/mnt/share"
lockdown_mode: "xxxxxxx"
46 Server Administration Tasks
Troubleshooting
• While creating new iDRAC users, the provided values are not getting applied completely on 14G servers.
— In case the user is not created with all the required user settings, change the user setting with action option modify in the
dellemc_congure_idrac_users module.
8
Troubleshooting 47
Accessing documents from the Dell EMC support
site
You can access the required documents using the following links:
• For Dell EMC Enterprise Systems Management documents — www.dell.com/esmmanuals
• For Dell EMC OpenManage documents — www.dell.com/openmanagemanuals
• For Dell EMC Remote Enterprise Systems Management documents — www.dell.com/esmmanuals
• For iDRAC and Dell Lifecycle Controller documents — www.dell.com/idracmanuals
• For Dell EMC OpenManage Connections Enterprise Systems Management documents — www.dell.com/esmmanuals
• For Dell EMC Serviceability Tools documents — www.dell.com/serviceabilitytools
•a Go to www.dell.com/support.
b Click Browse all products.
c From All products page, click Software, and then click the required link from the following:
–Analytics
–Client Systems Management
–Enterprise Applications
–Enterprise Systems Management
–Public Sector Solutions
–Utilities
–Mainframe
–Serviceability Tools
–Virtualization Solutions
–Operating Systems
–Support
d To view a document, click the required product and then click the required version.
• Using search engines:
– Type the name and version of the document in the search box.
9
48 Accessing documents from the Dell EMC support site

Navigation menu