Dell EMC OpenManage Ansible Modules Version 1.0.1 User’s Guide 1 February 2018 Rev.
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.
Contents Chapter 1: Overview...................................................................................................................... 5 Key Features.........................................................................................................................................................................5 Chapter 2: Getting Started........................................................................................................... 6 How OpenManage Ansible Modules works........
Chapter 9: Accessing support content from the Dell EMC support site........................................
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.
2 Getting Started Topics: • • How OpenManage Ansible Modules works Running your first Playbook 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.
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.
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.
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.
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.
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.
Table 9. dellemc_import_server_config_profile (continued) share_user No NA NA Network share user in the format 'user@domain' if user is part of a domain else 'user' share_pwd No NA NA Network share user password ● 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 shutdown_type No Graceful Table 10.
Table 11.
share_user: share_mnt: action: user_name: user_password: privilege_users: ipmilanprivilege_users: ipmiserialprivilege_users: enable_users: solenable_users: protocolenable_users: authenticationprotocol_users: privacyprotocol_users: "xxxx" "/mnt/share" "create" "username" "xxxxxxxx" "Administrator" "Administrator" "Administrator" "Enabled" "Enabled" "Enabled" "SHA" "AES" Configuring iDRAC Timezone Module: dellemc_configure_idrac_timezone Synopsis This module configures the iDRAC timezone related attributes.
idrac_pwd: share_name: share_pwd: share_user: share_mnt: setup_idrac_timezone: enable_ntp: ntp_server_1: ntp_server_2: ntp_server_3: "xxxxxxxx" "\\\\xx.xx.xx.xx\\share" "xxxxxxxx" "xxxx" "/mnt/share" "UTC" "Enabled" "x.x.x.x" "x.x.x.x" "x.x.x.x" Configuring iDRAC Eventing Module: dellemc_configure_idrac_eventing Synopsis This module configures iDRAC eventing related attributes. Options Table 15.
Table 15. dellemc_configure_idrac_eventing (continued) 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 password No None NA Password for SMTP authentication Table 16.
Table 17.
http_port: https_port: ssl_encryption: tls_protocol: timeout: snmp_enable: snmp_protocol: community_name: alert_port: discovery_port: trap_format: "80" "443" "Auto_Negotiate" "TLS_1_2_Only" "1800" "Enabled" "SNMPv3" "test" "None" "162" "None" Configuring iDRAC Network Module: dellemc_configure_idrac_network Synopsis This module configures the iDRAC networking attributes. Options Table 19.
Table 19.
idrac_user: idrac_pwd: share_name: share_pwd: share_user: share_mnt: register_idrac_on_dns: dns_idrac_name: auto_config: static_dns: setup_idrac_nic_vlan: vlan_id: vlan_priority: enable_nic: nic_selection: failover_network: auto_detect: auto_negotiation: network_speed: duplex_mode: nic_mtu: ip_address: enable_dhcp: dns_1: dns_2: dns_from_dhcp: enable_ipv4: gateway: net_mask: static_dns_1: static_dns_2: static_dns_from_dhcp: static_gateway: static_net_mask: "xxxx" "xxxxxxxx" "\\\\xx.xx.xx.xx\\share" "xxxxxx
Table 21. dellemc_configure_bios (continued) part of a domain else 'user' share_pwd Yes NA NA Network share user password share_mnt Yes NA NA Local mount path of the network share with read-write permission for ansible user boot_mode No NA ● Bios ● Uefi Configures the boot mode to Bios or Uefi NA Boot devices' FQDDs in the sequential order for BIOS or UEFI Boot Sequence NOTE: Ensure that 'boot_mode' option is provided to determine the boot sequence to be applied.
idrac_ip: idrac_user: idrac_pwd: share_name: share_pwd: share_user: share_mnt: boot_mode : nvme_mode: secure_boot_mode: onetime_boot_mode: "xx.xx.xx.xx" "xxxx" "xxxxxxxx" "\\\\xx.xx.xx.xx\\share" "xxxxxxxx" "xxxxx" "xxxxxx" "xxxxx" "xxxxx" "xxxxxx" "xxxxxx" Configuring RAID Module: dellemc_configure_raid Synopsis This module hosts the RAID configuration related attributes. Options Table 23.
Table 23. dellemc_configure_raid (continued) 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 ● Adaptive Read cache policy stripe_size No 65536 NA Provide stripe size value in multiples of 64 * 1024 controller_fqdd Yes NA NA Fully Qualified Device Descriptor (FQDD) of the storage controller, for e.g.
Table 25.
Table 27. dellemc_setup_idrac_syslog (continued) 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' if user is part of a domain else 'user' share_pwd No NA NA Network share user password NA Local mount path of the network share with read-write permission for ansible user share_mnt No NA syslog Yes NA ● ● Enabled Disabled Whether to Enable or Disable iDRAC syslog Table 28.
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.
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.
6 Server Inventory This section describes the process of retrieving the server inventory of the PowerEdge Servers using Ansible Modules. Topics: • Viewing the System Inventory 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.
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.
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.
Table 37. dellemc_get_lc_job_status (continued) 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 38. Return Values Name Description Returned Type Sample LC Job Status Displays the status of a LC job Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC Example -name: Get LC Job Status dellemc_get_lc_job_status idrac_ip: "xx.xx.xx.
Table 40. Return Values (continued) LC logs Exports the LC logs to the given Success network share String https://github.com/dell/Dell-EMC-AnsibleModules-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 gi
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 Table 44.
Table 45. dellemc_system_lockdown_mode (continued) share_user Yes NA NA Network share user in the format 'user@domain' if user is part of a domain else 'user' share_pwd Yes NA NA Network share user password share_mnt Yes NA NA Local mount path of the network share with read-write permission for ansible user lockdown_mode Yes NA ● Enabled ● Disabled Whether to Enable or Disable system lockdown mode Table 46.
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.
9 Accessing support content from the Dell EMC support site Access supporting content related to an array of systems management tools using direct links, going to the Dell EMC support site, or using a search engine. ● Direct links: ○ For Dell EMC Enterprise Systems Management and Dell EMC Remote Enterprise Systems Management—https:// www.dell.com/esmmanuals ○ For Dell EMC Virtualization Solutions—https://www.dell.com/SoftwareManuals ○ For Dell EMC OpenManage—https://www.dell.
