Dell EMC OpenManage Ansible Modules Version 1.0 User’s Guide 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. © 2018 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents Tables........................................................................................................................................... 5 Chapter 1: Overview...................................................................................................................... 7 Key Features......................................................................................................................................................................... 7 Chapter 2: Getting Started.....
Chapter 9: Accessing support content from the Dell EMC support site........................................
Tables 1 dellemc_get_firmware_inventory..........................................................................................................................9 2 Return Values..............................................................................................................................................................9 3 dellemc_install_firmware........................................................................................................................................
41 dellemc_delete_lc_job............................................................................................................................................35 42 Return Values........................................................................................................................................................... 35 43 dellemc_delete_lc_job_queue..............................................................................................................................
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 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 About this task Command: dellemc_get_firmware_inventory Synopsis You can view the firmware inventory of a server using this module.
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.
Table 4. Return Values (continued) Firmware Updates firmware from a repository on a network share (CIFS, NFS) Success String https://github.com/dell/Dell-EMC-AnsibleModules-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 11
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.
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.
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-AnsibleModules-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:
Table 9.
Table 11.
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
Table 14. Return Values (continued) iDRAC Timezone Configures the iDRAC timezone attributes Success String https://github.com/dell/Dell-EMC-AnsibleModules-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" 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.
Table 15.
Synopsis This module configures the iDRAC services related attributes. Options Table 17.
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
Table 19.
Table 20. Return Values Name Description Returned Type Sample iDRAC network Configures the iDRAC network attributes Success String https://github.com/dell/Dell-EMC-AnsibleModules-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" aut
Table 21.
Table 22. Return Values Name Description Returned Type Sample BIOS Configures the BIOS configuration attributes Success String https://github.com/dell/Dell-EMCAnsible-Modules-for-iDRAC 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: "xx
Table 23.
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.
Options Table 27.
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 About this task Module: dellemc_get_system_inventory Synopsis System inventory provides basic as well as component level detailed inventory information.
7 Server Administration Tasks This section describes the tasks that you can run using OpenManage Ansible Modules version 1.0. NOTE: OpenManage Ansible Modules version 1.0 supports iDRAC firmware version 2.50.50.50 and later.
Table 34. Return Values (continued) Power state of a server Configures the power control options on a PowerEdge server Success https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC String 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.
Check_mode support: No 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 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 an LC job Success String https://github.
Table 39. dellemc_export_lc_logs (continued) job_wait Yes ● If the value is True, it waits for the job to finish 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 ● True ● False NA Table 40. Return Values Name Description Returned LC logs Exports the LC logs to the given Success network share Type Sample String https://github.
idrac_user: idrac_pwd: idrac_port: job_id: "root" "xxxxx" "123" "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.
Table 45.
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.
