Dell EMC OpenManage Ansible Modules

Version 1.0.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.0.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 - 04

Rev. A01
 Contents

1 Overview........................................................................................................................................................5
Key Features....................................................................................................................................................................... 5

2 Getting Started..............................................................................................................................................6
How OpenManage Ansible Modules works.................................................................................................................... 6
Running your first Playbook.............................................................................................................................................. 6

3 Updating Firmware.........................................................................................................................................7
Viewing Firmware Inventory..............................................................................................................................................7
Installing Firmware............................................................................................................................................................. 8

4 Configuring PowerEdge Servers...................................................................................................................10

Viewing LC Status............................................................................................................................................................ 10
Exporting Server Configuration Profile........................................................................................................................... 11
Importing Server Configuration Profile.......................................................................................................................... 12
Configuring iDRAC............................................................................................................................................................14
Configuring iDRAC Users...........................................................................................................................................14
Configuring iDRAC Timezone....................................................................................................................................16
Configuring iDRAC Eventing......................................................................................................................................17
Configuring iDRAC Services......................................................................................................................................18
Configuring iDRAC Network.....................................................................................................................................20
Configuring BIOS............................................................................................................................................................. 23
Configuring RAID............................................................................................................................................................. 25
Configuring Collect System Inventory on Restart........................................................................................................27
Configuring Syslog........................................................................................................................................................... 28

5 Deploying Operating System....................................................................................................................... 30

Boot to a Network ISO Image........................................................................................................................................ 30

6 Server Inventory.......................................................................................................................................... 32
Viewing the System Inventory........................................................................................................................................32

7 Server Administration Tasks.........................................................................................................................33

Configuring the Power State on the PowerEdge Servers..........................................................................................33
Resetting iDRAC to Factory Settings............................................................................................................................ 34
Viewing LC Job Status.................................................................................................................................................... 35
Exporting LC Logs........................................................................................................................................................... 35
Deleting LC Job................................................................................................................................................................36
Deleting LC Job Queue....................................................................................................................................................37
Configuring System Lockdown Mode........................................................................................................................... 38

8 Troubleshooting........................................................................................................................................... 40

Contents 3
 9 Accessing documents from the Dell EMC support site................................................................................. 41

4 Contents
 1
Overview
Dell EMC OpenManage Ansible Modules allows Data Center and IT administrators to use RedHat Ansible to automate and orchestrate the
configuration, 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 version 1.0.1 and its different use cases.

In addition to dell.com/support, Ansible modules can also be downloaded from https://github.com/dell/Dell-EMC-Ansible-Modules-for-

iDRAC. Modules downloaded from this Github location are supported by Dell EMC.

Key Features
The key features in OpenManage Ansible Modules version 1.0.1 are:

• Export a server configuration profile (SCP) of Basic Input Output System (BIOS), Redundant Array of Independent Disks (RAID),
Network Interface Controller (NIC), and so on, to a local file path or a network share.
• Import an SCP from a local file path or a network share.
• Support for configuration of BIOS, integrated Dell Remote Access Controller (iDRAC), NIC, and RAID.
• Support for firmware update.
• Support for viewing firmware inventory details.
• Support for Windows, Linux, and ESXi operating system deployments.
• Support for configuring power controls, resetting iDRAC, viewing LC job status, deleting LC job, deleting LC job queue, exporting LC
logs, and configuring system lockdown mode.
• Retrieve the system inventory details.

Overview 5
 2
Getting Started
How OpenManage Ansible Modules works
OpenManage Ansible modules uses the Server Configuration Profile (SCP) for most of the configuration management, deployment, and
update of PowerEdge Servers. An SCP contains all BIOS, iDRAC, LC, Network and Storage settings of a PowerEdge server. You can apply
them to multiple servers, enabling rapid, reliable, and reproducible configuration.

You can perform an SCP operation using any of the following methods:

• Export to or import from a remote network share via CIFS, NFS.

