dellemc.openmanage.idrac_server_config_profile module – Export or Import iDRAC Server Configuration Profile (SCP)
Note
This module is part of the dellemc.openmanage collection (version 9.8.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.idrac_server_config_profile.
New in dellemc.openmanage 2.1.0
Synopsis
Export the Server Configuration Profile (SCP) from the iDRAC or import from a network share (CIFS, NFS, HTTP, HTTPS) or a local path.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.14
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
If If If
Choices:
|
|
This option is applicable for If If Choices:
|
|
Specify the output file format. This option is applicable for The default export file format is always XML when the command is Choices:
|
|
Specify the type of Server Configuration Profile (SCP) to be exported. This option is applicable when command is
Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
iDRAC port. Default: |
|
iDRAC username. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
If If ignore_certificate_warning is considered only when share_name is of type HTTPS and is supported only on iDRAC9. Choices:
|
|
Used to import the buffer input of xml or json into the iDRAC. When the command is This option is applicable when command is import_buffer is mutually exclusive with share_name. |
|
This option is applicable when command is If If If If Choices:
|
|
Whether to wait for job completion or not. Choices:
|
|
Proxy password to authenticate. proxy_password is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9. |
|
Proxy port to authenticate. proxy_port is required when share_name is of type HTTPS or HTTP and proxy_support is proxy_port is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9. Default: |
|
proxy_server is required when share_name is of type HTTPS or HTTP and proxy_support is proxy_server is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9. |
|
Proxy to be enabled or disabled. proxy_support is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9. Choices:
|
|
proxy_type is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9. Choices:
|
|
Proxy username to authenticate. proxy_username is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9. |
|
If If If If If If If If If If If If If When command is Choices:
Default: |
|
Name of the server configuration profile (SCP) file. Only XML file format is supported when command is The default format <idrac_ip>_YYmmdd_HHMMSS_scp is used if this option is not specified for export_format is used if the valid extension file is not provided for |
|
Network share or local path. CIFS, NFS, HTTP, and HTTPS network share types are supported. share_name is mutually exclusive with import_buffer. Only “local” is supported when the command is |
|
Network share user password. This option is mandatory for CIFS Network Share. |
|
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. |
|
This option is applicable for If If If Choices:
|
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Notes
Note
This module requires ‘Administrator’ privilege for idrac_user.
Run this module from a system that has direct access to Dell iDRAC.
This module supports
check_mode.To import Server Configuration Profile (SCP) on the iDRAC8-based servers, the servers must have iDRAC Enterprise license or later.
For
importoperation,check_modeis supported only when target isALL.This module supports IPv4 and IPv6 addresses.
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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
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-generated file name
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "192.168.0.2:/share"
scp_components:
- BIOS
export_format: XML
export_use: Default
job_wait: true
- name: Import SCP with BIOS components in XML format from a NFS share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "192.168.0.2:/share"
command: import
scp_components:
- BIOS
scp_file: 192.168.0.1_20210618_162856.xml
shutdown_type: NoReboot
end_host_power_state: "Off"
job_wait: false
- name: Export SCP with RAID components in XML format to a CIFS share path with share user domain name
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "\\\\192.168.0.2\\share"
share_user: share_username@domain
share_password: share_password
scp_file: example_file.xml
scp_components:
- RAID
export_format: XML
export_use: Default
job_wait: true
- name: Import SCP with RAID components in XML format from a CIFS share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "\\\\192.168.0.2\\share"
share_user: share_username
share_password: share_password
command: import
scp_components:
- RAID
scp_file: example_file.xml
shutdown_type: Forced
end_host_power_state: "On"
job_wait: true
- name: Export SCP with ALL components in JSON format to a HTTP share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "http://192.168.0.3/share"
share_user: share_username
share_password: share_password
scp_file: example_file.json
scp_components:
- ALL
export_format: JSON
job_wait: false
- name: Import SCP with ALL components in JSON format from a HTTP share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
command: import
share_name: "http://192.168.0.3/share"
share_user: share_username
share_password: share_password
scp_file: example_file.json
shutdown_type: Graceful
end_host_power_state: "On"
job_wait: true
- name: Export SCP with ALL components in XML format to a HTTPS share path without SCP file name
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "https://192.168.0.4/share"
share_user: share_username
share_password: share_password
scp_components:
- ALL
export_format: XML
export_use: Replace
job_wait: true
- name: Import SCP with ALL components in XML format from a HTTPS share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
command: import
share_name: "https://192.168.0.4/share"
share_user: share_username
share_password: share_password
scp_file: 192.168.0.1_20160618_164647.xml
shutdown_type: Graceful
end_host_power_state: "On"
job_wait: false
- name: Preview SCP with IDRAC components in XML format from a CIFS share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
share_name: "\\\\192.168.0.2\\share"
share_user: share_username
share_password: share_password
command: preview
scp_components:
- ALL
scp_file: example_file.xml
job_wait: true
- name: Preview SCP with IDRAC components in JSON format from a NFS share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
share_name: "192.168.0.2:/share"
command: preview
scp_components:
- IDRAC
scp_file: example_file.xml
job_wait: true
- name: Preview SCP with IDRAC components in XML format from a HTTP share path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
share_name: "http://192.168.0.1/http-share"
share_user: share_username
share_password: share_password
command: preview
scp_components:
- ALL
scp_file: example_file.xml
job_wait: true
- name: Preview SCP with IDRAC components in XML format from a local path
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
share_name: "/scp_folder"
command: preview
scp_components:
- IDRAC
scp_file: example_file.json
job_wait: false
- name: Import SCP with IDRAC components in XML format from the XML content.
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
command: import
scp_components:
- IDRAC
job_wait: true
import_buffer: "<SystemConfiguration><Component FQDD='iDRAC.Embedded.1'><Attribute Name='IPMILan.1#Enable'>
Disabled</Attribute></Component></SystemConfiguration>"
- name: Export SCP with ALL components in XML format using HTTP proxy.
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
scp_components:
- ALL
share_name: "http://192.168.0.1/http-share"
proxy_support: true
proxy_server: 192.168.0.5
proxy_port: 8080
proxy_username: proxy_username
proxy_password: proxy_password
proxy_type: http
include_in_export: passwordhashvalues
job_wait: true
- name: Import SCP with IDRAC and BIOS components in XML format using SOCKS4 proxy
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
command: import
scp_components:
- IDRAC
- BIOS
share_name: "https://192.168.0.1/http-share"
proxy_support: true
proxy_server: 192.168.0.6
proxy_port: 8080
proxy_type: socks4
scp_file: filename.xml
job_wait: true
- name: Import SCP with IDRAC components in JSON format from the JSON content.
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "{{ idrac_ip }}"
idrac_user: "{{ idrac_user }}"
idrac_password: "{{ idrac_password }}"
ca_path: "/path/to/ca_cert.pem"
command: import
scp_components:
- IDRAC
job_wait: true
import_buffer: "{\"SystemConfiguration\": {\"Components\": [{\"FQDD\": \"iDRAC.Embedded.1\",\"Attributes\":
[{\"Name\": \"SNMP.1#AgentCommunity\",\"Value\": \"public1\"}]}]}}"
- name: Export custom default
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
job_wait: true
share_name: "/scp_folder"
command: export_custom_defaults
scp_file: example_file
- name: Import custom default
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
job_wait: true
share_name: "/scp_folder"
command: import_custom_defaults
scp_file: example_file.xml
- name: Import custom default using buffer
dellemc.openmanage.idrac_server_config_profile:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
job_wait: true
command: import_custom_defaults
import_buffer: "<SystemConfiguration><Component FQDD='iDRAC.Embedded.1'><Attribute Name='IPMILan.1#Enable'>Disabled</Attribute>
</Component></SystemConfiguration>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Status of the import or export SCP job. Returned: always Sample: |
|
SCP operation job and progress details from the iDRAC. Returned: success Sample: |