Dell EMC OpenManage Python Software Development Kit Version 1.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © Copyright2018 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Introduction to OpenManage python software development toolkit............................................................... 5 SDK concepts and architectural components................................................................................................................ 5 2 Installation and Uninstallation of OMPSDK.................................................................................................... 6 Installing OMPSDK......................................................
iDRAC LC status check...................................................................................................................................................
1 Introduction to OpenManage python software development toolkit DellEMC OpenManage python software development kit (OMPSDK) is a library for programatically managing DellEMC Servers and Chassis. Using this library a user can perform lifecycle operations on DellEMC PowerEdge servers, chassis storage and switches.
2 Installation and Uninstallation of OMPSDK Installing OMPSDK To install OMPSDK, there are some prerequisites which are essential. Prerequisites: Ensure that you have the following: • Python v2.7 or v3.4 and above. • Package management system (pip). Run the following command pip install omsdk OMPSDK is installed and the package is available in PyPI (Python package Index).
3 OpenManage Python SDK API introduction OpenManage Python SDK (OMPSDK) API Module allows data center and IT administrators to automate and orchestrate the provisioning, configuration, deployment, and update of Dell EMC PowerEdge Servers (12th generation of PowerEdge servers and later) by using the management automation capabilities in-built into the integrated Dell remote access controller (iDRAC). This product evolves conservatively and values simplicity in design and setup.
Table 2. Parameters for the Credentials Parameter Name Type Allowed Values creds Dictionary of credentials Snmpv2Credentials UserCredentials Description A bundle of credentials required to communicate to the device driver. Snmpv2Credentials UserCredentials Table 3. Parameter for Protocol preference Parameter Name Type Allowed Values protopref Enumeration of preferred protocol ProtocolEnum.WSMAN ProtocolEnum.SNMP ProtocolEnum.
Table 5. Parameters for sdkinfra.get_driver Parameter Name Type Allowed Values ipaddr String NA Description The IP address or hostname of the device. Table 6. Parameters for device type Parameter Name Type Allowed Values driver_en Enumeration of the device type sdkinfra.driver_enum.iDRAC sdkinfra.driver_enum.CMC sdkinfra.driver_enum.Compellent sdkinfra.driver_enum.EqualLogic sdkinfra.driver_enum.MDArray sdkinfra.driver_enum.F10 sdkinfra.driver_enum.
Return type: ObjectDevice driver: A driver handle to configure or monitor the drivers. Example: get_driver(driver_en, ipaddr, creds, protopref=None, pOptions=None) Sdkbase.iBaseDriver.get_entityjson API string/Method: Sdkbase.iBaseDriver.get_entityjson. Description: The Sdkbase.iBaseDriver.get_entityjson() is used to create the JSON of the device by fetching the attributes from the device using the protocol. It internally creates the raw JSON of the device. Return type: Table 10.
Parameter Name Type Allowed Values iDRACCompEnum.LogicalSystem CMCCompEnum.System iDRACCompEnum.NIC CMCCompEnum.VirtualDisk iDRACCompEnum.PCIDevice iDRACCompEnum.PowerSupply iDRACCompEnum.PresenceAndSta tusSensor iDRACCompEnum.PhysicalDisk iDRACCompEnum.Sensors_Amper age iDRACCompEnum.Sensors_Battery iDRACCompEnum.Sensors_Fan iDRACCompEnum.Sensors_Intrusio n iDRACCompEnum.Sensors_Temper ature iDRACCompEnum.Sensors_Voltage iDRACCompEnum.SystemMetrics iDRACCompEnum.VFlash iDRACCompEnum.Video iDRACCompEnum.
Table 13. Parameters for Sdkdevice.iDeviceDriver.get_json_device Parameter Name Type Allowed Values monitorfilter MonitorScope MonitorScope.BasicInventory MonitorScope.ConfigState MonitorScope.Health MonitorScope.Inventory MonitorScope.Key MonitorScope.MainHealth MonitorScope.Metrics MonitorScope.OtherHealth MonitorScope.OtherInventory Description The category of filters to apply. Table 14.
Parameter Name Type Allowed Values iDRACCompEnum.Video iDRACCompEnum.VirtualDisk Description The required components. Return type: Table 15. Parameter for return type Returns Return type JSON The formatted JSON of the device with all the applied process attributes—mapping, units conversion. NOTE: Before utilizing the APIs, ensure to apply the sdkinfra.find_driver or sdkinfra.get_driver. Sdkcreds.Snmpv2Credentials API string/Method: Sdkcreds.Snmpv2Credentials.
Table 19. Parameter for password Parameter Name Type Allowed Values password String NA Description Password for WSMAN communication. Sdkwsmanbase.WsManOptions API string/Method: Sdkwsmanbase.WsManOptions . Description: Options to establish WSMAN communication. Table 20. Parameters for Sdkwsmanbase.WsManOptions Parameter Name Type Allowed Values authentication AuthenticationType NA Description HTTP authentication type Basic, Digest. Table 21.
Table 25. Parameter for verifying SSL certificate Parameter Name Type Allowed Values verify_ssl Boolean NA Description SSL certificate verification. Sdkredfishbase.RedfishOptions API string/Method: Sdkredfishbase.RedfishOptions. Description: Options to establish REDFISH communication. Table 26. Parameters for Sdkredfishbase.RedfishOptions Parameter Name Type authentication AuthenticationType Description HTTP authentication type Basic, Digest. Table 27.
Table 31. Parameter for verify ssl Parameter Name Type Allowed Values verify_ssl Boolean NA Description SSL certificate verification. Administration tasks API list This section lists the available Administration tasks APIs. idrac.config_mgr.power_boot API string/Method: idrac.config_mgr.power_boot(Power_state). Protocol Support: WSMAN. Description: The idrac.config_mgr.power_boot(Power_state) allows you to power On/Off the Server. Table 32. Parameters for idrac.config_mgr.power_boot(PowerBootEnum.
Table 33. Parameters for idrac.config_mgr.reset_idrac Parameter Name Type Allowed Values Force ResetForceEnum Description Description: This method is used to reset the iDRAC. 0 - Graceful - Reset is performed after the device is properly restarted. 1 - Force - Reset is performed without a proper shutdown of the device. ResetForceEnum.Graceful ResetForceEnum.Force idrac.config_mgr.reset_to_factory API string/Method: idrac.config_mgr.reset_to_factory. Protocol Support: WSMAN, Redfish.
Export and Import Tasks API list This section lists the available Export and Import Tasks APIs. idrac.config_mgr.scp_export API string/Method: idrac.config_mgr.scp_export. Protocol Support: WSMAN, Redfish. Description: This method is used to export the system configuration from the Lifecycle Controller to a local or a remote share location. Parameters: Table 36. Parameters for idrac.config_mgr.scp_export Parameter Name Type export_format ExportFormatEnum Allowed Values ExportFormatEnum.
Parameter Name Type Allowed Values _Values IncludeInExportEnum.Include_Both This API allows you to include more while exporting the file. The additional information added with include_in_export are: Description 1 - IncludeInExportEnum.Include_Read_Only - Includes read only values. 2 - IncludeInExportEnum.Include_Password_Hash_Values - Includes password hash values. 3 - IncludeInExportEnum.Include_Both - Includes both the values. IncludeInExportEnum.Default - 0 Table 39. Parameters for idrac.config_mgr.
Parameter Name Type Allowed Values SCPTargetEnum.NIC SCPTargetEnum.RAID To identify the component for export. It identifies one or more FQDDs. Selective list of FQDDs should be given in comma-separated format. Description SCPTargetEnum.IDRAC - The module exports only the iDRAC component in SCP file. SCPTargetEnum.BIOS - The module exports BIOS configuration in SCP file. SCPTargetEnum.NIC - The module exports NIC configuration in SCP file. SCPTargetEnum.
Table 44. Parameters for idrac.config_mgr.scp_import Parameter Name Type Allowed Values end_host_power_state EndHostPowerStateEnum Description The desired host power state after the import operation is complete. EndHostPowerStateEnum.Off EndHostPowerStateEnum.On 0 - Off 1 - On Default value is 0 Table 45. Parameters for idrac.config_mgr.scp_import Parameter Name Type Allowed Values job_wait Boolean True/False Description This API raises a flag to wait for the job to complete.
Parameter Name Type Allowed Values SCPTargetEnum.NIC SCPTargetEnum.RAID Description To identify the component for Import. It identifies one or more FQDDs. Selective list of FQDDs should be given in comma-separated format. SCPTargetEnum.IDRAC - The module imports iDRAC configuration in SCP file. SCPTargetEnum.BIOS - The module imports BIOS configuration in SCP file. SCPTargetEnum.NIC - The module imports NIC configuration in SCP file. SCPTargetEnum.
Parameters: Table 51. Parameters for idrac.log_mgr.lclog_export Parameter Name Type Allowed Values job_wait Boolean True/False Description This API raises a flag to wait for the job to complete. A false value will return the Job ID. Table 52. Parameters for idrac.log_mgr.
local_share = LocalFile(local=os.path.join(, "path", "to", "lc-logs-file.xml")) export_lclog_streaming = idrac.log_mgr.lclog_export(share_path=local_share) Returns: Success or Failure Return type: JSON idrac.log_mgr.complete_lclog_export API string/Method: idrac.log_mgr.complete_lclog_export. Protocol Support: WSMAN. Description: The complete_lclog_export() method is used to export the full log from the Lifecycle Controller to a remote share. Parameters: Table 54. Parameters for idrac.log_mgr.
idrac.log_mgr.complete_lclog_export(tsr_file) # Export LC Full Logs - CIFS Share cifs_share = FileOnShare(remote=\\\, isFolder=, creds=UserCredentials(, )) tsr_file = cifs_share.new_file() idrac.log_mgr.complete_lclog_export(tsr_file) # Export LC Full Logs - Local Share local_share = LocalFile(local=os.path.join(, "path", "to", )) idrac.log_mgr.complete_lclog_export(local_share) Returns: Success or Failure.
Table 58. Parameters for idrac.config_mgr.export_tsr Parameter Name Type Allowed Values tsr_store_path FileOnShare—for CIFS and NFS Share Description This method collects the TSR i.e hardware, OS and App data, then compresses and saves the .zip file to remote share path. The FileOnShare API allows you to view the share path where file needs to be exported. Example: #Export TSR - NFS Share nfs_share = FileOnShare(remote=:/, mount_point=:\>, isFolder=
Table 59. Parameters for idrac.user_mgr.Users.new Parameter Name Type Allowed Values UserName_Users String User defined string Description Allows you to create a user name. Table 60. Parameters for idrac.user_mgr.Users.new Parameter Name Type Allowed Values Password_Users String User defined string Description Allows you to create a password. Table 61. Parameters for idrac.user_mgr.Users.
Table 64. Parameters for idrac.user_mgr.Users.new Parameter Name Type Enable_Users ENUM Description Allows you to enable a user. Allowed Values Enable_UsersTypes.Enabled Enable_UserTypes.Disabled Table 65. Parameters for idrac.user_mgr.Users.new Parameter Name Type SolEnable_Users ENUM Description Allows you to enable a SOL user. Allowed Values SolEnable_UsersTypes.Enabled SolEnable_UsersTypes.Disabled Table 66. Parameters for idrac.user_mgr.Users.
idrac.user_mgr.Users.new ( UserName_Users="Abc123", Password_Users="Xyz123", Privilege_Users=Privilege_UsersTypes.Administrator, IpmiLanPrivilege_Users=IpmiLanPrivilege_UsersTypes.Administrator, IpmiSerialPrivilege_Users=IpmiSerialPrivilege_UsersTypes.Administrator, Enable_Users=Enable_UsersTypes.Enabled, SolEnable_Users=SolEnable_UsersTypes.Enabled, ProtocolEnable_Users=ProtocolEnable_UsersTypes.Disabled, AuthenticationProtocol_Users=AuthenticationProtocol_UsersTypes.
Description: The idrac.config_mgr.configure_dns allows you to configure the DNS server. Table 70. Parameters for idrac.config_mgr.configure_dns Parameter Name Type Allowed Values register_idrac_on_dns Enum Description Allows you to register the iDRAC on DNS. DNSRegister_NICTypes.Enabled DNSRegister_NICTypes.Disabled Table 71. Parameters for idrac.config_mgr.configure_dns Parameter Name Type Allowed Values dns_idrac_name String None Description Allows you to configure the DNS iDRAC name.
Description: The idrac.config_mgr.configure_ipv4() allows you to configure the IPv4 Settings. Table 74. Parameters for idrac.config_mgr.configure_ipv4 Parameter Name Type Allowed Values ip_address String IP Address Description Enter an IP (IPv4) address or a hostname of the shared folder. The maximum character limit is 64. Table 75. Parameters for idrac.config_mgr.
Table 80. Parameters for idrac.config_mgr.configure_ipv4 Parameter Name Type Allowed Values gateway String User defined values Description Configure the Default Gateway IP address. Table 81. Parameters for idrac.config_mgr.configure_ipv4 Parameter Name Type Allowed Values net_mask String User defined values Description Configure the iDRAC subnet mask. Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=False, c
Table 84. Parameters for idrac.config_mgr.configure_static_ipv4 Parameter Name Type Allowed Values dns_2 String User defined values Description Indicates the static alternate DNS server IPv4 address if DHCP is not used to get the DNS address. Table 85. Parameters for idrac.config_mgr.configure_static_ipv4 Parameter Name Type Allowed Values dns_from_dhcp Enum Description Indicates whether DHCP is used to obtain primary and secondary DNS server addresses from the DHCPv4 server.
Description: The idrac.config_mgr.configure_timezone() allows you to configure the time zone Settings. Table 88. Parameters for idrac.config_mgr.configure_timezone Parameter Name Type Allowed Values timezone String Timezone Description Configures the time zone. Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=False, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.
Table 91. Parameters for idrac.config_mgr.configure_web_server Parameter Name Type Allowed Values https_port Number HTTPS Port number Description Enter the port number that iDRAC uses to listen for a secure browser connection. The default value is 443. The value must be 1–65535. Table 92. Parameters for idrac.config_mgr.
Parameter Name Type Allowed Values may require installing the Unlimited Strength Java ™ Cryptography Extension Policy Files to permit usage of iDRAC plugins such as vConsole with this higher level of encryption. NOTE: Using this level of encryption may have import or export implications. For more guidance, contact your legal department. Table 94. Parameters for idrac.config_mgr.configure_web_server Parameter Name Type Allowed Values tls_protocol Enum TLSProtocol_WebServerTypes.TLS 1.
Description: The idrac.config_mgr.configure_snmp() allows you to configure SNMP Settings. Table 95. Parameters for idrac.config_mgr.configure_snmp Parameter Name Type Allowed Values snmp_enable Enum AgentEnable_SNMPTypes.Disabled AgentEnable_SNMPTypes.Enabled Description Allows you to enable to disable the SNMP server. Table 96. Parameters for idrac.config_mgr.configure_snmp Parameter Name Type Allowed Values community_name String User provided input Description Enter the SNMP community name.
Table 100. Parameters for idrac.config_mgr.configure_snmp Parameter Name Type Allowed Values trap_format Enum Description Allows you to select one of the SNMP trap formats. TrapFormat_SNMPTypes.SNMPv1 TrapFormat_SNMPTypes.SNMPv2 TrapFormat_SNMPTypes.SNMPv3 Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=False, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.
# Enable Syslog msg = idrac.config_mgr.enable_syslog() idrac.config_mgr.disable_syslog API string/Method: idrac.config_mgr.disable_syslog. Protocol Support: WSMAN. Description: The idrac.config_mgr.disable_syslog() enables System Log configuration. Allows you to disable the System Log configuration. Return type: JSON Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=False, creds=UserCredentials(, )) lias
CSIOR idrac.config_mgr.enable_csior API string/Method: idrac.config_mgr.enable_csior. Protocol Support: WSMAN. Description: The idrac.config_mgr.enable_csior() method allows you to enable the CSIOR option in iDRAC which enables the collection of system inventory on reboot. CSIOR is an option in iDRAC which enables collecting of system inventory on reboot. It allows you the CSIOR to perform configuration. Return type: JSON idrac.config_mgr.disable_csior API string/Method: idrac.config_mgr.disable_csior.
Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.configure_snmp_trap_destination API string/Method: idrac.config_mgr.configure_snmp_trap_destination. Protocol Support: Redfish. Description: The idrac.config_mgr.configure_snmp_trap_destination() allows you to configure the SNMP Trap Destination Settings. Table 102. Parameters for idrac.config_mgr.
# Configure SNMP Trap Destination Settings idrac.config_mgr.configure_snmp_trap_destination ( destination_number = 1, destination = "1.1.1.1", snmp_v3_username = None, state = State_SNMPAlertTypes.Disabled ) apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: None. Return Type: None. idrac.config_mgr.configure_smtp_server_settings API string/Method: idrac.config_mgr.configure_smtp_server_settings. Protocol Support: Redfish. Description: The idrac.config_mgr.
Table 109. Parameters for idrac.config_mgr.configure_smtp_server_settings Parameter Name Type Allowed Values username String User defined string Description To connect to the SMTP server, enter the user name. Table 110. Parameters for idrac.config_mgr.configure_smtp_server_settings Parameter Name Type Allowed Values password String User defined string Description To connect for NFS or CIFS file system, enter the password. The maximum length is 255 characters.
Table 112. Parameters for idrac.config_mgr.configure_email_alerts Parameter Name Type Allowed Values state Enum Description Configure to receive the alerts, select this option. Enable_EmailAlertTypes.Enabled Enable_EmailAlertTypes.Disabled Table 113. Parameters for idrac.config_mgr.configure_email_alerts Parameter Name Type Allowed Values address String Destination email Address Description Enter the email address that must receive the alerts. Table 114. Parameters for idrac.config_mgr.
Table 115. Parameters for idrac.config_mgr.configure_boot_mode Parameter Name Type Allowed Values boot_mode Enum Description Configures the boot mode to BIOS or UEFI. Bios - BootModeTypes.BIOS Uefi - BootModeTypes.Uefi Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=False, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.
liason_share_status = idrac.config_mgr.set_liason_share(myshare) idrac.config_mgr.configure_onetime_boot_mode ( OneTimeBootModeTypes.Disabled ) apply_status = idrac.config_mgr.apply_changes(reboot=True) Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.configure_boot_sequence API string/Method: idrac.config_mgr.configure_boot_sequence. Protocol Support: Redfish. Description: The idrac.config_mgr.configure_boot_sequence() allows you to configure the boot sequence. Table 117.
Protocol Support: Redfish. Description: The idrac.config_mgr.configure_nvme_mode() allows you to configure the NVME Mode. Table 119. Parameters for idrac.config_mgr.configure_nvme_mode Parameter Name Type Allowed Values nvme_mode Enum Description Configure the NVME mode. This feature is available in the BIOS settings page. NvmeModeTypes.NonRaid NvmeModeTypes.Raid Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=Fals
idrac.config_mgr.configure_secure_boot_mode ( SecureBootModeTypes.UserMode ) apply_status = idrac.config_mgr.apply_changes(reboot=True) Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.configure_boot_to_network_iso API string/Method: idrac.config_mgr.configure_boot_to_network_iso. Protocol Support: WSMAN. Description: The idrac.config_mgr.configure_boot_to_network_iso() allows you to boot the provided ISO file for operating system deployment. Table 121. Parameters for idrac.config_mgr.
Table 123. Parameters for idrac.config_mgr.configure_update_from_repo Parameter Name Type Allowed Values catalog_path Enum User defined network catalog path. Description Allows you to select the path of the catalog. Table 124. Parameters for idrac.config_mgr.configure_update_from_repo Parameter Name Type Allowed Values apply_update Boolean True Description Allows you to apply the update to the firmware. Table 125. Parameters for idrac.config_mgr.
idrac.config_mgr.RaidHelper.new_virtual_disk API string/Method: idrac.config_mgr.RaidHelper.new_virtual_disk. Protocol Support: WSMAN, Redfish. Description: The idrac.config_mgr.RaidHelper.new_virtual_disk() allows you to create a RAID. Table 127. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values vd_name String User defined Description Name of the virtual disk. Table 128. Parameters for idrac.config_mgr.RaidHelper.
Table 132. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type RAIDinitOperation ENUM Description Initializes a RAID operation. Allowed Values RAIDinitOperationTypes.Fast RAIDinitOperationTypes.T_None Table 133. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values DiskCachePolicy ENUM Description Allows you to set the default disk cache policy. DiskCachePolicyTypes.Default DiskCachePolicyTypes.Enabled DiskCachePolicyTypes.
Table 137. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDresetConfig ENUM Description Allows you to reset the RAID configuration. RAIDresetConfigTypes.T_false RAIDresetConfigTypes.T_True Table 138. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDbgiRate String User defined RAID bgi rate. Description Allows you to set the speed of the background initialization of the virtual disks.
Table 143. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDccMode ENUM Description Allows you to configure the CC mode. RAIDccModeTypes.Normal RAIDccModeTypes.StopOnError Table 144. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values n_disks Number User defined Description Allows you to set the number of disks in the RAID array.
Protocol Support: WSMAN, Redfish. Description: The idrac.config_mgr.RaidHelper.delete_virtual_disk() allows you to create a RAID. Table 145. Parameters for idrac.config_mgr.RaidHelper.delete_virtual_disk Parameter Name Type Allowed Values Name String User defined Description Name of the virtual disk. Example: #Set liason share myshare = FileOnShare(remote="://", mount_point='Z:\', isFolder=False, creds=UserCredentials(, )) liason_share_s
Example: # Delete a job job_status = idrac.job_mgr.delete_job(jobid=”jid_1234”) idrac.job_mgr.delete_all_jobs API string/Method: idrac.job_mgr.delete_all_jobs. Protocol Support: WSMAN. Description: The delete_all_jobs() is used to delete all jobs. Return type: String Example: # Delete all jobs job_status = idrac.job_mgr.delete_all_jobs() iDRAC LC Status Check API list This section lists the available iDRAC LC Status Check APIs. idrac.config_mgr.LCStatus API string/Method: idrac.config_mgr.LCStatus.
4 Getting Started The following sections provide information about using OMPSDK to connect, disconnect and communicate with the device.
Table 147. Monitoring API methods Method Description get_driver This function creates and returns the driver instance based on the input details including driver name and on successful connection. User can specify a particular Driver type [e.g iDRAC, CMC, F10] and get the driver instance back without looping through all the drivers present inside omdrivers folder. Parameters: driver_en Device driver enumerator. For example: iDRAC : sd.driver_enum.iDRAC, CMC, Compellent.
Table 149. Base Driver Properties Method Description driver_enum Returns an python enumeration of the available drivers in the system. ComponentEnum Returns the list of components supported for the device. ContainmentTree Returns the containment tree of iDRAC. device_type Returns the type of this device. API to setup share The following section provides information about the network share.
Enables you to remotely perform power control operations on the managed system like: power-on, power-off and power reset. idrac.config_mgr.power_boot(Power_state): Allows you to power On/Off the Server. iDRAC Reset configuration disconnect(): Disconnects from device. reset(): Disconnects and clean up the internal cache. reconnect(): Disconnects and reconnects to device.
Exporting LC Logs 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.
iDRAC Time Zone configuration idrac.config_mgr.configure_timezone(): Allows you to configure the time zone settings. iDRAC Service Configuration The following API's provide information of various service configurations available. • • • SNMP Agent Configuration Alert Configuration WebServer Configuration SNMP Agent Configuration idrac.config_mgr_snmp(): Allows you to configure the SNMP Settings. Alert Configuration idrac.config_mgr.
idrac.config_mgr.configure_snmp_trap_destination(): Allows you to configure the SNMP trap destination settings. SMTP (E-Mail) Configuration idrac.config_mgr.configure_email_alerts(): Allows you to configure to receive the alerts. BIOS Boot settings The following section provides the information about the system BIOS Boot settings. BIOS Boot settings Using the System BIOS Settings utility, you can set the managed system to boot.
idrac.job_mgr.delete_job(): Allows you to delete the job. Delete all jobs idrac.job_mgr.delete_all_jobs(): Allows you to delete all jobs. View job status idrac.job_mgr.get_job_status(): Allows you to get the job status for the provided job ID. iDRAC LC status check The following API provides the information to check the LC status. idrac.config_mgr.LCStatus(): Provides the Status of LifeCycle Controller.
