Dell EMC OpenManage Ansible Modules Version 2.0.
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 2.0.1 © Copyright 2018 - 2019 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?..................................................................................................................................................
Update device firmware............................................................................................................................................60 Manage jobs..................................................................................................................................................................... 62 View job details.......................................................................................................................................................
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) and modular infrastructure by leveraging the management automation capabilities in-built into the Integrated Dell Remote Access Controller (iDRAC) and OpenManage Enterprise (OME) respectively.
What's new? • The dellemc_idrac_firmware module is deprecated and all the functionality are added to the new idrac_firmware module. • The dellemc_idrac_server_config_profile module is deprecated and all the functionality are added to the new idrac_server_config_profile module. NOTE: • 6 With OpenManage Ansible Modules 2.0.1 release, the idrac_password and share_password aliases were introduced for idrac_pwd and share_pwd arguments.
2 Getting Started How OpenManage Ansible Modules works • How OpenManage Ansible Modules for iDRAC works • How OpenManage Ansible Modules for OME works Running your first Playbook Playbooks are essentially sets of instructions (plays) that you send to run on a single target or groups of targets (hosts).
3 Modules for iDRAC How OpenManage Ansible Modules for iDRAC 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.
4 Now run the playbook. Run the following command from the directory where you created the inventory and the playbook: ansible-playbook playbook.yml -i inventory 5 Press Enter. With OpenManage Ansible Modules, you can construct a playbook with a set of modules resulting in an automation workflow for configuration, deployments, and updates of PowerEdge servers.
Table 2. Return Values Name Description • Firmware Inventory • Components of a server and their firmware versions. List of dictionaries, 1 dictionary per firmware. Returned Type Sample Success String https://github.com/dell/Dell-EMC-AnsibleModules-for-iDRAC/blob/master/samples/ dellemc_get_firmware_inventory.md Examples -name: Get Installed Firmware Inventory dellemc_get_firmware_inventory: idrac_ip: "xx.xx.xx.
Parameter/aliases share_user share_password/ share_pwd share_mnt Required No No 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.
• All applicable updates contained in the repository are applied to the system. Check_mode support: No NOTE: This module is deprecated and replaced with idrac_firmware. Options Table 4. dellemc_idrac_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 job_wait Yes True NA Whether to wait for job completion or not.
returned: success sample: { 'InstanceID': 'JID_XXXXXXXXXXXX', 'JobState': 'Completed', 'Message': 'Job completed successfully.', 'MessageId': 'REDXXX', 'Name': 'Repository Update', 'JobStartTime': 'NA', 'Status': 'Success', } Example - name: Update firmware from repository on a Network Share dellemc_idrac_firmware: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_pwd: "user_pwd" share_name: "192.168.0.
Parameter Required Default Choices Comments reboot No False NA Whether to reboot after applying the updates or not. share_name Yes NA NA CIFS or NFS Network share 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.
Following are the tasks: • • • • • • • View LC status Server Configuration Profile Configuring iDRAC Configure BIOS Configure RAID Configure Collect System Inventory on Restart Configure syslog View LC status Module: dellemc_get_lcstatus Synopsis You can view the LC status on a PowerEdge server using this module. You must 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.
Synopsis This module exports the Server Configuration Profile (SCP) from iDRAC. It can also import from a network share or from a local file. Options Table 9. idrac_server_config_profile Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port import export • If C(import), will perform SCP import operations.
Parameter/aliases Required Default Choices Comments • If C(Off), End host power state is off export_format No XML • • JSON XML Specify the output file format. This option is applicable for C(export) state. export_use No Default • • • Default Clone Replace Specify the type of Sever Configuration Profile (SCP) to be exported. This option is applicable for C(export) state. Return Values msg: type: str description: status of the import or export SCP job.
- name: Export Server Configuration Profile to a network share dellemc_idrac_server_config_profile: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" share_name: "192.168.0.2:/share" share_user: "share_user_name" share_password: "share_user_password" job_wait: False - name: Export Server Configuration Profile to a local path dellemc_idrac_server_config_profile: idrac_ip: "192.168.0.
Parameter Required Default Choices Comments • scp_components No ALL • • • • • ALL IDRAC BIOS NIC RAID • • • • If C(ALL), the module imports all components configurations from SCP file. If C(iDRAC), the module imports iDRAC configuration from SCP file. If C(BIOS), the module imports BIOS configuration from SCP file. If C(NIC), the module imports NIC configuration from SCP file. If C(RAID), the module imports RAID configuration from SCP file. This option is applicable for C(import) state.
Examples - name: Import Server Configuration Profile from a network share dellemc_idrac_server_config_profile: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_pwd: "user_pwd" command: "import" share_name: "192.168.0.2:/share" share_user: "share_user_name" share_pwd: "share_user_pwd" scp_file: "scp_filename.xml" scp_components: "ALL" job_wait: True - name: Import Server Configuration Profile from a local path dellemc_idrac_server_config_profile: idrac_ip: "192.168.0.
Options Table 11.
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" share_user: "xxxx" share_pwd: "xxxxxxxx" scp_file: "scp_file.xml" scp_components: "ALL" job_wait: "True" 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.
Parameter Required Default Choices Comments share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share.
Options Table 15. dellemc_configure_idrac_users Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ 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'.
Parameter/aliases 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_u sers 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 16.
Table 17. dellemc_configure_idrac_timezone Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ 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'.
Configure iDRAC eventing Module: dellemc_configure_idrac_eventing Synopsis This module configures iDRAC eventing related attributes. Check_mode support: Yes Options Table 19.
Parameter/aliases Required Default Choices Comments 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 20.
Table 21. dellemc_configure_idrac_services Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ 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'.
Parameter/aliases Required Default Choices Comments discovery_port No 162 NA SNMP discovery port for iDRAC trap_format No None NA SNMP trap format for iDRAC Table 22. 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.
Parameter/aliases Required Default Choices Comments 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_password/ 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.
Parameter/aliases Required Default Choices • T_1000 Full Half Comments duplex_mode No NA • • 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 or Disable IPv4 configuration static_dn
enable_dhcp: dns_from_dhcp: enable_ipv4: static_dns_1: static_dns_2: static_gateway: static_net_mask: "Enabled" "Enabled" "Enabled" "x.x.x.x" "x.x.x.x" "None" "None" Configure BIOS Module: dellemc_configure_bios Synopsis This module configures the BIOS attributes for PowerEdge servers. Check_mode support: Yes Options Table 25.
Parameter/aliases 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. NA NOTE: I(boot_sequence) is mutually exclusive with I(boot_sources).
Parameter/aliases attributes Required No Default Choices NA Comments Dictionary of BIOS attributes and value pair. Attributes should be part of the Redfish Dell BIOS Attribute Registry. Redfish URI to view BIOS attributes: (https://I(idrac_ip)/ redfish/v1/Systems/System.Embedded.1/ Bios). NA 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).
OneTimeBootMode: "Enabled" BootSeqRetry: "Enabled" - name: Configure PXE Generic Attributes dellemc_configure_bios: idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_password: "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_password: "xxxxxxxx" boot_sources: - Name : "NIC.
Options Table 27. dellemc_configure_raid Parameter/aliases 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/aliases Required Default Choices Comments • WriteBackForce NoReadAhead ReadAhead Adaptive read_cache_policy No NoReadAhead • • • 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.
Options Table 29.
Parameter/aliases Required Default Choices Comments media_type No None • • HDD SDD Media type protocol No None • • SAS SATA Bus protocol state Yes view • • • create delete view • • • volumes No NA NA C(create) performs create volume operations. C(delete) performs remove volume operations. C(view) returns the storage view. A list of virtual disk-specific iDRAC attributes. This is applicable for C(create) and C(delete) operations.
} "retval": true Examples -name: Create single volume dellemc_idrac_storage_volume: idrac_ip: "192.168.0.1" idrac_user: "username" idrac_password: "password" controller_id: "RAID.Slot.1-1" state: "create" volumes: - drives: location: [5] -name: Create multiple volume dellemc_idrac_storage_volume: idrac_ip: "192.168.0.1" idrac_user: "username" idrac_password: "password" raid_reset_config: "True" state: "create" controller_id: "RAID.Slot.
idrac_ip: "192.168.0.1" idrac_user: "username" idrac_password: "password" state: "delete" volumes: - name: "volume_1" -name: Delete multiple volume dellemc_idrac_storage_volume: idrac_ip: "192.168.0.
Table 31. 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_password: "xxxxxxxx" share_name: "xx.xx.xx.
Parameter/aliases Required Default Choices Comments for Ansible user. This option is mandatory for CIFS or NFS Network share. syslog Yes • • NA Enabled Disabled Whether to Enable or Disable iDRAC syslog Table 33. 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.
Table 34. dellemc_boot_to_network_iso Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ idrac_pwd Yes NA NA iDRAC password idrac_port No 443 NA iDRAC port iso_image Yes NA NA Network ISO name share_name Yes NA NA CIFS or NFS Network share 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'.
Options Table 36. dellemc_get_system_inventory Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port Table 37. Return Values Name Description Returned Type Sample System Inventory Displays the PowerEdge Server System Inventory Success String https://github.
Options Table 38. dellemc_change_power_state Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port NA • • • • • • change_power Yes On ForceOff GracefulRestart GracefulShutdown PushPowerButton Nmi Desired power state Table 39.
Parameter/aliases Required Default Choices Comments idrac_password/ idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port Table 41. Return Values Name Description Returned Type Sample Reset iDRAC Resets the iDRAC Success String https://github.com/dell/Dell-EMC-Ansible-Modules-foriDRAC/blob/master/samples/dellemc_idrac_reset.md Example -name: Reset iDRAC dellemc_idrac_reset: idrac_ip: "xx.xx.xx.
idrac_ip: idrac_user: idrac_password: job_id: "xx.xx.xx.xx" "xxxx" "xxxxxxxx" "JID_1234567890" Export 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.
idrac_ip: idrac_user: idrac_password: idrac_port: share_name: share_user: share_password: job_wait: "xx.xx.xx.xx" "xxxx" "xxxxxxxx" "xxx" "xx.xx.xx.xx:/share" "xxxx" "xxxxxxxx" "True" Delete 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: • 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 46.
Delete 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. Check_mode support: No Options Table 48.
Table 50. dellemc_system_lockdown_mode Parameter/aliases Required Default Choices Comments idrac_ip Yes NA NA iDRAC IP Address idrac_user Yes NA NA iDRAC username idrac_password/ 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 user\domain if user is part of a domain else 'user'.
4 Modules for OpenManage Enterprise (OME) How OpenManage Ansible Modules for OME works OpenManage Enterprise (OME) is a system management and monitoring application that provides rich sets of features to manage the Dell EMC servers, chassis, storage, and network switches in an enterprise data center or IT environment.
1 Run the following command on the Ansible control machine: ansible-doc -l | grep "ome" 2 Press Enter. List of the available OME modules is displayed. To view the documentation of a module: 1 Run the following command on the Ansible control machine: ansible-doc 2 Press Enter. View device inventory Module: dellemc_ome_device_facts Synopsis This module retrieves the list of all devices with the exhaustive inventory of each device discovered using OME. Options Table 52.
description: Over all device_facts status. returned: on error sample: "Failed to fetch the device facts" ansible_facts: type: dict description: Device inventory details. returned: success sample: { "value": [ { "Actions": null, "AssetTag": null, "ChassisServiceTag": null, "ConnectionState": true, "DeviceManagement": [ { "DnsName": "dnsname.host.
dellemc_ome_device_facts: hostname: "192.168.0.1" username: "username" password: "password" fact_subset: "detailed_inventory" system_query_options: device_id: - 11111 - 22222 - name: Retrieve inventory details of specified devices identified by service tags MXL1234 and MXL4567. dellemc_ome_device_facts: hostname: "192.168.0.
Synopsis This module retrieves the list and details of all templates or details of a specific template. Options Table 53. dellemc_ome_template_facts Parameter Required Default Choices Comments hostname Yes NA NA Target IP Address or hostname username Yes NA NA Target username password Yes NA NA Target user password port No 443 NA Target device HTTPS port template_id No Na Na Unique ID of the template Return Values msg: type: str description: Over all template facts status.
Create, modify or deploy a template Module: dellemc_ome_template Synopsis This module creates, modifies or deploys a template. Options Table 54. dellemc_ome_template Parameter Required Default Choices Comments hostname Yes NA NA Target IP Address or hostname username Yes NA NA Target username password Yes NA NA Target user password port No 443 NA Target device HTTPS port state No create • • • template_id No NA NA Unique ID of the template to be modified or deployed.
Parameter Required Default Choices Comments • • NetworkBootIsoModel: Payload to specify the ISO deployment details. This is applicable for C(deploy) operation. Attributes: list of dictionaries of attribute values (if any) to be modified in the template to be deployed. This is applicable for C(deploy) operation. NOTE: See OpenManage Enterprise API Reference Guide for more details. Return Values msg: description: Overall status of the template operation.
- name: deploy template. dellemc_ome_template: hostname: "192.168.0.1" username: "username" password: "password" state: "deploy" template_id: 1234 device_id: - 12345 - 45678 device_service_tag: ['SVTG123', 'SVTG456'] attributes: NetworkBootIsoModel: BootToNetwork: false ShareType: "NFS" IsoPath: "bootToIsoPath.iso" ShareDetail: IpAddress: "192.168.0.
Parameter Required Default Choices Comments device_service_tag No NA NA List of targeted device service tags. device_id No NA NA List of targeted device ids. dup_file Yes NA NA Executable file to apply on the targets. Return Values msg: type: str description: "Overall firmware update status." returned: always sample: "Successfully updated the firmware." update_status: type: dict description: "Firmware Update job and progress details from the OME.
Examples - name: "Update firmware from DUP file using device ids." dellemc_ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" device_id: - 11111 - 22222 dup_file: "/path/Chassis-System-Management_Firmware_6N9WN_WN64_1.00.01_A00.EXE" - name: "Update firmware from DUP file using device service tags." dellemc_ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" device_service_tag: - KLBR111 - KLBR222 dup_file: "/path/Network_Firmware_NTRW0_WN64_14.07.
Return Values msg: description: Overall status of the job facts operation. returned: always type: str job_facts: description: Details of the OpenManage Enterprise jobs.
- name: Get filtered job details. dellemc_ome_job_facts: hostname: "192.168.0.1" username: "username" password: "password" system_query_options: top: 2 skip: 1 filter: "JobType/Id eq 8" Manage power state operations Module: ome_power_state Synopsis This module performs the supported power state management operations. Options Table 57.
} "CreatedBy": "user", "Editable": true, "EndTime": null, "Id": 11111, "JobDescription": "DeviceAction_Task", "JobName": "DeviceAction_Task_PowerState", "JobStatus": { "Id": 1111, "Name": "New" }, "JobType": { "Id": 1, "Internal": false, "Name": "DeviceAction_Task" }, "LastRun": "2019-04-01 06:39:02.
- name: Power state operation based on list of device ids. ome_powerstate: hostname: "192.168.0.1" username: "username" password: "password" device_id: "{{ item.device_id }}" power_state: "{{ item.state }}" with_items: - { "device_id": 11111, "state": "on" } - { "device_id": 22222, "state": "off" } - name: Power state operation based on list of device service tags. ome_powerstate: hostname: "192.168.0.1" username: "username" password: "password" device_service_tag: "{{ item.
type: dict description: Details of the users. returned: success sample: { "192.168.0.1": { "Id": "1814", "UserTypeId": 1, "DirectoryServiceId": 0, "Description": "user name description", "Name": "user_name", "Password": null, "UserName": "user_name", "RoleId": "10", "Locked": false, "IsBuiltin": true, "Enabled": true } } Examples - name: Retrieve basic details of all accounts. dellemc_ome_user_facts: hostname: "192.168.0.
Parameter Required Default Choices Comments Unique ID of the user to be deleted. user_id No NA NA NOTE: This option is mandatory for C(absent) operations. Payload data for the user operations. It can take the following attributes for C(present): attributes No {} NA • • • • • • • • • UserTypeId DirectoryServiceId Description Name Password UserName RoleId Locked Enabled NOTE: OME will throw an error message if required parameter is not provided for the operation.
Enabled: True - name: create user with all parameters ome_user: hostname: "192.168.0.1" username: "username" password: "password" attributes: UserName: "user2" Description: "user2 description" Password: "UserPassword" RoleId: "10" Enabled: True DirectoryServiceId: 0 UserTypeId: 1 Locked: False Name: "user2" - name: modify existing user ome_user: hostname: "192.168.0.
5 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.
6 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.