• Export or import via local file streaming (for iDRAC firmware 3.00.00.00 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 control machine 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 file 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 first 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 workflow for
configuration, 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.

6 Getting Started
 3
Updating Firmware
You can maintain up-to-date firmware versions of Dell EMC server components to get better efficiency, security protection and enhanced
features. Create update sources to do the firmware update.

Following are the tasks for the firmware update activities:

Topics:

• Viewing Firmware Inventory

• Installing Firmware

Viewing Firmware Inventory

Command: dellemc_get_firmware_inventory

Synopsis

You can view the firmware inventory of a server using this module. This module displays components of a server and the corresponding
firmware versions.

Options

Table 1. dellemc_get_firmware_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

• Components of a
server and their
firmware versions. https://github.com/dell/Dell-EMC-Ansible-
Firmware Inventory Success String
• List of dictionaries, Modules-for-iDRAC
one dictionary per
firmware.

Examples
-name: Get Installed Firmware Inventory
dellemc_get_firmware_inventory:

Updating Firmware 7
 idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"

Installing Firmware
Command: dellemc_install_firmware

Synopsis

You can install the firmware from a repository on a network share (CIFS, NFS) to keep the system updated.

To install the firmware:

• Make sure the network share contains a valid repository of Dell Update Packages (DUPs) and a catalog file that consists the latest
DUPs.
• All applicable updates contained in the repository is applied to the system.

NOTE: This feature is only available with iDRAC Enterprise License.

Options

Table 3. dellemc_install_firmware

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

• If the value is True, it

waits for update JOB
to get completed
• True • If the value is False, it
job_wait Yes NA
• False returns immediately
with a JOB ID after
queuing the update
JOB in the job queue

• If the value is True,

the system reboots
after applying the
• True updates
reboot No False
• False • If the value is False,
the system does not
reboot after applying
the updates

CIFS or NFS Network

share_name Yes NA NA
share

Network share user in the

format 'user@domain' if
share_user Yes NA NA
user is part of a domain
else 'user'

8 Updating Firmware
 Network share user
share_pwd Yes NA NA
password

Local mount path of the

network share with read-
share_mnt Yes NA NA
write permission for
ansible user

Table 4. Return Values

Name Description Returned Type Sample

Updates firmware from a repository https://github.com/dell/Dell-EMC-Ansible-

Firmware Success String
on a network share (CIFS, NFS) Modules-for-iDRAC

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"

Updating Firmware 9
 4
Configuring PowerEdge Servers
Integrated Dell Remote Access Controller (iDRAC) with LC provide the ability to generate a human-readable representation of server
configuration using Server Configuration Profile (SCP) feature. This file contains BIOS, iDRAC, LC, network, and RAID configuration
settings. You can modify this file as per your need and apply to other servers.

The SCP feature is used in the Ansible module to automate the configuration activity of PowerEdge servers and their components.

NOTE: OpenManage Ansible Modules version 1.0.1 supports iDRAC firmware version 2.50.50.50 and later.

Topics:

• Viewing LC Status
• Exporting Server Configuration Profile
• Importing Server Configuration Profile
• Configuring iDRAC
• Configuring BIOS
• Configuring RAID
• Configuring Collect System Inventory on Restart
• Configuring Syslog

Viewing LC Status
Module: dellemc_get_lcstatus

Synopsis

You can view the LC status on a PowerEdge server using this module. You need to check the readiness of the LC before carrying out any
configuration or update. This module returns the LC readiness as True or False and its status.
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

10 Configuring PowerEdge Servers

Table 6. Return Values

Name Description Returned Type Sample

Displays the LC status on https://github.com/dell/Dell-EMC-
LC status Success String
a PowerEdge server Ansible-Modules-for-iDRAC

Example

-name: Get LC Status

dellemc_get_lcstatus:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"

Exporting Server Configuration Profile

Module: dellemc_export_server_config_profile

Synopsis

You can export Server Configuration Profile (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.

Options

Table 7. dellemc_export_server_config_profile

Parameter Required Default Choices Comments

• JSON
export_format No XML The output file format
• XML

• Default
The type of server configuration profile
export_use No Default • Clone
(SCP) to be exported
• Replace

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 NA NA iDRAC port

• If the value is True, it waits for the

SCP export job to finish and returns
the job completion status
• True
job_wait Yes NA • If the value is False, it returns
• False immediately with a JOB ID after
queuing the SCP export job in LC job
queue

CIFS or NFS network share or a local

share_name Yes NA NA
path
Network share user in the format
share_user No NA NA
'user@domain'

Configuring PowerEdge Servers 11

share_pwd No NA NA Network share user password
Specify the hardware component(s)
configuration to be exported

• If ALL, the module exports all

components configurations in SCP
• ALL file
• IDRAC • If IDRAC, the module exports iDRAC
scp_components No ALL • BIOS configuration in SCP file
• NIC • If BIOS, the module exports BIOS
configuration in SCP file
• RAID
• If NIC, the module exports NIC
configuration in SCP file
• If RAID, the module exports RAID
configuration in SCP file

Table 8. Return Values

Name Description Returned Type Sample

Exports the SCP to the provided https://github.com/dell/Dell-EMC-Ansible-Modules-
Export SCP Success String
network share or to the local path for-iDRAC

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 Configuration Profile

Module: dellemc_import_server_config_profile

Synopsis

You can import the SCP which was previously exported for that same server, or group of servers. Importing SCP is useful in restoring the
configuration of the server to the state stored in the profile.

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 file name
are available. If the import file Import.xml specifies some configuration changes that require a server restart (such as in iDRAC, BIOS, NIC,
or RAID configuration), you can use the shutdown_type parameter to specify whether a Graceful or a Forced shutdown of the server is
required.

Options

Table 9. dellemc_import_server_config_profile

Parameter Required Default Choices Comments

end_host_power_state No On • On • If On, End host power is on

12 Configuring PowerEdge Servers

 • Off • If Off, End host power is off

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

• If the value is True, it waits for the SCP

import job to finish and returns the job
• True completion status
job_wait Yes NA
• False • If the value is False, it returns
immediately with a JOB ID after queuing
the SCP import job in LC job queue

• If ALL, the module imports all

components configurations from SCP
file
• ALL • If IDRAC, the module imports iDRAC
• IDRAC configuration from SCP file
scp_components No ALL • BIOS • If BIOS, the module imports BIOS
• NIC configuration from SCP file
• RAID • If NIC, the module imports NIC
configuration from SCP file
• If RAID, the module imports RAID
configuration from SCP file

scp_file Yes NA NA Server Configuration Profile file name

share_name Yes NA NA Network share or a local path
Network share user in the format
share_user No NA NA 'user@domain' if user is part of a domain
else 'user'
share_pwd No NA NA Network share user password

• If Graceful, it gracefully shuts down the

server
• Graceful
• If Forced, it forcefully shuts down the
shutdown_type No Graceful • Forced system
• NoReboot • If NoReboot, it does not reboot the
server

Table 10. Return Values

Name Description Returned Type Sample

Imports SCP from a network https://github.com/dell/Dell-EMC-Ansible-
Import SCP Success String
share or from a local file Modules-for-iDRAC

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"

Configuring PowerEdge Servers 13

 share_user: "xxxx"
share_pwd: "xxxxxxxx"
scp_file: "scp_file.xml"
scp_components: "ALL"
job_wait: "True"

Configuring iDRAC
Following are the modules responsible for configuring specific iDRAC attributes.

Configuring iDRAC Users

Module: dellemc_configure_idrac_users
Synopsis
This module configures the iDRAC user management activities.

Options

Table 11. dellemc_configure_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

Network share user in the format

share_user No NA NA 'user@domain' if user is part of a domain
else 'user'

share_pwd No NA NA Network share user password

Local mount path of the network share

share_mnt No NA NA
with read-write permission for ansible user

• create
This value decides whether to create or
action No create • delete
delete or modify iDRAC user
• modify

Provide the username to be created or

user_name No NA NA
deleted or modified

Provide the password for the user to be

user_password No NA NA
created or modified

• NoAccess
• Readonly
privilege_users No NA Privilege user access is configurable
• Operator
• Administrator

14 Configuring PowerEdge Servers

 • No_Access
• Administrator IPMI Lan Privilege user access is
ipmilanprivilege_users No NA
• Operator configurable
• User

IPMI Serial Privilege user access is

• No_Access configurable
• Administrator
ipmiserialprivilege_users No NA NOTE: This parameter is not
• Operator
supported by PowerEdge Modular
• User
servers.

• Enabled
enable_users No NA Enabling or Disabling the new iDRAC user
• Disabled

• Enabled
solenable_users No NA Enabling or Disabling SOL for iDRAC user
• Disabled

• Enabled Enabling or Disabling protocol for iDRAC

protocolenable_users No NA
• Disabled user

• T_None
authenticationprotocol_u Configuring authentication protocol for
No NA • SHA
sers iDRAC user
• MD5

• T_None
Configuring privacy protocol for iDRAC
privacyprotocol_users No NA • DES
user
• AES

Table 12. Return Values

Name Description Returned Type Sample

Configures the iDRAC users https://github.com/dell/Dell-EMC-Ansible-Modules-for-

iDRAC users Success String
attributes iDRAC

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"

Configuring PowerEdge Servers 15

 protocolenable_users: "Enabled"
authenticationprotocol_users: "SHA"
privacyprotocol_users: "AES"

Configuring iDRAC Timezone

Module: dellemc_configure_idrac_timezone
Synopsis
This module configures the iDRAC timezone related attributes.

Options

Table 13. dellemc_configure_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

Network share user in the format

share_user No NA NA 'user@domain' if user is part of a domain else
'user'

share_pwd No NA NA Network share user password

Local mount path of the network share with

share_mnt No NA NA
read-write permission for ansible user

setup_idrac_timezone No NA NA Configuring the timezone for iDRAC

enable_ntp No NA NA Whether to Enable or Disable NTP for iDRAC

ntp_server_1 No NA NA NTP configuration for iDRAC

ntp_server_2 No NA NA NTP configuration for iDRAC

ntp_server_3 No NA NA NTP configuration for iDRAC

Table 14. Return Values

Name Description Returned Type Sample

Configures the iDRAC timezone https://github.com/dell/Dell-EMC-Ansible-

iDRAC Timezone Success String
attributes Modules-for-iDRAC

Example
-name: Configure the iDRAC timezone attributes
dellemc_configure_idrac_timezone:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"

16 Configuring PowerEdge Servers

 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"

Configuring iDRAC Eventing

Module: dellemc_configure_idrac_eventing
Synopsis
This module configures iDRAC eventing related attributes.

Options

Table 15. dellemc_configure_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

CIFS or NFS Network share or

share_name Yes NA NA
a local path

Network share user in the

share_user No NA NA format 'user@domain' if user
is part of a domain else 'user'

share_pwd No NA NA Network share user password

Local mount path of the

share_mnt No NA NA network share with read-write
permission for ansible user

Destination number for SNMP

destination_number No None NA
Trap

destination No None NA Destination for SNMP Trap

SNMP v3 username for

snmp_v3_username No NA NA
SNMP Trap

• Enabled Whether to Enable or Disable

snmp_trap_state No NA
• Disabled SNMP alert

• Enabled Whether to Enable or Disable

email_alert_state No NA
• Disabled Email alert

Configuring PowerEdge Servers 17

 Alert number for Email
alert_number No None NA
configuration

address No NA NA Email address for SNMP Trap

Custom message for SNMP

custom_message No NA NA
Trap reference

• Enabled Whether to Enable or Disable

enable_alerts No NA
• Disabled iDRAC alerts

• Enabled Simple Mail Transfer Protocol

authentication No NA
• Disabled Authentication

SMTP IP address for

smtp_ip_address No NA NA
communication

smtp_port No None NA SMTP Port number for access

Username for SMTP

username No None NA
authentication

Password for SMTP

password No None NA
authentication

Table 16. Return Values

Name Description Returned Type Sample

iDRAC eventing Configures the iDRAC eventing Success String https://github.com/dell/Dell-EMC-Ansible-

attributes Modules-for-iDRAC

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"

Configuring iDRAC Services

Module: dellemc_configure_idrac_services

18 Configuring PowerEdge Servers

Synopsis
This module configures the iDRAC services related attributes.

Options

Table 17. dellemc_configure_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

CIFS or NFS Network share or a local

share_name Yes NA NA
path

Network share user in the format

share_user No NA NA 'user@domain' if user is part of a
domain else 'user'

share_pwd No NA NA Network share user password

Local mount path of the network share

share_mnt No NA NA with read-write permission for ansible
user

• Enabled Whether to Enable or Disable

enable_web_server No NA
• Disabled webserver configuration for iDRAC

• Auto_Negotiate
• T_128_Bit_or_higher Secure Socket Layer encryption for
ssl_encryption No NA
• T_168_Bit_or_higher webserver
• T_256_Bit_or_higher

• TLS_1_0_and_Higher
tls_protocol No NA • TLS_1_1_and_Higher Transport Layer Security for webserver
• TLS_1_2_Only

https_port No NA NA HTTPS access port

http_port No NA NA HTTP access port

timeout No NA NA Timeout value

• Enabled Whether to Enable or Disable SNMP

snmp_enable No NA
• Disabled protocol for iDRAC

• All
snmp_protocol No NA Type of the SNMP protocol
• SNMPv3

community_name No test NA SNMP community name for iDRAC

alert_port No None NA SNMP alert port for iDRAC

Configuring PowerEdge Servers 19

discovery_port No 162 NA SNMP discovery port for iDRAC

trap_format No None NA SNMP trap format for iDRAC

Table 18. Return Values

Name Description Returned Type Sample

Configures the iDRAC services https://github.com/dell/Dell-EMC-Ansible-

iDRAC services Success String
attributes Modules-for-iDRAC

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"

Configuring iDRAC Network

Module: dellemc_configure_idrac_network
Synopsis
This module configures the iDRAC networking attributes.

Options

Table 19. dellemc_configure_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

20 Configuring PowerEdge Servers

 Network share user in the format
share_user No NA NA 'user@domain' if user is part of a domain else
'user'

share_pwd No NA NA Network share user password

Local mount path of the network share with

share_mnt No NA NA
read-write permission for ansible user

Configuring the VLAN-related setting for

setup_idrac_nic_vlan No NA NA
iDRAC

• Enabled
register_idrac_on_dns No NA Registering Domain Name System for iDRAC
• Disabled

dns_idrac_name No NA NA DNS Name for iDRAC

• Enabled
auto_config No NA Automatically creates the records for DNS
• Disabled

static_dns No NA NA Static configuration for DNS

vlan_id No None NA Configuring the VLAN id for iDRAC

vlan_priority No None NA Configuring the VLAN priority for iDRAC

• Enabled Whether to Enable or Disable Network

enable_nic No NA
• Disabled Interface Controller for iDRAC

• Dedicated
• LOM1
Selecting Network Interface Controller types
nic_selection No NA • LOM2
for iDRAC
• LOM3
• LOM4

• ALL
• LOM1
• LOM2 Failover Network Interface Controller types for
failover_network No NA
• LOM3 iDRAC
• LOM4
• T_None

• Enabled Auto detect Network Interface Controller

auto_detect No NA
• Disabled types for iDRAC

• Enabled Auto negotiation of Network Interface

auto_negotiation No NA
• Disabled Controller for iDRAC

• T_10
Network speed for Network Interface
network_speed No NA • T_100
Controller types for iDRAC
• T_1000

Transmission of data Network Interface

duplex_mode No NA • Full
Controller types for iDRAC

Configuring PowerEdge Servers 21

 • Half

nic_mtu No None NA NIC Maximum Transmission Unit

ip_address No NA NA IP Address needs to be defined

Whether to Enable or Disable DHCP Protocol

enable_dhcp No NA NA
for iDRAC

Needs to specify Domain Name Server

dns_1 No NA NA
Configuration

Needs to specify Domain Name Server

dns_2 No NA NA
configuration

• Enabled Specifying Domain Name Server from Dynamic

dns_from_dhcp No NA
• Disabled Host Configuration Protocol

• Enabled Whether to Enable or Disable IPv4

enable_ipv4 No NA
• Disabled configuration

gateway No None NA iDRAC network gateway address

net_mask No None NA iDRAC network netmask details

• Enabled Specifying Domain Name Server from Dynamic

static_dns_from_dhcp No NA
• Disabled Host Configuration Protocol

static_dns_1 No NA NA Specify Domain Name Server Configuration

static_dns_2 No NA NA Specify Domain Name Server Configuration

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

Configures the iDRAC network https://github.com/dell/Dell-EMC-Ansible-Modules-

iDRAC network Success String
attributes for-iDRAC

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"

22 Configuring PowerEdge Servers

 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"
dns_1: "x.x.x.x"
dns_2: "x.x.x.x"
dns_from_dhcp: "Enabled"
enable_ipv4: "Enabled"
gateway: "None"
net_mask: "None"
static_dns_1: "x.x.x.x"
static_dns_2: "x.x.x.x"
static_dns_from_dhcp: "Enabled"
static_gateway: "None"
static_net_mask: "None"

Configuring BIOS
Module: dellemc_configure_bios
Synopsis
This module hosts the BIOS configuration related tasks. The tasks are:

• Setup_boot_mode: Configures the boot mode to BIOS or Unified Extensible Firmware Interface (UEFI).
• Setup_onetime_boot_mode: Configures the one time boot mode setting such as Disabled, OneTimeBootSeq, OneTimeHddSeq,
OneTimeUefiBootSeq.
• Setup_NVMe_Mode: Configures the NVMe mode.
• Setup_Secure_boot_Mode: Configures how the BIOS uses the Secure Boot Policy Objects.

Options

Table 21. dellemc_configure_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

CIFS or NFS network

share_name Yes NA NA
share or a local path

Network share user in the

format 'user@domain' if
share_user No NA NA
user is part of a domain
else 'user'

Network share user

share_pwd No NA NA
password

Configuring PowerEdge Servers 23

 Local mount path of the
network share with read-
share_mnt No NA NA
write permission for
ansible user

• Bios Configures the boot

boot_mode No NA
• Uefi mode to Bios or Uefi

Boot devices' FQDDs in

the sequential order for
BIOS or UEFI Boot
Sequence

boot_sequence No NA NA NOTE: Ensure

that 'boot_mode'
option is provided
to determine the
boot sequence to
be applied.

Configures the NVME

mode

NOTE: This
• NonRaid attribute is
nvme_mode No NA
• Raid specific to the
14th Generation of
PowerEdge
servers.

Configures how the BIOS

uses the Secure Boot
Policy Objects
• AuditMode,
• DeployedMode NOTE: This
secure_boot_mode No NA attribute is
• SetupMode
specific to the
• UserMode
14th Generation of
PowerEdge
servers.

• Disabled
• OneTimeBootSeq
• OneTimeCustomBootSeqStr
Configures the one time
onetime_boot_mode No NA • OneTimeCustomHddSeqStr
boot mode setting
• OneTimeCustomUefiBootSeqStr
• OneTimeHddSeq
• OneTimeUefiBootSeq

Table 22. Return Values

Name Description Returned Type Sample

Configures the BIOS configuration https://github.com/dell/Dell-EMC-Ansible-

BIOS Success String
attributes Modules-for-iDRAC

24 Configuring PowerEdge Servers

Example
-name: Configure BIOS attributes
dellemc_configure_bios:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
share_name: "\\\\xx.xx.xx.xx\\share"
share_pwd: "xxxxxxxx"
share_user: "xxxxx"
share_mnt: "xxxxxx"
boot_mode : "xxxxx"
nvme_mode: "xxxxx"
secure_boot_mode: "xxxxxx"
onetime_boot_mode: "xxxxxx"

Configuring RAID
Module: dellemc_configure_raid
Synopsis
This module hosts the RAID configuration related attributes.

Options

Table 23. dellemc_configure_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

CIFS or NFS Network share or a local

share_name Yes NA NA
path

Network share user in the format

share_user No NA NA 'user@domain' if user is part of a
domain else 'user'

share_pwd No NA NA Network share user password

Local mount path of the network

share_mnt No NA NA share with read-write permission for
ansible user

Virtual disk name

• Optional, if we perform create

vd_name No NA NA 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

Configuring PowerEdge Servers 25

number_global_hot_spare No 0 NA Number of Global Hot Spare

• RAID 0
• RAID 1
• RAID 5
raid_level No RAID 0 • RAID 6 Provide the required RAID level
• RAID 10
• RAID 50
• RAID 60

• Default
disk_cache_policy No Default • Enabled Disk Cache Policy
• Disabled

• WriteThrough
write_cache_policy No WriteThrough • WriteBack Write cache policy
• WriteBackForce

• NoReadAhead
read_cache_policy No NoReadAhead • ReadAhead Read cache policy
• Adaptive

Provide stripe size value in multiples

stripe_size No 65536 NA
of 64 * 1024

Fully Qualified Device Descriptor

controller_fqdd Yes NA NA (FQDD) of the storage controller, for
e.g. RAID.Integrated.1-1

• HDD
media_type No HDD Media type
• SSD

• SAS
bus_protocol No SATA Bus protocol
• SATA

• If the value is 'present', the

module will perform 'create'
• present
state Yes NA operations
• absent • If the value is 'absent', the module
will perform 'remove' operations

Table 24. Return Values

Name Description Returned Type Sample

RAID Configures the RAID configuration https://github.com/dell/Dell-EMC-Ansible-

Success String
configuration attributes Modules-for-iDRAC

Example
-name: Configure the RAID attributes
dellemc_configure_raid:
idrac_ip: "xx.xx.xx.xx"

26 Configuring PowerEdge Servers

 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"

Configuring 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 configuration information are discovered and compared with previous
system inventory information on every system restart.

Options

Table 25. 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

CIFS or NFS network share or a local

share_name Yes NA NA
path

Network share user in the format

share_user No NA NA 'user@domain' if user is part of a
domain else 'user'

share_pwd No NA NA Network share user password

Local mount path of the network share

share_mnt No NA NA with read-write permission for ansible
user

Whether to Enable or Disable Collect

• Enabled
csior Yes NA System Inventory on Restart (CSIOR)
• Disabled
property for all iDRAC or LC jobs

Table 26. Return Values

Name Description Returned Type Sample

Configures CSIOR property for all https://github.com/dell/Dell-EMC-Ansible-

iDRAC CSIOR Success String
iDRAC or LC jobs Modules-for-iDRAC

Example
-name: Set up iDRAC LC Attributes
dellemc_idrac_lc_attributes:

Configuring PowerEdge Servers 27

 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"

Configuring Syslog
Module: dellemc_setup_idrac_syslog
Synopsis
This module enables or disables syslog parameters for iDRAC.

Options

Table 27. 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

CIFS or NFS Network

share_name Yes NA NA
share or a local path

Network share user in the

format 'user@domain' if
share_user No NA NA
user is part of a domain
else 'user'

Network share user

share_pwd No NA NA
password

Local mount path of the

network share with read-
share_mnt No NA NA
write permission for
ansible user

• Enabled Whether to Enable or

syslog Yes NA
• Disabled Disable iDRAC syslog

Table 28. Return Values

Name Description Returned Type Sample

Configures iDRAC Syslog https://github.com/dell/Dell-EMC-Ansible-

iDRAC Syslog Success String
parameters Modules-for-iDRAC

Example
-name: Configure iDRAC Syslog Parameters
dellemc_setup_idrac_syslog:

28 Configuring PowerEdge Servers

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"

Configuring PowerEdge Servers 29

 5
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 file.
• iDRAC is enabled, configured, and reachable.
• RAID is configured.

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 configured share location and transfers the image to iDRAC to load it.
On the system reboot, the OS deployment begins.

Options

Table 29. 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

CIFS or NFS Network

share_name Yes NA NA
share

Network share user in the

format 'user@domain' if
share_user Yes NA NA
user is part of a domain
else 'user'

Network share user

share_pwd Yes NA NA
password

30 Deploying Operating System

Table 30. Return Values

Name Description Returned Type Sample

Boots to a network ISO https://github.com/dell/Dell-EMC-

Boot to Network ISO Success String
Image Ansible-Modules-for-iDRAC

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"

Deploying Operating System 31

 6
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 as well as component level detailed inventory information. You can run this module when you want to
verify the asset, configured state, inventory, and health-related information for the system and its component.
Options

Table 31. 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 32. Return Values

Name Description Returned Type Sample

System Displays the PowerEdge Server https://github.com/dell/Dell-EMC-Ansible-Modules-
Success String
Inventory System Inventory for-iDRAC

Example
-name: Get System Inventory
dellemc_get_system_inventory:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"

32 Server Inventory
 7
Server Administration Tasks
This section describes the tasks that you can run using OpenManage Ansible Modules version 1.0.1

NOTE: OpenManage Ansible Modules version 1.0.1 supports iDRAC firmware version 2.50.50.50 and later.

Topics:

• Configuring the Power State on the PowerEdge Servers

• Resetting iDRAC to Factory Settings
• Viewing LC Job Status
• Exporting LC Logs
• Deleting LC Job
• Deleting LC Job Queue
• Configuring System Lockdown Mode

Configuring the Power State on the PowerEdge

Servers
Module: dellemc_change_power_state

Synopsis

This module configures the power control options on a PowerEdge server. You can run this module:

• To power on the server.

• To power off the server.
• To reboot the server.
• For hard reset of the server.

Options

Table 33. 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

• On
• ForceOff
change_power Yes NA Desired power state
• GracefulRestart
• GracefulShutdown

Server Administration Tasks 33

 • PushPowerButton
• Nmi

Table 34. Return Values

Name Description Returned Type Sample

Configures the power control
Power state of a https://github.com/dell/Dell-EMC-Ansible-
options on a PowerEdge Success String
server Modules-for-iDRAC
server

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 to Factory Settings

Module: dellemc_idrac_reset
Synopsis

You can reset the iDRAC to its default factory settings using this module. This module deletes your current iDRAC configuration and resets
it to the default settings.

Options

Table 35. 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 36. Return Values

Name Description Returned Type Sample

Reset Resets the iDRAC Success String https://github.com/dell/Dell-EMC-Ansible-Modules-for-

iDRAC iDRAC

Example
-name: Reset iDRAC
dellemc_idrac_reset:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "xxxx"
idrac_pwd: "xxxxxxxx"
idrac_port: "xxx"

34 Server Administration Tasks

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. Once 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.
Options

Table 37. 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 in the format
job_id Yes NA NA
"JID_123456789012"

Table 38. Return Values

Name Description Returned Type Sample

Displays the status of a LC https://github.com/dell/Dell-EMC-Ansible-Modules-for-
LC Job Status Success String
job iDRAC

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 files 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.

The various types of information available in LC logs are alerts-related, configuration changes on the system hardware components,
firmware 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.

Options

Server Administration Tasks 35

Table 39. 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
Network share user in the format 'user@domain' if user
share_user Yes NA NA
is part of a domain else 'user'
share_pwd Yes NA NA Network share user password

• If the value is True, it waits for the job to finish and

• True returns the job completion status
job_wait Yes NA
• False • If the value is False, it returns immediately with a
JOB ID after queuing the job in LC job queue

Table 40. Return Values

Name Description Returned Type Sample

Exports the LC logs to the given https://github.com/dell/Dell-EMC-Ansible-Modules-
LC logs Success String
network share for-iDRAC

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.

You can delete an LC job:

• once the job is completed.

• if you do not want to perform the job or if it is taking long to execute.

Options

36 Server Administration Tasks

Table 41. 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 NA NA iDRAC port

JOB ID in the format

job_id Yes NA NA
"JID_XXXXXXXXX"

Table 42. Return Values

Name Description Returned Type Sample

Deletes an LC job for a given a https://github.com/dell/Dell-EMC-Ansible-Modules-for-

Delete LC job Success String
JOB ID iDRAC

Examples
-name: Delete LC Job
dellemc_delete_lc_job:
idrac_ip: "xx.xx.xx.xx"
idrac_user: "root"
idrac_pwd: "xxxxx"
idrac_port: "123"
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.

Options

Table 43. 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

idrac_pwd Yes NA NA iDRAC user password

idrac_port No 443 NA iDRAC port

Server Administration Tasks 37

Table 44. Return Values

Name Description Returned Type Sample

Deletes the LC job

LC Job Queue Success String https://github.com/dell/Dell-EMC-Ansible-Modules-for-iDRAC
queue

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"

Configuring System Lockdown Mode

Module: dellemc_system_lockdown_mode
Synopsis
System Lockdown Mode provides a mechanism to protect configuration 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 configuration is locked and system cannot be configured or updated until the lockdown mode is disabled.

Options

Table 45. 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

CIFS or NFS network

share_name Yes NA NA
share or a local path

Network share user in the

format 'user@domain' if
share_user No NA NA
user is part of a domain
else 'user'

Network share user

share_pwd No NA NA
password

Local mount path of the

network share with read-
share_mnt No NA NA
write permission for
ansible user

Whether to Enable or
lockdown_mode Yes NA • Enabled Disable system lockdown
mode

38 Server Administration Tasks

 • Disabled

Table 46. Return Values

Name Description Returned Type Sample

System Lockdown Configures lockdown https://github.com/dell/Dell-EMC-Ansible-Modules-for-

Success String
Mode mode of the system iDRAC

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"

Server Administration Tasks 39

 8
Troubleshooting
• While configuring iDRAC timezone on 14G servers with iDRAC firmware 3.00.00.00 and 3.11.11.11 the job keeps running for longer time
without any return output.

— To ensure that the new timezone values are applied to the servers, export an SCP.

— Upgrade to a latest Dell EMC recommended firmware version (iDRAC firmware version 3.15.15.15 and later) before performing the
configuration changes.

• 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_configure_idrac_users module.

• Firmware install is failing on server with iDRAC firmware 3.00.00.00 and with Linux NFS share.

— To perform firmware update, use DUPs from a share other than Linux NFS share.

40 Troubleshooting
 9
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 — Dell.com/SoftwareSecurityManuals

• For Dell EMC OpenManage documents — Dell.com/OpenManageManuals
• For Dell EMC Remote Enterprise Systems Management documents — Dell.com/esmmanuals
• For iDRAC and Dell EMC Lifecycle Controller documents — Dell.com/idracmanuals
• For Dell EMC OpenManage Connections Enterprise Systems Management documents — Dell.com/
OMConnectionsEnterpriseSystemsManagement
• For Dell EMC Serviceability Tools documents — Dell.com/ServiceabilityTools
• a Go to Dell.com/Support/Home.
b Click Choose from all products.
c From All products section, click Software & Security, and then click the required link from the following:
– Enterprise Systems Management
– Remote Enterprise Systems Management
– Serviceability Tools
– Dell Client Command Suite
– Connections Client Systems Management
d To view a document, click the required product version.
• Using search engines:

– Type the name and version of the document in the search box.

Accessing documents from the Dell EMC support site 41