API Guide

Table Of Contents
Export server configuration profile
You can export Server Configuration Profile (SCP) with various components such as iDRAC, BIOS, NIC, RAID together or with
one of these components. You can export SCP from iDRAC to a local or a network shared location. For shared location, make
sure that a network share path is established. While exporting SCP to Network File System (NFS) or (CIFS) share, provide the
IP address of the network share where the exported file needs to reside in the share_name parameter.
idrac.config_mgr.scp_export(): Method used to export the system configuration.
synchronous : When the status is synchronous, the server tracks end to end job completion providing the message ID or job
ID, status of the job and completion of the job.
asynchronous - In asynchronous status the job in the server returns the iob ID and result of the job.
job_wait = True|False. Use the job_mgr APIs to wait for the job to complete or get status.
Export modes are Clone or Replace. Clone mode exported SCP can be imported into another device. If you have to replicate the
SCP to another systems, you should use export in Clone mode. If you are using the replace mode, then it would retire the entire
server.
While exporting you can export to a template %ip_%D%M%Y_%H%S.xml.
NOTE: Export features using CIFS shares may fail if there is a mismatch of the SMB version in iDRAC and OS.
Import server configuration profile
You can import the Server Configuration Profile (SCP) which was previously exported for that same server, or group of servers.
Importing SCP is useful in restoring the configuration of the server to the state stored in the profile. You can import SCP from a
local or a remote share to iDRAC. For a remote share, make sure that a network share path and the file name are available.
idrac.config_mgr.scp_import(): Method used to import the system configuration.
Exporting LC Logs
About this task
iDRAC provides Lifecycle log that contains events related to system, storage devices, network devices, firmware updates,
configura tion changes, license messages, and so on.
idrac.log_mgr.lclog_export: Allows you to export the log from the Lifecycle Controller to a remote share.
Export Complete LC Logs
idrac.log_mgr.complete_lclog_export(): Allows you to export the full log from the Lifecycle Controller to a remote
share.
Export TSR Logs
idrac.config_mgr.export_tsr(): Allows you to collect the TSR i.e hardware, OS and App data, then compressed
the .zip file save into the respective remote share path.
Server iDRAC settings and configuration
The following attributes provide the information about the server iDRAC settings and configurations.
iDRAC User Configuration
iDRAC Network Configuration
iDRAC Service Configuration
iDRAC Systems Settings
iDRAC User Configuration settings
The following API's provides the user credentials settings for the WSMAN.
Getting Started
51