dellemc / dellemc.openmanage / 2.1.5 / module / idrac_server_config_profile Export or Import iDRAC Server Configuration Profile (SCP). | "added in version" 2.9.10 of dellemc.openmanage" Authors: Jagadeesh N V(@jagadeeshnv) preview | supported by communitydellemc.openmanage.idrac_server_config_profile (2.1.5) — module
Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5
collections: - name: dellemc.openmanage version: 2.1.5
Export the Server Configuration Profile (SCP) from the iDRAC or Import from a network share or a local file.
--- - name: Import SCP from a network share and wait for this job to get completed. dellemc.openmanage.idrac_server_config_profile: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" command: "import" share_name: "192.168.0.2:/share" share_user: "share_user_name" share_password: "share_user_password" scp_file: "scp_filename.xml" scp_components: "ALL" job_wait: True
- name: Import SCP from a local path and wait for this job to get completed. dellemc.openmanage.idrac_server_config_profile: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" command: "import" share_name: "/scp_folder" scp_file: "scp_filename.xml" scp_components: "ALL" job_wait: True
- name: Export SCP to a network share dellemc.openmanage.idrac_server_config_profile: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" share_name: "192.168.0.2:/share" share_user: "share_user_name" share_password: "share_user_password" job_wait: False
- name: Export SCP 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" job_wait: False
- name: Export SCP to a local path with a specified name for the file. dellemc.openmanage.idrac_server_config_profile: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" share_name: "/scp_folder" # extension for filename is considered if provided scp_file: "exported_scp_filename" export_format: "JSON" job_wait: False
command: choices: - import - export default: export description: - If C(import), will perform SCP import operations. - If C(export), will perform SCP export operations. type: str 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 for C(export) command. type: str idrac_port: default: 443 description: iDRAC port. required: false type: int idrac_user: description: iDRAC username. required: true type: str share_name: description: CIFS or NFS Network Share or a local path. required: true 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 export_format: choices: - JSON - XML default: XML description: Specify the output file format. This option is applicable for C(export) command. type: str shutdown_type: choices: - Graceful - Forced - NoReboot default: Graceful description: - This option is applicable for C(import) command. - If C(Graceful), it gracefully shuts down the server. - If C(Forced), it forcefully shuts down the server. - If C(NoReboot), it does not reboot the server. type: str idrac_password: aliases: - idrac_pwd description: iDRAC user password. required: true type: str scp_components: choices: - ALL - IDRAC - BIOS - NIC - RAID default: ALL description: - If C(ALL), this module will import all components configurations from SCP file. - If C(IDRAC), this module will import iDRAC configuration from SCP file. - If C(BIOS), this module will import BIOS configuration from SCP file. - If C(NIC), this module will import NIC configuration from SCP file. - If C(RAID), this module will import RAID configuration from SCP file. type: str share_password: aliases: - share_pwd description: Network share user password. This option is mandatory for CIFS Network Share. type: str 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
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