Dell EMC OpenManage Ansible Modules Version 1.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Dell EMC OpenManage Ansible Modules Version 1.1 © Copyright 2018 Dell Inc. GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.
Contents 1 Overview........................................................................................................................................................5 Key Features....................................................................................................................................................................... 5 What's new?..................................................................................................................................................
8 Troubleshooting........................................................................................................................................... 47 9 Accessing documents 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.
– Support Boot Source State modification using Redfish APIs — reorder, enable or disable boot source devices. • Added support for providing a Custom Catalog file name while using firmware update from a DRM repository. • Support for check mode — find out whether configuration changes are available to be made to the servers. • New and updated playbook examples.
2 Getting Started 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.
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. • For 12th and 13th generation of PowerEdge servers, firmware update from a network repository is performed using WS-Man APIs. • For 14th generation of PowerEdge servers, firmware update from a network repository is performed using the SCP.
Parameter Required share_user No share_pwd No share_mnt Yes Default NA NA NA Choices Comments 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. NA Network share user password. This option is mandatory for CIFS Network share. NA Local mount path of the network share with readwrite permission for ansible user. This option is mandatory for Network share. Table 4.
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.
Table 6. Return Values Name Description Returned LC status Displays the LC status on Success a PowerEdge server Type Sample String https://github.com/dell/Dell-EMCAnsible-Modules-for-iDRAC/blob/ master/samples/ dellemc_get_lcstatus.md Example -name: Get LC Status dellemc_get_lcstatus: idrac_ip: "xx.xx.xx.
Parameter Required Default Choices Comments share_name Yes NA NA CIFS or NFS network share or a local path share_user No NA NA Network share user in the format 'user@domain' or 'domain\user' if user is part of a domain else 'user'. This option is mandatory for CIFS Network share. share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share.
Check_mode support: No Options Table 9.
Table 10. Return Values Name Description Returned Type Sample Import SCP Imports SCP from a network share or from a local file Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_import_server_config_profile.md Example -name: Import Server Configuration Profile dellemc_import_server_config_profile idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" share_name: "xx.xx.xx.
Parameter Required Default Choices Comments Local mount path of the network share with read-write permission for Ansible user. This option is mandatory for CIFS or NFS Network share.
Table 12. Return Values Name Description Returned Type Sample iDRAC users Configures the iDRAC users attributes Success String https://github.com/dell/Dell-EMC-Ansible-Modules-foriDRAC/blob/master/samples/ dellemc_configure_idrac_users.md Example -name: Configure the iDRAC users attributes dellemc_configure_idrac_users: idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" share_name: "xx.xx.xx.
Parameter Required Default Choices Comments share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share. share_mnt No NA NA Local mount path of the network share with read-write permission for Ansible user. This option is mandatory for CIFS or NFS Network share.
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.
Parameter Required Default Choices Comments password No None NA Password for SMTP authentication Table 16. Return Values Name Description Returned iDRAC eventing Configures the iDRAC eventing Success attributes Type Sample String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_configure_idrac_eventing.md Example -name: Configure the iDRAC eventing attributes dellemc_configure_idrac_eventing: idrac_ip: "xx.xx.xx.
Parameter Required Default Choices Comments share_name Yes NA NA CIFS or NFS Network share or a local path share_user No NA NA Network share user in the format 'user@domain' or 'domain\user' if user is part of a domain else 'user'. This option is mandatory for CIFS Network share. share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share. Local mount path of the network share with read-write permission for Ansible user.
Table 18. Return Values Name Description Returned Type Sample iDRAC services Configures the iDRAC services attributes Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_configure_idrac_services.md Example -name: Configure the iDRAC services attributes dellemc_configure_idrac_services: idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" share_name: "xx.xx.xx.
Parameter Required Default Choices Comments share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share. share_mnt No NA NA Local mount path of the network share with read-write permission for Ansible user. This option is mandatory for CIFS or NFS Network share.
Parameter Required Default Choices Comments duplex_mode No NA • • Transmission of data Network Interface Controller types for iDRAC nic_mtu No None NA NIC Maximum Transmission Unit ip_address No NA NA IP Address needs to be defined enable_dhcp No NA NA Whether to Enable or Disable DHCP Protocol for iDRAC dns_from_dhcp No NA • • Enabled Disabled Specifying Domain Name System from Dynamic Host Configuration Protocol enable_ipv4 No NA • • Enabled Disabled Whether to Enable o
dns_from_dhcp: enable_ipv4: static_dns_1: static_dns_2: static_gateway: static_net_mask: "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. Check_mode support: Yes Options Table 21.
Parameter Required Default Choices Comments Provide the I(boot_mode) option to determine the appropriate boot sequence to be applied. NOTE: This option has been deprecated, and will be removed in the later version. Please use the I(attributes) or I(boot_sources) for Boot Sequence modification instead. NOTE: I(boot_sequence) is mutually exclusive with I(boot_sources). (deprecated) Configures the NVME mode in the 14th generation of PowerEdge servers.
Parameter Required Default Choices Comments view BIOS attributes: (https://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.
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 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.
Parameter Required Default Choices Comments write_cache_policy No WriteThrough • • • WriteThrough WriteBack WriteBackForce Write cache policy read_cache_policy No NoReadAhead • • • NoReadAhead ReadAhead Adaptive Read cache policy stripe_size No 65536 NA Provide stripe size value in multiples of 64 * 1024 controller_fqdd Yes NA NA Fully Qualified Device Descriptor (FQDD) of the storage controller, for e.g. RAID.Integrated.
This module hosts the RAID configuration related attributes. Check_mode support: Yes Options Table 25.
Parameter Required Default Choices Comments volume_id No NA NA Fully Qualified Device Descriptor (FQDD) of the virtual disk, for example: Disk.virtual.0:RAID.Slot.1-1 NOTE: This option is used to get the virtual disk information.
idrac_ip: idrac_user: idrac_pwd: controller_id: state: volumes: - drives: location: "xx.xxx.xx.xx" "xxxx" "xxxxxxxx" "RAID.Slot.1-1" "create" [5] -name: Create multiple volume dellemc_idrac_storage_volume: idrac_ip: "xx.xxx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" raid_reset_config: "True" state: "create" controller_id: "RAID.Slot.
volumes: - name: "volume_1" -name: Delete multiple volume dellemc_idrac_storage_volume: idrac_ip: "xx.xxx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" state: "delete" volumes: - name: "volume_1" - name: "volume_2" 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.
Table 28. Return Values Name Description Returned Type Sample iDRAC CSIOR Configures CSIOR property for all iDRAC or LC jobs Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_idrac_lc_attributes.md Example -name: Set up iDRAC LC Attributes dellemc_idrac_lc_attributes: idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" share_name: "xx.xx.xx.
Parameter Required Default Choices Comments mandatory for CIFS or NFS Network share. syslog Yes • • NA Enabled Disabled Whether to Enable or Disable iDRAC syslog Table 30. Return Values Nam Description Returned Type Sample iDRAC Syslog Configures iDRAC Syslog parameters Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_setup_idrac_syslog.md Example -name: Configure iDRAC Syslog Parameters dellemc_setup_idrac_syslog: idrac_ip: "xx.xx.
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.
Table 32. Return Values Name Description Boot to Network ISO Boots to a network ISO Image Returned Success Type Sample String https://github.com/dell/Dell-EMCAnsible-Modules-for-iDRAC/blob/ master/samples/ dellemc_boot_to_network_iso.md Example -name: Boot to Network ISO dellemc_boot_to_network_iso: idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" share_name: "xx.xx.xx.xx:/share" share_user: "xxxx" share_pwd: "xxxxxxxx" iso_image: "uninterrupted_os_installation_image.
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 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. Check_mode support: No Options Table 33.
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.
Parameter Required Default Choices • • • Comments GracefulShutdown PushPowerButton Nmi 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.
idrac_user: "xxxx" idrac_pwd: "xxxxxxxx" idrac_port: "xxx" Viewing LC Job Status Module: dellemc_get_lc_job_status Synopsis You can view the iDRAC or LC job status using this module. To view information about a job status, a job id is required. After a job is initiated, the system stages the job request information and sends a job id back to the system. You can query the progress and status of the job by using the job id. Check_mode support: No Options Table 39.
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. Check_mode support: No Options Table 41.
You can delete an LC job: • after the job is completed. • if you do not want to perform the job or if it is taking long to execute. Check_mode support: Yes Options Table 43. dellemc_delete_lc_job Parameter Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port job_id Yes NA NA JOB ID in the format "JID_XXXXXXXXX" Table 44.
Parameter Required Default Choices Comments idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port Table 46. Return Values Name Description Returned Type Sample LC Job Queue Deletes the LC job queue Success String https://github.com/dell/Dell-EMC-Ansible-Modules-for-iDRAC/ blob/master/samples/dellemc_delete_lc_job_queue.md Example -name: Delete LC Job Queue dellemc_delete_lc_job_queue: idrac_ip: "xx.xx.xx.
Parameter Required Default Choices Comments share_mnt No NA NA Local mount path of the network share with readwrite permission for Ansible user. This option is mandatory for CIFS or NFS Network share. lockdown_mode Yes NA • • Enabled Disabled Whether to Enable or Disable system lockdown mode Table 48. Return Values Name Description Returned Type Sample System Lockdown Mode Configures lockdown mode of the system Success String https://github.
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 documents from the Dell EMC support site You can access the required documents using the following links: • For Dell EMC Enterprise Systems Management documents — www.dell.com/esmmanuals • For Dell EMC OpenManage documents — www.dell.com/openmanagemanuals • For Dell EMC Remote Enterprise Systems Management documents — www.dell.com/esmmanuals • For iDRAC and Dell Lifecycle Controller documents — www.dell.
