dellemc.openmanage.idrac_export_server_config_profile role – Role to export iDRAC Server Configuration Profile (SCP)

Note

This role is part of the dellemc.openmanage collection (version 8.7.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.

To use it in a playbook, specify: dellemc.openmanage.idrac_export_server_config_profile.

Entry point main – Role to export iDRAC Server Configuration Profile (SCP)

New in dellemc.openmanage 7.3.0

Synopsis

  • Role to export the Server Configuration Profile (SCP) from the iDRAC to a network share (CIFS, NFS, HTTP, HTTPS) or a local path.

Parameters

Parameter

Comments

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

export_format

string

Specify the output file format. This option is applicable for export command.

Choices:

  • "JSON"

  • "XML" ← (default)

export_use

string

Specify the type of Server Configuration Profile (SCP) to be exported.

This option is applicable when command is export.

Default Creates a non-destructive snapshot of the configuration.

Replace Replaces a server with another or restores the servers settings to a known baseline.

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.

Choices:

  • "Default" ← (default)

  • "Clone"

  • "Replace"

idrac_ip

string / required

iDRAC IP Address.

idrac_password

string

iDRAC user password.

idrac_port

integer

iDRAC port.

Default: 443

idrac_timeout

integer

The HTTPS socket level timeout in seconds.

Default: 30

idrac_user

string

iDRAC username.

include_in_export

string

This option is applicable when command is export.

If default, it exports the default Server Configuration Profile.

If readonly, it exports the SCP with readonly attributes.

If passwordhashvalues, it exports the SCP with password hash values.

If customtelemetry, exports the SCP with custom telemetry attributes supported only in the iDRAC9.

Choices:

  • "default" ← (default)

  • "readonly"

  • "passwordhashvalues"

  • "customtelemetry"

share_parameters

dictionary

Network share parameters.

ignore_certificate_warning

string

If ignore, it ignores the certificate warnings.

If showerror, it shows the certificate warnings.

ignore_certificate_warning is considered only when share_name is of type HTTPS and is supported only on iDRAC9.

Choices:

  • "ignore" ← (default)

  • "showerror"

proxy_password

string

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

string

Proxy port to authenticate.

proxy_port is required when share_name is of type HTTPS or HTTP and proxy_support is true.

proxy_port is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9.

Default: "80"

proxy_server

string

proxy_server is required when share_name is of type HTTPS or HTTP and proxy_support is true.

proxy_server is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9.

proxy_support

boolean

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:

  • false ← (default)

  • true

proxy_type

string

http to select HTTP type proxy.

socks4 to select SOCKS4 type proxy.

proxy_type is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9.

Choices:

  • "http" ← (default)

  • "socks4"

proxy_username

string

Proxy username to authenticate.

proxy_username is considered only when share_name is of type HTTP or HTTPS and is supported only on iDRAC9.

scp_file

string

Name of the server configuration profile (SCP) file.

The default format <idrac_ip>_YYMMDD_HHMMSS_scp is used if this option is not specified.

export_format is used if the valid extension file is not provided.

share_name

string / required

Network share or local path.

CIFS, NFS, HTTP, and HTTPS network share types are supported.

share_name is mutually exclusive with import_buffer.

share_password

string

Network share user password. This option is mandatory for CIFS Network Share.

share_user

string

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.

target

list / elements=string

If ALL, this module exports or imports all components configurations from SCP file.

If IDRAC, this module exports or imports iDRAC configuration from SCP file.

If BIOS, this module exports or imports BIOS configuration from SCP file.

If NIC, this module exports or imports NIC configuration from SCP file.

If RAID, this module exports or imports RAID configuration from SCP file.

Choices:

  • "ALL" ← (default)

  • "IDRAC"

  • "BIOS"

  • "NIC"

  • "RAID"

Default: ["ALL"]

validate_certs

boolean

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Choices:

  • false

  • true ← (default)