Dell EMC OpenManage Ansible Modules Version 3.0.0 User’s Guide January 2021 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...................................................................................................................... 6 Key Features.........................................................................................................................................................................6 What's new?.........................................................................................................................................................................
Set tagged and untagged VLANs in a template...................................................................................................60 Manage the device firmware..........................................................................................................................................63 Update device firmware.............................................................................................................................................63 Create a firmware catalog.........
Export LC logs............................................................................................................................................................ 145 Delete LC job...............................................................................................................................................................146 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 and modular infrastructure by leveraging the management automation capabilities in-built into the Integrated Dell Remote Access Controller (iDRAC), OpenManage Enterprise and OpenManage Enterprise Modular.
What's new? ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● Support for OpenManage Enterprise-Modular. Support for creating docker image of OpenManage Ansible modules. 'examples' and 'samples' directories are renamed to 'playbooks' and 'output' respectively. A security configuration guide is available for OpenManage Ansible Modules version 3.0.0. The ome_network_vlan module allows to create, modify, or delete a VLAN.
2 Getting Started Topics: • • How OpenManage Ansible Modules works Running your first Playbook How OpenManage Ansible Modules works ● How OpenManage Ansible Modules work with iDRAC ● How OpenManage Ansible Modules work with OME ● How OpenManage Ansible Modules work with Redfish APIs 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 Topics: • • • • • • • • How OpenManage Ansible Modules work with iDRAC Running your first iDRAC Playbook Updating Firmware Configuring PowerEdge Servers Deploying operating system Server Inventory Server administration tasks Storage controller How OpenManage Ansible Modules work with iDRAC 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.
tasks: - name: Get hardware inventory dellemc_get_system_inventory: idrac_ip: "{{ idrac_ip }}" idrac_user: "{{ idrac_user }}" idrac_password: "{{ idrac_password }}" 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.
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 Output Success String https://github.com/dell/dellemc-openmanageansible-modules/tree/devel/output/idrac/ dellemc_get_firmware_inventory.md Examples -name: Get Installed Firmware Inventory dellemc_get_firmware_inventory: idrac_ip: "xx.xx.xx.
Table 3. idrac_firmware (continued) Parameter/aliases share_name Required Yes Default NA Choices Comments NA Network share path of update repository. CIFS, NFS, HTP, HTTPS and FTS share types are supported. share_user No NA NA User name required to access the network share must be provided as either 'user@domain' or 'domain\user'. This option is mandatory for CIFS network share. share_password/ share_pwd No NA NA Network share user password.
share_name: "192.168.0.0:/share" reboot: True job_wait: True apply_update: True catalog_file_name: "Catalog.xml" - name: Update firmware from a repository on a CIFS Share. idrac_firmware: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" share_name: "\\\\192.168.0.0\\cifs" share_user: "share_user" share_password: "share_password" share_mnt: "/mnt_path" reboot: True job_wait: True apply_update: True catalog_file_name: "Catalog.
View Lifecycle Controller status Module: idrac_lifecycle_controller_status_info Synopsis This module shows the status of the Lifecycle Controller on a Dell EMC PowerEdge server. Check_mode support: No Options Table 4. idrac_lifecycle_controller_status_info 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 5.
Table 6. idrac_server_config_profile (continued) Parameter/aliases Required Default Choices Comments ● If C(export), will perform SCP export operations. job_wait Yes NA NA Whether to wait for job completion or not. 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 a part of a domain, else 'user'. This option is mandatory for CIFS Network Share.
{ } "Id": "JID_XXXXXXXXX", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.", "MessageArgs": [], "MessageId": "XXX123", "Name": "Import Configuration", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "Success", "TargetSettingsURI": null, "retval": true Examples - name: Import SCP from a network share and wait for this job to get completed. dellemc_idrac_server_config_profile: idrac_ip: "192.168.0.
scp_file: "exported_scp_filename" export_format: "JSON" job_wait: False Configuring iDRAC Following are the modules responsible for configuring specific iDRAC attributes.
Table 7. idrac_user (continued) Parameter/aliases ipmi_lan_privilege Required False Default Choices Comments ● Operator ● Administrator ● Administrator: A user with Administrator privilege can log in to iDRAC, and then configure iDRAC, configure users, clear logs, control and configure system, access virtual console, access virtual media, test alerts, and execute debug commands.
description: Configures the iDRAC users attributes. returned: success type: dict sample: { "@Message.ExtendedInfo": [{ "Message": "Successfully Completed Request", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "Base.1.5.Success", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "None", "Severity": "OK" }, { "Message": "The operation successfully completed.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.1.
user_password: user_password - name: Remove Delete existing iDRAC user account. dellemc.openmanage.idrac_user: idrac_ip: 198.162.0.1 idrac_user: idrac_user idrac_password: idrac_passwrod action: absent user_name: user_name Configure time zone and NTP on iDRAC Module: idrac_timezone_ntp Synopsis This module allows to configure time zone and NTP on iDRAC. Check_mode support: Yes Options Table 8.
Example -name: Configure time zone and NTP on iDRAC dellemc.openmanage.idrac_timezone_ntp: idrac_ip: "190.168.0.1" idrac_user: "user_name" idrac_password: "user_password" share_name: "user_name:/share" share_password: "share_password" share_user: "user_name" share_mnt: "/mnt/share" setup_idrac_timezone: "UTC" enable_ntp: Enabled ntp_server_1: "190.168.0.1" ntp_server_2: "190.168.0.2" ntp_server_3: "190.168.0.
Table 10.
Check_mode support: Yes Options Table 12. dellemc_configure_idrac_services Parameter Required Default Choices Comments idrac_ip True NA NA iDRAC IP Address idrac_user True NA NA iDRAC username idrac_password/ idrac_pwd True NA NA iDRAC user password idrac_port False 443 NA iDRAC port share_name True NA NA CIFS or NFS Network share or a local path share_user False NA NA Network share user in the format 'user@domain' or 'domain\user' if user is part of a domain else 'user'.
Table 12. dellemc_configure_idrac_services (continued) Parameter Required Default Choices Comments default value is 162, and the acceptable range is between 1 to 65535. discovery_port False 162 NA The SNMP agent port on the iDRAC. The default value is 161, and the acceptable range is between 1 to 65535. trap_format False None SNMPv1, SNMPv2 or SNMPv3 SNMP trap format for iDRAC NA This option used by iDRAC when it sends out SNMP and IPMI traps.
Table 14. idrac_network 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 Network share or a local path NA Network share user name. Use the format 'user@domain' or 'domain \\ user' if user is part of a domain. share_user No NA This option is mandatory for CIFS share. .
Table 14. idrac_network (continued) Parameter/aliases Required Default Choices Comments auto_negotiation No NA ● Enabled ● Disabled Allows iDRAC to automatically set the duplex mode and network speed. network_speed No NA ● T_10 ● T_100 ● T_1000 Select the network speed for the selected NIC. duplex_mode No NA ● Full ● Half Select the type of data transmission for the NIC. nic_mtu No None NA Maximum Transmission Unit of the NIC.
nic_mtu: 1500 ip_address: "192.168.0.1" enable_dhcp: Enabled enable_ipv4: Enabled static_dns_1: "192.168.0.1" static_dns_2: "192.168.0.1" dns_from_dhcp: Enabled static_gateway: None static_net_mask: None Configure BIOS Module: idrac_bios Synopsis This module allows to configure the BIOS attributes. Check_mode support: Yes Options Table 16.
Table 16. idrac_bios (continued) Parameter/ aliases Required Default Choices Comments Ensure that I(boot_mode) option is provided to determine which boot sequence is applied. NOTE: This option is deprecated, and will be removed in later version. Use I(attributes) for configuring the BIOS attributes. NOTE: I(boot_sequence) is mutually exclusive with I(boot_sources). nvme_mode No NA ● NonRaid ● Raid (deprecated) Configures the NVME mode in iDRAC 9 based PowerEdge servers.
Table 16. idrac_bios (continued) Parameter/ aliases boot_sources Required No Default NA Choices Comments NA List of boot devices to set the boot sources settings. NOTE: I(boot_sources) is mutually exclusive with I(attributes), I(boot_sequence), I(onetime_boot_mode), I(secure_boot_mode), I(nvme_mode), and I(boot_mode). Table 17. Return Values Name Description Returned Type Output msg Configures the BIOS attributes Success dict https://github.
Enabled : true Index : 2 - name: Configure boot sources - Enabled dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" boot_sources: - Name : "NIC.Integrated.1-1-1" Enabled : true - name: Configure boot sources - Index dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" boot_sources: - Name : "NIC.Integrated.
Table 18. dellemc_idrac_storage_volume (continued) Parameter/aliases Required Default Choices Comments read_cache_policy No NoReadAhead Read Cache Policy ● NoReadAhead ● ReadAhead ● AdaptiveReadAhea d stripe_size No 65536 NA Provide stripe size value in multiples of 64 * 1024 controller_id No NA NA Fully Qualified Device Descriptor (FQDD) of the storage controller, for example: RAID.Integrated.1-1 NOTE: Controller FQDD is required for C(create) RAID configuration.
returned: always sample: "Successfully completed the view storage volume operation" storage_status: type: dict description: Storage configuration job and progress details from the iDRAC. returned: success sample: { "Id": "JID_XXXXXXXXX", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.
capacity: raid_init_operation: 200 "None" -name: View all volume details dellemc_idrac_storage_volume: idrac_ip: idrac_user: idrac_password: "password" state: "192.168.0.1" "username" "view" -name: View specific volume details dellemc_idrac_storage_volume: idrac_ip: "192.168.0.1" idrac_user: "username" idrac_password: "password" state: "view" controller_id: "RAID.Slot.1-1" volume_id: "Disk.Virtual.0:RAID.Slot.1-1" -name: Delete single volume dellemc_idrac_storage_volume: idrac_ip: "192.168.0.
Table 19. dellemc_idrac_lc_attributes (continued) 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.
Table 21. idrac_syslog (continued) Parameter/ aliases Required share_user Default No Choices NA NA Comments Network share user name. Use the format 'user@domain' or 'domain \\ user' if user is part of a domain. This option is mandatory for CIFS share. share_password/ share_pwd No NA share_mnt No NA syslog Yes NA NA Network share user password. This option is mandatory for CIFS share. NA Local mount path of the network share with read-write permission for Ansible user.
● Operating system image is injected with required Dell drivers, and unattended response file. ● iDRAC is enabled, configured, and reachable. ● RAID is configured. Boot to a network ISO image Module: idrac_os_deployment Synopsis This module facilitates the operating system deployment. You can run this module to boot the target system to a bootable ISO image on a CIFS or NFS share. This module looks for the customized ISO in the configured share location and transfers the image to iDRAC to load it.
iso_image: "unattended_os_image.iso" expose_duration: 180 Return msg: ''' description: Details of the boot to network ISO image operation. returned: always type: dict sample: { "DeleteOnCompletion": "false", "InstanceID": "DCIM_OSDConcreteJob:1", "JobName": "BootToNetworkISO", "JobStatus": "Success", "Message": "The command was successful.", "MessageID": "OSD1", "Name": "BootToNetworkISO", "Status": "Success", "file": "192.168.0.0:/nfsfileshare/unattended_os_image.
idrac_user: "xxxx" idrac_password:"xxxxxxxx" Server administration tasks This section describes the tasks that you can run using OpenManage Ansible Modules.
idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_password:"xxxxxxxx" change_power: "xxxxxxx" Reset iDRAC Module: idrac_reset Synopsis ● This module resets iDRAC. ● iDRAC is not accessible for some time after running this module. It is recommended to wait for some time, before trying to connect to iDRAC. Check_mode support: Yes Options Table 29.
Table 31. idrac_lifecycle_controller_job_status_info (continued) Parameter/aliases Required Default Choices Comments idrac_password/ 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 32. Return Values Name Description Returned msg Displays the status of the Lifecycle Controller on Success a Dell EMC PowerEdge server Type Output dict https://github.
Table 33. idrac_lifecycle_controller_logs (continued) Parameter/aliases Required Default Choices Comments share_password/ share_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share. job_wait Yes NA ● True ● False Provides the option to wait for job completion Table 34. Return Values Name Description Returned Type Output msg Status of the export operation. Success dict https://github.
Table 36. Return Values Name Description Returned Type Output msg Status of the delete operation. Success dict https://github.com/dell/dellemc-openmanageansible-modules/tree/devel/output/idrac/ idrac_lifecycle_controller_jobs.md Examples - name: Delete Lifecycle Controller job queue dellemc.openmanage.idrac_lifecycle_controller_jobs: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" idrac_port: 443 - name: Delete Lifecycle Controller job using a job ID dellemc.
Table 37. dellemc_system_lockdown_mode (continued) Parameter/aliases Required Default Choices Comments ● Disabled Table 38. Return Values Name Description Returned Type Output System Lockdown Mode Configures lockdown mode of the system Success String https://github.com/dell/dellemc-openmanageansible-modules/tree/devel/output/idrac/ dellemc_system_lockdown_mode.md Example -name: Configure System Lockdown Mode dellemc_system_lockdown_mode: idrac_ip: "xx.xx.xx.
Table 39. idrac_redfish-storage-controller (continued) Parameter Required Default Choices Comments ● C(SetControllerKey) - Sets the key on controllers, which is used to encrypt the drives in Local key Management(LKM). ● C(RemoveControllerKey) Erases the encryption key on the controller. ● C(ReKey) - Resets the key on the controller. target False NA NA ● Fully Qualified Device Descriptor (FQDD) of the target physical drive that is assigned as a spare.
Table 39. idrac_redfish-storage-controller (continued) Parameter Required Default Choices Comments key_id False NA NA ● This is a user supplied text label associated with the passphrase. ● This option is mandatory when I(command) is C(SetControllerKey) or C(ReKey), and when I(mode) is C(LKM). old_key False NA NA ● Security key passphrase used by the encryption-capable controller. ● This option is mandatory when I(command) is C(ReKey) and I(mode) is C(LKM). .
} } ], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information" Examples - name: Assign [a] dedicated hot spare. idrac_redfish_storage_controller: baseuri: "192.168.0.1:443" username: "user_name" password: "user_password" volume_id: "Disk.Virtual.0:RAID.Slot.1-1" target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1" tags: - assign_dedicated_hot_spare - name: Assign [a] global hot spare. idrac_redfish_storage_controller: baseuri: "192.168.0.
- name: Reset configuration. idrac_redfish_storage_controller: baseuri: "192.168.0.1:443" username: "user_name" password: "user_password" command: "ResetConfig" controller_id: "RAID.Slot.
4 Modules for OpenManage Enterprise (OME) Topics: • • • • • • • • • • • How OpenManage Ansible Modules work with OME Running your first OME Playbook View device information Manage device configuration templates Manage the device firmware Manage jobs Manage users Manage identity pool Manage application settings Manage network configuration Manage fabrics How OpenManage Ansible Modules work with OME OpenManage Enterprise (OME) is a system management and monitoring application that provides rich sets of feat
- hosts: PowerEdge connection: local gather_facts: False tasks: - name: Retrieve basic inventory of all devices. ome_device_info: hostname: "192.168.0.1" username: "username" password: "password" 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.
Table 40. ome_device_info (continued) Parameter Required Default Choices Comments status of specified devices. system_query_options No NA ● device_id: A list of unique identifier is applicable for C(detailed_inventory) and C(subsystem_health). ● device_service_tag: A list of service tags is applicable for C(detailed_inventory) and C(subsystem_health). ● inventory_type: For C(detailed_inventory), it returns details of the specified inventory type.
} ] } "Status": 4000, "SystemId": 2031, "Type": 2000 Examples - name: Retrieve basic inventory of all devices. ome_device_info: hostname: "192.168.0.1" username: "username" password: "password" - name: Retrieve basic inventory for devices identified by IDs 33333 or 11111 using filtering. ome_device_info: hostname: "192.168.0.
password: "password" fact_subset: "subsystem_health" system_query_options: device_service_tag: - MXL1234 - MXL4567 Manage device configuration templates This section describes the specifications for template operations on devices managed by OME for hardware configuration and deployment operations. Following are the tasks for managing device configuration templates: 1. 2. 3. 4.
} } "Id": 1, "IdentityPoolId": 0, "IsBuiltIn": true, "IsPersistencePolicyValid": false, "IsStatelessAvailable": false, "LastUpdatedBy": null, "LastUpdatedTime": "1970-01-31 00:00:56.372144", "Name": "iDRAC 14G Enable Performance Profile for Virtualization", "SourceDeviceId": 0, "Status": 0, "TaskId": 0, "TypeId": 2, "ViewTypeId": 4 Examples - name: Retrieve basic details of all templates. ome_template_info: hostname: "192.168.0.
Table 42. ome_template (continued) Parameter Required Default Choices Comments ● C(clone) creates a clone of an existing template. template_id template_name device_id device_service_tag template_view_type False False False False False NA ● ID of the existing template. ● This option is applicable when I(command) is C(modify), C(deploy), C(delete) and C(export). ● It is mutually exclusive with I(template_name). NA ● Name of the existing template.
Table 42. ome_template (continued) Parameter Required Default Choices Comments ● Attributes: List of dictionaries of attributes (if any) to be modified in the deployment template. This is applicable for when I(command) is C(deploy) and C(modify). ● Content: The XML content of template. This is applicable when I(command) is C(import). ● Type: Template type ID, indicating the type of device for which configuration is supported, such as chassis and servers. This is applicable when I(command) is C(import).
"Severity": "Critical", "Resolution": "Retry the operation. If the issue persists, contact your system administrator." } ] } } Examples - name: Create a template from a reference device. ome_template: hostname: "192.168.0.1" username: "username" password: "password" device_id: 25123 attributes: Name: "New Template" Description: "New Template description" - name: Modify template name, description, and attribute value. ome_template: hostname: "192.168.0.
# The Device ID should be mentioned above in the 'device_id' section. # Service tags not allowed. - DeviceId: 12765 Attributes: - Id : 15645 Value : "0.0.0.0" IsIgnored : false - DeviceId: 10173 Attributes: - Id : 18968, Value : "hostname-1" IsIgnored : false - name: Deploy template and Operating System (OS) on multiple devices. ome_template: hostname: "192.168.0.
ShareType: "NFS" IsoTimeout: 1 # allowable values(1,2,4,8,16) in hours IsoPath: "/home/iso_path/filename.iso" ShareDetail: IpAddress: "192.168.0.2" ShareName: "sharename" User: "share_user" Password: "share_password" Options: EndHostPowerState: 1 ShutdownType: 0 TimeToWaitBeforeShutdown: 300 Schedule: RunLater: true RunNow: false - name: Delete a template. ome_template: hostname: "192.168.0.1" username: "username" password: "password" command: "delete" template_id: 12 - name: Export a template.
Name=\"RAIDforeignConfig\">Clear\n \n\nReady \nNo\n\n \nReady\n No\n\n\n" Description: "Imported Template description" - name: Import template from loc
Return Values msg: type: str description: Overall identity pool status of the attach or detach operation. returned: always sample: Successfully attached identity pool to template. error_info: description: Details of the HTTP Error. returned: on HTTP error type: dict sample: { "error": { "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information.", "@Message.
Table 44. ome_template_network_vlan (continued) Parameter Required Default Choices Comments ● It is mutually exclusive with I(template_id). template_id False NA NA ● ID of the template ● It is mutually exclusive with I(template_name). nic_identifier True NA NA Display name of the NIC port in the template for VLAN configuration. untagged_networks False NA NA List of untagged networks and their corresponding NIC ports.
Return Values msg: type: str description: Overall status of the template VLAN operation. returned: always sample: "Successfully applied the network settings to template" error_info: description: Details of the HTTP Error. returned: on HTTP error type: dict sample: { "error": { "@Message.ExtendedInfo": [{ "Message": "Unable to process the request because an error occurred:", "MessageArgs": "", "MessageId": "CGEN6001", "RelatedProperties": [], "Resolution": "Retry the operation.
- port: 4 tagged_network_ids: [] tagged_network_names: [] - port: 2 tagged_network_names: [] Manage the device firmware This section describes the following firmware processes that can be carried out on the devices managed by OME, using OpenManage Ansible Modules● ● ● ● ● Update device firmware. Create a firmware catalog. Create a firmware baseline. Retrieve the list and details of all the baselines. Retrieve baseline compliance details.
Table 45. ome_firmware (continued) Parameter Required Default Choices Comments ● I(baseline_names) is mutually exclusive with I(device_group_names), I(device_id) and I(device_service_tag). dup_file False NA NA Executable file to apply on the targets. Return Values msg: type: str description: Overall firmware update status. returned: always sample: "Successfully submitted the firmware update job." update_status: type: dict description: Firmware Update job and progress details from the OME.
sample: { "error": { "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information.", "@Message.ExtendedInfo": [ { "MessageId": "GEN1234", "RelatedProperties": [], "Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "Severity": "Critical", "Resolution":"Retry the operation. If the issue persists, contact your system administrator." } ] Examples - name: Update firmware from a DUP file using device ids.
Table 46. ome_firmware_catalog Parameter Required Default Choices Comments hostname True NA NA Target IP Address or hostname username True NA NA Target username password True NA NA Target user password port False 443 NA Target HTTPS port catalog_name True NA NA Name of the firmware catalog being created. catalog_description False NA NA Description of the catalog being created.
"BaseLocation": null, "BundlesCount": 0, "Filename": "catalog.gz", "Id": 0, "LastUpdated": null, "ManifestIdentifier": null, "ManifestVersion": null, "NextUpdate": null, "PredecessorIdentifier": null, "ReleaseIdentifier": null, "Repository": { "CheckCertificate": true, "Description": "HTTPS Desc", "DomainName": null, "Id": null, "Name": "catalog4", "Password": null, "RepositoryType": "HTTPS", "Source": "company.
hostname: "192.168.0.1" username: "username" catalog_name: "catalog_name" catalog_description: "catalog_description" repository_type: "CIFS" source: "192.167.0.1" source_path: "cifs/R940" file_name: "catalog.gz" repository_username: "repository_username" repository_password: "repository_password" repository_domain: "repository_domain" - name: create catalog from a NFS network share. ome_firmware_catalog: hostname: "192.168.0.
Table 47. ome_firmware_baseline (continued) Parameter Required Default Choices Comments with I(device_ids) and I(device_group_names). device_group_names False NA NA List of group names. I(device_group_names) is mutually exclusive with I(device_ids) and I(device_service_tags).
} } Examples - name: create baseline from device Ids. ome_firmware_baseline: hostname: "192.168.0.1" username: "username" password: "password" baseline_name: "baseline_name" baseline_description: "baseline_description" catalog_name: "catalog_name" device_ids: - 1010 - 2020 - name: create baseline from device service tags. ome_firmware_baseline: hostname: "192.168.0.
Return Values msg: type: str description: Overall baseline information. returned: on error sample: "Successfully fetched firmware baseline information." baseline_info: type: dict description: Details of the baselines. returned: success sample: { "@odata.id": "/api/UpdateService/Baselines(239)", "@odata.type": "#UpdateService.
Table 49. ome_firmware_baseline_compliance_info Parameter Required Default Choices Comments hostname True NA NA Target share address or hostname. username True NA NA Target username. password True NA NA Target user password. port False 443 NA Target HTTPS port. baseline_name False NA NA ● Name of the baseline for which the device based compliance report is generated. ● This option is mandatory for generating baseline based device compliance report.
Table 49. ome_firmware_baseline_compliance_info (continued) Parameter Required Default Choices Comments based compliance report is generated. ● Either I(device_ids), I(device_service_tags), or I(device_group_names) is required to generate device based compliance report. ● I(device_group_names) is mutually exclusive with I(device_ids), I(device_service_tags), and I(baseline_name). ● Devices without reports are ignored. Return values msg: type: str description: Overall baseline compliance report status.
Drive", "ComplianceStatus": "CRITICAL", "Criticality": "Recommended", "CurrentVersion": "DN02", "Id": 1259, "ImpactAssessment": "", "Name": "TOSHIBA AL14SE 1.8 TB 2.5 12Gb 10K 512n SAS HDD "Path": "FOLDER04086111M/1/SASDrive_Firmware_VDGFM_WN64_DN03_A00.EXE", "PrerequisiteInfo": "", "RebootRequired": true, "SourceName": "DCIM:INSTALLED#304_C_Disk.Bay.1:Enclosure.Internal.0-1:RAID.Integrated.
} Examples - name: Retrieves baseline based compliance report for specific device IDs. ome_firmware_baseline_compliance_info: hostname: "192.168.0.1" username: "username" password: "password" device_ids: - 11111 - 22222 - name: Retrieves device based compliance report for specific device service Tags. ome_firmware_baseline_compliance_info: hostname: "192.168.0.
Table 50. dellemc_ome_job_facts (continued) Parameter Required Default Choices Comments username Yes NA NA Target username password Yes NA NA Target user password port No 443 NA Target HTTPS port job_id No NA NA Unique ID of the job NA ● top: Number of records to return. Default value is 100. ● skip: Number of records to skip. Default value is 0. ● filter: Filter records by the values supported.
]} } Examples - name: Get all jobs details. dellemc_ome_job_facts: hostname: "192.168.0.1" username: "username" password: "password" - name: Get job details for id. dellemc_ome_job_facts: hostname: "192.168.0.1" username: "username" password: "password" job_id: 12345 - name: Get filtered job details. dellemc_ome_job_facts: hostname: "192.168.0.
Return Values msg: type: str description: "Overall power state operation job status." returned: always sample: "Power State operation job submitted successfully." job_status: type: dict description: "Power state operation job and progress details from the OME.
power_state: "off" - name: Power state operation based on device service tag. ome_powerstate: hostname: "192.168.0.1" username: "username" password: "password" device_service_tag: "KLBR111" power_state: "on" - 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.
Table 52. ome_user_info (continued) Parameter Required Default Choices Comments the supported values. I(filter) query format must be aligned with OData standards. Return Values msg: type: str description: Over all status of fetching user facts. returned: on error sample: "Failed to fetch the user facts" user_info: type: dict description: Details of the users. returned: success sample: { "192.168.0.
● creates a new user account. ● modifies or deletes an existing user account. Options Table 53. ome_user 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 present ● present ● absent ● C(present) creates a user in case the I(UserName) provided inside I(attributes) does not exist .
"ObjectGuid": null, "Oem": null, "Password": null, "PlainTextPassword": null, "RoleId": "10", "UserName": "test", "UserTypeId": 1 } Examples - name: Create user with required parameters. ome_user: hostname: "192.168.0.1" username: "username" password: "password" attributes: UserName: "user1" Password: "UserPassword" RoleId: "10", Enabled: True - name: Create user with all parameters ome_user: hostname: "192.168.0.
Manage identity pool Identity pools are used in template-based deployment of servers. They facilitate the virtualization of network identities required for accessing systems using Ethernet, iSCSI, FCoE, or Fibre Channel (FC). This section describes how to manage the settings of an identity pool. Manage Identity pool settings Module: ome_identity_pool Synopsis This module allows to create, modify, or delete a single identity pool on OpenManage Enterprise. Options Table 54.
Table 54. ome_identity_pool (continued) Parameter Required Default Choices Comments ● identity_count- Number of MAC addresses. fcoe_settings False NA NA Applicable for creating and modifying an identity pool using FCoE settings. I(starting_mac_address) and I(identity_count) are required to create an identity pool. Suboptions● starting_mac_addressStarting MAC address of the FCoE setting. ● identity_count- Number of MAC addresses.
Table 54. ome_identity_pool (continued) Parameter Required Default Choices Comments using fibre channel (FC) settings. I(starting_address) and I(identity_count) are required to create an identity pool. This option allows OpenManage Enterprise to generate a Worldwide port name (WWPN) and Worldwide node name (WWNN) address. The value 0x2001 is prefixed to the beginning address for the generation of a WWPN, and 0x2000 for a WWNN.
Examples - name: Create an identity pool using ethernet, FCoE, iCSCI and FC settings. ome_identity_pool: hostname: "192.168.0.
identity_count: 98 - name: Delete an identity pool. ome_identity_pool: hostname: "192.168.0.
Table 55. ome_application_network_proxy (continued) Parameter Required Default Choices Comments enable_authentication False NA NA ● Enables or disables proxy authentication. ● If I(enable_authenticat ion) is true, a username and password must be provided. ● If I(enable_authenticat ion) is false, the proxy username and password are set to its default values. proxy_username False NA NA Username of the proxy server. This option is mandatory when I(enable_authentication ) is true.
} ], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information." } } ''' Examples - name: Update proxy configuration and enable authentication. ome_application_network_proxy: hostname: "192.168.0.1" username: "username" password: "password" enable_proxy: true ip_address: "192.168.0.2" proxy_port: 444 enable_authentication: true proxy_username: "proxy_username" proxy_password: "proxy_password" - name: Reset proxy authentication.
Table 56. ome_application_network_address (continued) Parameter Required Default Choices Comments enable_nic False True NA Enable or disable Network Interface Card (NIC) configuration. interface_name False NA NA ● If there are multiple interfaces, network configuration changes can be applied to a single interface using the interface name of the NIC. ● If this option is not specified, the primary interface is chosen by default.
Table 56. ome_application_network_address (continued) Parameter Required Default Choices Comments If I(enable_auto_configuration) is true, then OpenManage Enterprise retrieves the IP configuration—IPv6 address, prefix, and gateway, from a DHCPv6 server on the existing network. ● static_ip_address: Static IPv6 address. This is applicable when I(enable_auto_configuration) is false. ● static_prefix_le.ngth: Static IPv6 prefix length. This is applicable when I(enable_auto_configuration) is false.
Table 56. ome_application_network_address (continued) Parameter Required Default Choices Comments reboot_delay False NA NA The time in seconds, after which settings are applied. This option is not mandatory. Return values msg: type: str description: Overall status of the network address configuration change. returned: always sample: Successfully updated network address configuration network_configuration: type: dict description: Updated application network address configuration.
"Resolution": "Make sure that all dependent fields contain valid content and retry the operation.", "Severity": "Critical" } ], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information." } } Examples - name: IPv4 network configuration for primary interface ome_application_network_address: hostname: "192.168.0.1" username: "username" password: "password" enable_nic: true ipv4_configuration: enable: true enable_dhcp: false static_ip_address: 192.168.0.
- name: Disbale nic interface eth1 ome_application_network_address: hostname: "192.168.0.1" username: "username" password: "password" enable_nic: false interface_name: eth1 - name: Complete network settings for interface eth1 ome_application_network_address: hostname: "192.168.0.1" username: "username" password: "password" enable_nic: true interface_name: eth1 ipv4_configuration: enable: true enable_dhcp: false static_ip_address: 192.168.0.2 static_subnet_mask: 255.255.254.0 static_gateway: 192.168.0.
Table 57. ome_application_network_webserver (continued) Parameter Required Default Choices Comments webserver_timeout False NA NA ● The duration, in minutes, after which a web user interface session is automatically disconnected. ● If a change is made to the session timeout, it will only take effect after the next login. Return Values msg: type: str description: Overall status of the network web server configuration change.
username: "username" password: "password" webserver_port: 8443 Manage time configuration Module: ome_application_network_time Synopsis This module allows the configuration of network time. Options Table 58.
description: Updated application network time configuration. returned: success sample: { "EnableNTP": false, "JobId": null, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": null, "TimeSource": "Local Clock", "TimeZone": "TZ_ID_1", "TimeZoneIdLinux": null, "TimeZoneIdWindows": null, "UtcTime": null } error_info: description: Details of the HTTP error. returned: on HTTP error type: dict sample: { "error": { "@Message.
NOTE: If a certificate is uploaded, which is identical to an already existing certificate, it is accepted by the module. Options Table 59. ome_application_certifcate Parameters Required Default Choices Comments hostname True NA NA Target IP address or hostname username True NA NA Target username password True NA NA Target user password port False 443 NA Target HTTPS port command False NA NA C(generate_csr) allows the generation of a CSR and C(upload) uploads the certificate.
Uv7cALZWqoHblPirAgjmJ8PipTkV93bWr0i34tUJgEb9g/aHOJ6nV4zAyc3zhfqjt p4PHAaBqIXPe0tbiqj7WZwE6GPPaW5seRGvzAIPuwn4kod4tXB0DQt4kSIh9TyCSG mh5mBAMdOD7Wd0ddXxmeoFJPa/sYQJZarJ/TPr2JAJAAKdxz2XLPokLHmjG02Xje3 RWQDNm+ngR/UTdXs/51kLrSwlU2LXFaQeBdcrwMdiZCOJPsfl6kf9fxobvqScdRYl gjJO7S5UcjJkBkeNURc080N9DCknV4bO1lo9BOA4aEhjo9gFFIUNk8iscMJJqyvHh BhzRSWH6fx7u9NGhnlDEOoyJnjceuI7zDS3CT/7pByuCoDc+dK2DezansSJHV4xYC eBmO14MpukxfoMxbSXZUdfkQgZZ1LmJGTYH0omGIm0KC+7g2ITZf1FrR8HcjEbKgV ZopugdSPXGp4P7eLRA/xIIp3GbrRXbSAumAO5fNefVsIzxZ34f
Create, modify, or delete a VLAN Module: ome_network_vlan Synopsis This module allows to: ● Create a VLAN on OpenManage Enteprise. ● Modify or delete an existing VLAN on OpenManage Enterprise. Options Table 60.
Table 60. ome_network_vlan (continued) Parameters Required Default Choices Hypervisor Management, Storage - iSCSI, Storage FCoE, Storage Data Replication, VM Migration, and VMWare FT Logging. Comments I(hostname)/api/ NetworkConfigurati onService/ NetworkTypes ). Return Values msg: type: str description: Overall status of the VLAN operation. returned: always sample: "Successfully created the VLAN." vlan_status: type: dict description: Details of the VLAN that is either created or modified.
Examples - name: Create a VLAN range dellemc.openmanage.ome_network_vlan: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" state: present name: "vlan1" description: "VLAN desc" type: "General Purpose (Bronze)" vlan_minimum: 35 vlan_maximum: 40 tags: create_vlan_range - name: Create a VLAN with a single value dellemc.openmanage.
Table 61. ome_network_vlan_info (continued) Parameter Required Default Choices Comments username True NA NA Target username password True NA NA Target user password port False 443 NA Target HTTPS port id False NA NA ● A unique identifier of the network VLAN available in the device. ● I(id) and I(name) are mutually exclusive. name False NA NA ● A unique name of the network VLAN available in the device. ● I(name) and I(id) are mutually exclusive.
"NetworkTrafficType": "Ethernet", "QosType": { "Id": 3, "Name": "Silver" }, "VendorCode": "GeneralPurpose" } ] }, "UpdatedBy": null, "UpdatedTime": "2020-09-02 18:49:11.507", "VlanMaximum": 112, "VlanMinimum": 112 } error_info: description: Details of the HTTP Error. returned: on HTTP error type: dict sample: { "error": { "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information.", "@Message.
Table 62. ome_network_port_breakout Parameter Required Default Choices Comments hostname True NA NA Target IP address or hostname username True NA NA Target username password True NA NA Target user password port False 443 NA Target HTTPS port target_port True NA NA The ID of the port in the switch to breakout. Enter the port ID in the format: Service tag:port. For example, 2HB7NX2:ethernet1/1/1 3. breakout_type True NA NA ● The preferred breakout type. For example, 4X10GE.
"Visible": true } error_info: description: Details of the HTTP Error. returned: on HTTP error type: dict sample: { "error": { "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information.", "@Message.ExtendedInfo": [ { "MessageId": "GEN1234", "RelatedProperties": [], "Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "Severity": "Critical", "Resolution": "Retry the operation.
Table 63. ome_smart_fabric (continued) Parameter Required Default Choices Comments NOTE: The create, modify, or delete fabric operation takes around 15-20 minutes to complete. It is recommended not to start another operation until the current operation is completed. name True NA NA Provide the I(name) of the fabric to be created, deleted or modified. new_name False NA NA Provide the I(name) of the fabric to be modified.
Table 63. ome_smart_fabric (continued) Parameter Required Default Choices Comments Management Address to be included in LLDP messages. . NOTE: OpenManage Enterprise Modular 1.0 does not support this option. NOTE: Some software networking solutions require a single management address to be transmitted by all Ethernet switches to represent the entire fabric. Enable this feature only when connecting to such a solution. Return Values msg: type: str description: Overall status of the fabric operation.
state: present name: "fabric1" description: "fabric desc" fabric_design: "2xMX9116n_Fabric_Switching_Engines_in_different_chassis" primary_switch_service_tag: "SVTG123" secondary_switch_service_tag: "PXYT456" override_LLDP_configuration: "Enabled" - name: Modify a fabric ome_smart_fabric: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" state: present name: "fabric1" new_name: "fabric_gold1" description: "new description" - name: Delete a fabric ome_smart_fabric: hostname: "{{hostn
Table 64. ome_smart_fabric_uplink (continued) Parameter Required Default Choices Comments created, modified, or deleted. new_name False NA NA Provide the new I(new_name) for the uplink. description False NA NA Provide a short description for the uplink to be created or modified. uplink_type False NA Ethernet, FCoE, FC Gateway, FC Direct Attach, or Ethernet-no Spanning Tree. Specify the uplink type. NOTE: The uplink type cannot be changed for an existing uplink.
Table 64. ome_smart_fabric_uplink (continued) Parameter Required Default Choices Comments mandatory for this option. secondary_switch_serv False ice_tag NA NA Service tag of the secondary switch. secondary_switch_port False s NA NA ● The IOM slots to be connected to the secondary switch. ● I(secondary_switch _service_tag) is mandatory for this option. tagged_networks: False NA NA VLANs to be associated with the uplink I(name).
hostname: "192.168.0.
username: "username" password: "password" state: "present" fabric_name: "fabric1" name: "uplink1" description: "uplink ports modified" primary_switch_service_tag: "ABC1234" primary_switch_ports: - ethernet1/1/6 - ethernet1/1/7 secondary_switch_service_tag: "XYZ1234" secondary_switch_ports: - ethernet1/1/9 - ethernet1/1/10 tags: modify_ports - name: Modify Uplink networks ome_smart_fabric_uplink: hostname: "192.168.0.
5 Modules for Redfish APIs Topics: • • • • How OpenManage Ansible Modules work with Redfish APIs Firmware update using standard Redfish URI Manage storage volume configuration Manage device power state How OpenManage Ansible Modules work with Redfish APIs The Redfish Scalable Platforms Management API is a standard defined by the Distributed Management Task Force (DMTF). Redfish is a next-generation systems management interface standard which enables scalable, secure, and open server management.
Table 65. redfish_firmware (continued) Parameter Required Default Choices Comments firmware_repo/ component.exe transfer_protocol False HTTP HTTP, HTTPS, FTP, NSF, CIFS, FTP, OEM, SCP, SFTP, or TFTP ● Protocol used to transfer the firmware image file. ● Applicable for URIbased update. NOTE: Dell PowerEdge servers support transfer protocols only through HTTPbased shares. Return values msg: description: Overall status of the firmware update task.
Examples - name: Update the firmware from a single executable file available in a HTTP protocol redfish_firmware: baseuri: "192.168.0.1" username: "user_name" password: "user_password" image_uri: "http://192.168.0.2/firmware_repo/component.exe" transfer_protocol: "HTTP" - name: Update the firmware from a single executable file available in a local path redfish_firmware: baseuri: "192.168.0.1" username: "user_name" password: "user_password" image_uri: "/home/firmware_repo/component.
Table 66. redfish_storage_volume (continued) Parameter Required Default Choices Comments ○ I(state) is C(absent), when deleting a volume. ○ I(command) is C(initialize), when initializing a volume. state False NA Present, or absent. ● C(present) creates a storage volume for a specified I (controller_id), or modifies the storage volume for a specified I (volume_id). NOTE: Modification of an existing volume depends on drive and controller capabilities.
Table 66. redfish_storage_volume (continued) Parameter Required Default Choices Comments drives False NA NA ● FQDD of the Physical disks. ● For exampleDisk.Bay.0:Enclosure.I nternal.0-1:RAID.Slot.1 -1. ● Only applicable when I(state) is C(present) when creating a new volume. block_size_bytes False NA NA Block size in bytes.Only applicable when I(state) is C(present). capacity_bytes False NA NA ● Virtual disk size in bytes. ● Only applicable when I(state) is C(present).
Table 66. redfish_storage_volume (continued) Parameter Required Default Choices Comments ● Only applicable when I(command) is C(initialize). Return Values msg: description: Overall status of the storage configuration operation. returned: always type: str sample: "Successfully submitted create volume task." task: type: dict description: Returns ID and URI of the created task.
username: "username" password: "password" state: "present" controller_id: "RAID.Slot.1-1" volume_type: "NonRedundant" drives: - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1 - name: Modify a volume's encryption type settings. redfish_storage_volume: baseuri: "192.168.0.1" username: "username" password: "password" state: "present" volume_id: "Disk.Virtual.5:RAID.Slot.1-1" encryption_types: "ControllerAssisted" encrypted: true - name: Delete an existing volume. redfish_storage_volume: baseuri: "192.168.0.
Table 67. redfish_powerstate (continued) Parameter Required Default Choices Comments ● C(ForceRestart): Turns off the device immediately, and then restarts the server. ● C(GracefulRestart): Performs graceful shutdown of the device, and then restarts the device. ● C(GracefulShutdow n): Performs a graceful shutdown of the device, and then turns off the device. ● If C(Nmi): Sends a diagnostic interrupt to the device. This is usually a nonmaskable interrupt (NMI) on x86 systems.
Table 67. redfish_powerstate (continued) Parameter Required Default Choices Comments / redfish/v1/ Systems) Examples - name: Manage power state of the device. redfish_powerstate: baseuri: "192.168.0.1" username: "username" pasword: "password" reset_type: "On" - name: Manage power state of a specified device. redfish_powerstate: baseuri: "192.168.0.1" username: "username" password: "password" reset_type: "ForceOff" resource_id: "System.Embedded.
6 Deprecated modules The OpenManage Ansible modules listed here are deprecated. Topics: • • Deprecated iDRAC modules Deprecated OpenManage Enterprise (OME) modules Deprecated iDRAC modules Install firmware These modules are deprecated and replaced with idrac_firmware. Module: dellemc_idrac_firmware Synopsis: You can install the firmware from a repository on a network share (CIFS, NFS) to keep the system updated.
Table 68. dellemc_idrac_firmware (continued) Parameter Required Default Choices Comments is mandatory for CIFS Network share. share_pwd share_mnt No Yes NA NA NA Network share user password. This option is mandatory for CIFS Network share. NA Local mount path of the network share with read/write permission for ansible user This option is mandatory for Network share. Return Values msg: type: str description: Over all firmware update status.
Options Table 69. dellemc_install_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. catalog_file_name No Catalog.xml NA Catalog file name relative to the I(share_name). reboot No False NA Whether to reboot after applying the updates or not.
job_wait: catalog_file_name: "True" "Catalog.xml" View Lifecycle Controller status This module is deprecated and replaced with idrac_lifecycle_controller_status_info. 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. Check_mode support: No Options Table 71.
Table 73. dellemc_idrac_server_config_profile (continued) Parameter Required Default Choices Comments idrac_pwd Yes NA NA iDRAC user password idrac_port No 443 NA iDRAC port ● If C(import), will perform SCP import operations. ● If C(export), will perform SCP export operations. command No export ● import ● export job_wait Yes NA NA Whether to wait for job completion or not. share_name Yes NA NA CIFS or NFS Network Share or a local path.
sample: "Successfully imported the Server Configuration Profile" scp_status: type: dict description: SCP operation job and progress details from the iDRAC. returned: success sample: { "Id": "JID_XXXXXXXXX", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.
Module: dellemc_import_server_config_profile Synopsis You can import an SCP file (in an XML or JSON format) exported from a golden PowerEdge server configuration to one or more servers, thus achieving an effortless, consistent, and automated deployment. Importing an SCP file is useful in restoring the configuration of the server to the state stored in the profile. You can import SCP from a local or a remote share to iDRAC.
Table 74. dellemc_import_server_config_profile (continued) Parameter Required Default Choices Comments ● If NoReboot, it does not reboot the server Table 75. Return Values Name Description Returned Import SCP Imports SCP from a network share or from a local file Success Type Sample String https://github.com/dell/ dellemcopenmanage-ansible-modules/ blob/devel/output/deprecated/ dellemc_import_server_config_profile.
Table 76. dellemc_export_server_config_profile (continued) Parameter Required Default Choices Comments ● If the value is False, it returns immediately with a JOB ID after queuing the SCP export job in LC job queue 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 78. 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'.
Synopsis This module configures the iDRAC networking attributes. Check_mode support: Yes Options Table 80.
Table 80.
duplex_mode: nic_mtu: ip_address: enable_dhcp: dns_from_dhcp: enable_ipv4: static_dns_1: static_dns_2: static_gateway: static_net_mask: "Full" "1500" "x.x.x.x" "Enabled" "Enabled" "Enabled" "x.x.x.x" "x.x.x.x" "None" "None" Configure BIOS This module is deprecated and replaced with idrac_bios. Module: dellemc_configure_bios Synopsis This module configures the BIOS attributes for PowerEdge servers. Check_mode support: Yes Options Table 82.
Table 82. dellemc_configure_bios (continued) 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.
Table 82. dellemc_configure_bios (continued) Parameter/ aliases 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_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.
This module creates, modifies or deletes an iDRAC local user. Check_mode support: Yes Options Table 84.
Table 84. dellemc_configure_idrac_users (continued) Parameter/aliases Required Default Choices Comments 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 85. Return Values Name Description Returned Type Sample iDRAC users Configures the iDRAC users attributes Success String https://github.
Table 86. dellemc_configure_raid (continued) 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_pwd No NA NA Network share user password. This option is mandatory for CIFS Network share. NA Local mount path of the network share with read-write permission for Ansible user.
Table 86. dellemc_configure_raid (continued) Parameter/aliases Required state Yes Default NA Choices Comments ● present ● absent ● If the value is 'present', the module will perform 'create' operations ● If the value is 'absent', the module will perform 'remove' operations Table 87. Return Values Name Description Returned Type Sample RAID configuration Configures the RAID configuration attributes Success String https://github.
Table 88. dellemc_setup_idrac_syslog (continued) Parameter/ aliases Required Default Choices No NA NA Network share user password. This option is mandatory for CIFS Network share. 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. share_password/ share_pwd share_mnt No NA syslog Yes NA Comments ● ● Enabled Disabled Type Sample String https://github.
Table 90. dellemc_boot_to_network_iso (continued) Parameter/aliases Required Default Choices Comments 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'. 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. Table 91.
Example -name: Reset iDRAC dellemc_idrac_reset: idrac_ip: "xx.xx.xx.xx" idrac_user: "xxxx" idrac_password:"xxxxxxxx" idrac_port: "xxx" View Lifecycle controller job status This module is deprecated and replaced with idrac_lifecycle_controller_job_status_info. 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.
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 96.
Check_mode support: Yes Options Table 98. dellemc_delete_lc_job 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 job_id Yes NA NA JOB ID in the format "JID_XXXXXXXXX" Table 99.
Table 101. Return Values Name Description Returned Type Sample LC Job Queue Deletes the LC job queue Success String https://github.com/dell/dellemc-openmanageansible-modules/blob/devel/output/deprecated/ dellemc_delete_lc_job_queue.md Example -name: Delete LC Job Queue dellemc_delete_lc_job_queue: idrac_ip: "xx.xx.xx.
Table 102. dellemc_ome_device_facts (continued) Parameter Required Default Choices Comments ● inventory_type: For C(detailed_inventory), it returns details of the specified inventory type. ● filter: For C(basic_inventory), it filters the collection of devices. I(filter) query format should be aligned with OData standards. C(subsystem_health) or both can be applicable. Return Values msg: type: str description: Over all device_facts status.
username: "username" password: "password" - name: Retrieve basic inventory for devices identified by IDs 33333 or 11111 using filtering. dellemc_ome_device_facts: hostname: "192.168.0.1" username: "username" password: "password" fact_subset: "basic_inventory" system_query_options: filter: "Id eq 33333 or Id eq 11111" - name: Retrieve inventory details of specified devices identified by IDs 11111 and 22222. dellemc_ome_device_facts: hostname: "192.168.0.
View templates This module is deprecated and replaced with ome_template_info. Module: dellemc_ome_template_facts Synopsis This module retrieves the list and details of all templates or details of a specific template. Options Table 103.
password: "password" template_id: 1 Template operations This module is deprecateed and replaced with ome_template. Module: dellemc_ome_template Synopsis This module creates, modifies or deploys a template. Options Table 104.
Table 104. dellemc_ome_template (continued) Parameter Require d 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: "New Custom Template" Description: "Custom Template Description" - 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.
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.
- 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.07_A00-00_01.EXE" View user account details This module is deprecated and replaced with ome_user_info Module: dellemc_ome_user_facts Synopsis This module retrieves the list and basic details of all user accounts or details of a specific user account.
password: "password" - name: Retrieve details of a specific account identified by its account ID. dellemc_ome_user_facts: hostname: "192.168.0.
7 Accessing documents from the Dell EMC support site You can access the required documents in one of the following ways: ● Using the following links: ○ For Dell EMC Enterprise Systems Management, Dell EMC Remote Enterprise Systems Management, and Dell EMC Virtualization Solutions documents — https://www.dell.com/esmmanuals ○ For Dell EMC OpenManage documents — https://www.dell.com/openmanagemanuals ○ For iDRAC documents — https://www.dell.
