Try SpotterExport or Import iDRAC Server Configuration Profile (SCP)
| "added in version" 2.1.0 of dellemc.openmanage"
Authors: Jagadeesh N V(@jagadeeshnv), Felix Stephen (@felixs88), Jennifer John (@Jennifer-John), Shivam Sharma (@ShivamSh3)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0Export the Server Configuration Profile (SCP) from the iDRAC or import from a network share (CIFS, NFS, HTTP, HTTPS) or a local path.
---
- 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\"}]}]}}"
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
command:
choices:
- import
- export
- preview
default: export
description:
- If C(import), the module performs SCP import operation.
- If C(export), the module performs SCP export operation.
- If C(preview), the module performs SCP preview operation.
type: str
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
idrac_ip:
description: iDRAC IP Address.
required: true
type: str
job_wait:
description: Whether to wait for job completion or not.
required: true
type: bool
scp_file:
description:
- Name of the server configuration profile (SCP) file.
- This option is mandatory if I(command) is C(import).
- The default format <idrac_ip>_YYmmdd_HHMMSS_scp is used if this option is not specified
for C(import).
- I(export_format) is used if the valid extension file is not provided for C(import).
type: str
export_use:
choices:
- Default
- Clone
- Replace
default: Default
description:
- Specify the type of Server Configuration Profile (SCP) to be exported.
- This option is applicable when I(command) is C(export).
- C(Default) Creates a non-destructive snapshot of the configuration.
- C(Replace) Replaces a server with another or restores the servers settings to a
known baseline.
- C(Clone) Clones settings from one server to another server with the identical hardware
setup. All settings except I/O identity are updated (e.g. will reset RAID). The
settings in this export will be destructive when uploaded to another system.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
idrac_port:
default: 443
description: iDRAC port.
type: int
idrac_user:
description:
- iDRAC username.
- If the username is not provided, then the environment variable C(IDRAC_USERNAME)
is used.
- 'Example: export IDRAC_USERNAME=username'
required: true
type: str
proxy_port:
default: '80'
description:
- Proxy port to authenticate.
- I(proxy_port) is required when I(share_name) is of type HTTPS or HTTP and I(proxy_support)
is C(true).
- I(proxy_port) is considered only when I(share_name) is of type HTTP or HTTPS and
is supported only on iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
proxy_type:
choices:
- http
- socks4
default: http
description:
- C(http) to select HTTP type proxy.
- C(socks4) to select SOCKS4 type proxy.
- I(proxy_type) is considered only when I(share_name) is of type HTTP or HTTPS and
is supported only on iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
share_name:
description:
- Network share or local path.
- CIFS, NFS, HTTP, and HTTPS network share types are supported.
- I(share_name) is mutually exclusive with I(import_buffer).
type: str
share_user:
description: 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.
type: str
proxy_server:
description:
- I(proxy_server) is required when I(share_name) is of type HTTPS or HTTP and I(proxy_support)
is C(true).
- I(proxy_server) is considered only when I(share_name) is of type HTTP or HTTPS and
is supported only on iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
export_format:
choices:
- JSON
- XML
default: XML
description: Specify the output file format. This option is applicable for C(export)
command.
type: str
import_buffer:
description:
- Used to import the buffer input of xml or json into the iDRAC.
- This option is applicable when I(command) is C(import) and C(preview).
- I(import_buffer) is mutually exclusive with I(share_name).
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
proxy_support:
default: false
description:
- Proxy to be enabled or disabled.
- I(proxy_support) is considered only when I(share_name) is of type HTTP or HTTPS
and is supported only on iDRAC9.
type: bool
version_added: 7.3.0
version_added_collection: dellemc.openmanage
shutdown_type:
choices:
- Graceful
- Forced
- NoReboot
default: Graceful
description:
- This option is applicable for C(import) command.
- If C(Graceful), the job gracefully shuts down the operating system and turns off
the server.
- If C(Forced), it forcefully shuts down the server.
- If C(NoReboot), the job that applies the SCP will pause until you manually reboot
the server.
type: str
idrac_password:
aliases:
- idrac_pwd
description:
- iDRAC user password.
- If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
is used.
- 'Example: export IDRAC_PASSWORD=password'
required: true
type: str
proxy_password:
description:
- Proxy password to authenticate.
- I(proxy_password) is considered only when I(share_name) is of type HTTP or HTTPS
and is supported only on iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
proxy_username:
description:
- Proxy username to authenticate.
- I(proxy_username) is considered only when I(share_name) is of type HTTP or HTTPS
and is supported only on iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
scp_components:
aliases:
- target
choices:
- ALL
- IDRAC
- BIOS
- NIC
- RAID
- FC
- InfiniBand
- SupportAssist
- EventFilters
- System
- LifecycleController
- AHCI
- PCIeSSD
default: ALL
description:
- If C(ALL), this option exports or imports all components configurations from the
SCP file.
- If C(IDRAC), this option exports or imports iDRAC configuration from the SCP file.
- If C(BIOS), this option exports or imports BIOS configuration from the SCP file.
- If C(NIC), this option exports or imports NIC configuration from the SCP file.
- If C(RAID), this option exports or imports RAID configuration from the SCP file.
- If C(FC), this option exports or imports FiberChannel configurations from the SCP
file.
- If C(InfiniBand), this option exports or imports InfiniBand configuration from the
SCP file.
- If C(SupportAssist), this option exports or imports SupportAssist configuration
from the SCP file.
- If C(EventFilters), this option exports or imports EventFilters configuration from
the SCP file.
- If C(System), this option exports or imports System configuration from the SCP file.
- If C(LifecycleController), this option exports or imports SupportAssist configuration
from the SCP file.
- If C(AHCI), this option exports or imports EventFilters configuration from the SCP
file.
- If C(PCIeSSD), this option exports or imports PCIeSSD configuration from the SCP
file.
- When I(command) is C(export) or C(import) I(target) with multiple components is
supported only on iDRAC9 with firmware 6.10.00.00 and above.
elements: str
type: list
share_password:
aliases:
- share_pwd
description: Network share user password. This option is mandatory for CIFS Network
Share.
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
include_in_export:
choices:
- default
- readonly
- passwordhashvalues
- customtelemetry
default: default
description:
- This option is applicable when I(command) is C(export).
- If C(default), it exports the default Server Configuration Profile.
- If C(readonly), it exports the SCP with readonly attributes.
- If C(passwordhashvalues), it exports the SCP with password hash values.
- If C(customtelemetry), exports the SCP with custom telemetry attributes supported
only in the iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
end_host_power_state:
choices:
- 'On'
- 'Off'
default: 'On'
description:
- This option is applicable for C(import) command.
- If C(On), End host power state is on.
- If C(Off), End host power state is off.
type: str
ignore_certificate_warning:
choices:
- ignore
- showerror
default: ignore
description:
- If C(ignore), it ignores the certificate warnings.
- If C(showerror), it shows the certificate warnings.
- I(ignore_certificate_warning) is considered only when I(share_name) is of type HTTPS
and is supported only on iDRAC9.
type: str
version_added: 7.3.0
version_added_collection: dellemc.openmanage
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to process the request because an error occurred.
MessageArgs: []
MessageId: GEN1234
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
msg:
description: Status of the import or export SCP job.
returned: always
sample: Successfully imported the Server Configuration Profile
type: str
scp_status:
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
type: dict