Dell EMC OpenManage Ansible Modules Version 1.1 User’s Guide November 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 3.0.0 © Copyright 2018 - 2021 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 What's new?.........................................................................................................................................................................
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 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 iDRAC REST APIs based on Redfish standards and Server Configuration Profiles (SCP) for automated configuration, 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 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.
Synopsis You can install the firmware from a repository on a network share (CIFS, NFS) to keep the system updated. ● For 12 th and 13 th generation of PowerEdge servers, firmware update from a network repository is performed using WS-Man APIs. ● For 14 th generation of PowerEdge servers, firmware update from a network repository is performed using the SCP.
Table 3. dellemc_install_firmware (continued) Parameter Required Default Choices Comments is mandatory for CIFS Network share. share_mnt Yes NA Local mount path of the network share with read-write permission for ansible user. This option is mandatory for Network share. NA Table 4. Return Values Name Description Returned Type Sample Firmware Updates firmware from a repository on a network share (CIFS, NFS) Success String https://github.
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. Check_mode support: No Options Table 7.
Table 7. dellemc_export_server_config_profile (continued) Parameter Required Default Choices Comments ● 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 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/blob/master/samples/ dellemc_export_server_config_profile.
Table 9.
Configuring iDRAC Users Module: dellemc_configure_idrac_users Synopsis This module creates, modifies or deletes an iDRAC local user. Check_mode support: Yes Options Table 11.
Table 11. dellemc_configure_idrac_users (continued) Parameter Required Default Choices Comments 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 _users No NA ● T_None ● SHA ● MD5 Configuring authentication protocol for iDRAC user privacyprotocol_users No NA ● T_None ● DES ● AES Configuring privacy protocol for iDRAC user Table 12.
Table 13. dellemc_configure_idrac_timezone (continued) Parameter Required Default Choices Comments 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.
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 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.
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.
Table 17.
Configuring iDRAC Network Module: dellemc_configure_idrac_network Synopsis This module configures the iDRAC networking attributes. Check_mode support: Yes Options Table 19.
Table 19.
nic_selection: failover_network: auto_detect: auto_negotiation: network_speed: duplex_mode: nic_mtu: ip_address: enable_dhcp: dns_from_dhcp: enable_ipv4: static_dns_1: static_dns_2: static_gateway: static_net_mask: "Dedicated" "T_None" "Disabled" "Enabled" "T_1000" "Full" "1500" "x.x.x.x" "Enabled" "Enabled" "Enabled" "x.x.x.x" "x.x.x.x" "None" "None" Configuring BIOS Module: dellemc_configure_bios Synopsis This module configures the BIOS attributes for PowerEdge servers.
Table 21. dellemc_configure_bios (continued) Parameter Required Default Choices Comments (deprecated) Boot devices' FQDDs in the sequential order for BIOS or UEFI Boot Sequence. Provide the I(boot_mode) option to determine the appropriate boot sequence to be applied. boot_sequence No NA 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 modification instead.
Table 21. dellemc_configure_bios (continued) Parameter Required Default Choices Comments I(idrac_ip)/redfish/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). 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.
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.
This module hosts the RAID configuration related attributes. NOTE: This module is deprecated and replaced with dellemc_idrac_storage_volume. Options Table 23.
Table 23. dellemc_configure_raid (continued) Parameter Required Default Choices Comments ● Adaptive 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. RAID.Integrated.
Table 25.
Table 25. dellemc_idrac_storage_volume (continued) Parameter Required Default Choices Comments ● For C(create) operation, name and drives are applicable options, other volume options can also be specified. 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.
id: - name: volume_type: span_length: span_depth: drives: location: disk_cache_policy: write_cache_policy: read_cache_policy: stripe_size: capacity: raid_init_operation: ["Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1", "Disk.Bay.2:Enclosure.Internal.0-1:RAID.Slot.1-1"] "volume_2" "RAID 5" 3 1 [7,3,5] "Disabled" "WriteBack" "NoReadAhead" 131072 200 "None" -name: View all volume details dellemc_idrac_storage_volume: idrac_ip: "xx.xxx.xx.
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.
Table 29. dellemc_setup_idrac_syslog (continued) Parameter Required Default Choices Comments 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.
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 and 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.1. NOTE: OpenManage Ansible Modules version 1.1 supports iDRAC firmware version 2.50.50.50 and later.
Table 36. Return Values Name Description Returned Type Sample Power state of a server Configures the power control options on a PowerEdge server Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_change_power_state.md Example -name: Change Power State dellemc_change_power_state: idrac_ip: "xx.xx.xx.
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.
Table 41. dellemc_export_lc_logs (continued) Parameter Required Default Choices Comments share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share. 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 job_wait Yes Table 42.
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-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_delete_lc_job.md Examples -name: Delete LC Job dellemc_delete_lc_job: idrac_ip: "xx.xx.xx.
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. Check_mode support: No Options Table 47.
8 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_configure_idrac_users module.
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.
