Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 4.0.0 User’s Guide
- Contents
- Overview
- Getting Started
- Modules for iDRAC
- 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
- Modules for OpenManage Enterprise (OME)
- How OpenManage Ansible Modules work with OME
- Running your first OME Playbook
- Manage Devices
- Manage device configuration templates
- Template Service
- Manage the device firmware
- Manage jobs
- Manage users
- Manage identity pool
- Manage application settings
- Manage network configuration
- Manage fabrics
- Manage Profiles
- Device discovery
- Manage Chassis
- Manage Active Directory service and user groups
- Diagnostics
- Modules for Redfish APIs
- Deprecated modules
Table 4. idrac_server_config_profile (continued)
Parameter/aliases Required Default Choices Comments
end_host_power_stat
e
No On
● On
● Off
This option is applicable for C(import)
state.
● If C(On), End host power state is on
● 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) command.
export_use No Default
● Default
● Clone
● Replace
Specify the type of server 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.
returned: always
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.",
"MessageArgs": [],
"MessageId": "XXX123",
"Name": "Import Configuration",
"PercentComplete": 100,
"StartTime": "TIME_NOW",
"Status": "Success",
"TargetSettingsURI": null,
"retval": true
}
Examples
- name: Export SCP with IDRAC components in JSON format to a local path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
share_name: "/scp_folder"
scp_components: IDRAC
scp_file: example_file
export_format: JSON
export_use: Clone
job_wait: True
- name: Import SCP with IDRAC components in JSON format from a local path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
share_name: "/scp_folder"
command: import
scp_components: "IDRAC"
scp_file: example_file.json
shutdown_type: Graceful
end_host_power_state: "On"
job_wait: False
- name: Export SCP with BIOS components in XML format to a NFS share path with auto-
Modules for iDRAC
17