Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 3.0.0 User’s Guide
- 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)
- Modules for Redfish APIs
- Deprecated modules
- Deprecated iDRAC modules
- Install firmware
- View Lifecycle Controller status
- Export or Import Server Configuration Profile
- Configure time zone and NTP on iDRAC
- Configure iDRAC network
- Configure BIOS
- Configure iDRAC users
- Configure RAID
- Configure syslog
- Boot to a network ISO image
- Reset iDRAC
- View Lifecycle controller job status
- Export LC logs
- Delete LC job
- Delete LC job queue
- Deprecated OpenManage Enterprise (OME) modules
- Deprecated iDRAC modules
- Accessing documents from the Dell EMC support site
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.
share_password/
share_pwd
No NA NA
Network share user password. This option
is mandatory for CIFS Network Share.
scp_file No NA NA
SCP file name. This option is mandatory
for C(import) state.
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.
shutdown_type No Graceful
● Graceful
● Forced
● NoReboot
This option is applicable for C(import)
state.
● If C(Graceful), it gracefully shuts down
the server
● If C(Forced), it forcefully shuts down
the system
● If C(NoReboot), it does not reboot the
server
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) state.
export_use No Default
● Default
● Clone
● Replace
Specify the type of 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:
Modules for iDRAC
15