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 ProtoPreference(ProtocolEnum.SNMP) ProtoPreference(ProtocolEnum.WSMAN) ProtoPreference(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.
Parameter Name Type Allowed Values SNMPOptions WsManOptions RedfishOptions Example: idrac=sd.get_driver(sd.driver_enum.iDRAC, ipaddr, creds=UserCredentials("root", "calvin"), protopref=ProtoPreference(ProtocolEnum.REDFISH), pOptions=RedfishOptions(port=443)) Return type: ObjectDevice driver: A driver handle to configure or monitor the drivers. sdkbase.iBaseDriver.get_entityjson API string/Method: sdkbase.iBaseDriver.get_entityjson. Description: The sdkbase.iBaseDriver.
Parameter Name Type Allowed Values iDRACCompEnum.EnclosureFanSe nsor iDRACCompEnum.EnclosureTempS ensor iDRACCompEnum.Fan iDRACCompEnum.FC iDRACCompEnum.HostNIC iDRACCompEnum.iDRAC iDRACCompEnum.iDRACNIC iDRACCompEnum.License iDRACCompEnum.LogicalSystem iDRACCompEnum.NIC iDRACCompEnum.PCIDevice iDRACCompEnum.PowerSupply iDRACCompEnum.PresenceAndSta tusSensor iDRACCompEnum.PhysicalDisk iDRACCompEnum.Sensors_Amper age iDRACCompEnum.Sensors_Battery iDRACCompEnum.Sensors_Fan iDRACCompEnum.
Return Type: JSON. sdkdevice.iDeviceDriver.get_json_device API string/Method: sdkdevice.iDeviceDriver.get_json_device. Description: The sdkdevice.iDeviceDriver.get_json_device() is used to apply the monitor filter on the raw entityJSON and also filter the category of the attributes and components required for the client. Table 11. Parameters for sdkdevice.iDeviceDriver.get_json_device Parameter Name Type Allowed Values monitorfilter MonitorScope MonitorScope.BasicInventory MonitorScope.
Parameter Name Type Allowed Values iDRACCompEnum.PhysicalDisk iDRACCompEnum.Sensors_Amperage iDRACCompEnum.Sensors_Battery iDRACCompEnum.Sensors_Fan iDRACCompEnum.Sensors_Intrusion iDRACCompEnum.Sensors_Temperature iDRACCompEnum.Sensors_Voltage iDRACCompEnum.SystemMetrics iDRACCompEnum.VFlash iDRACCompEnum.Video iDRACCompEnum.VirtualDisk Description The required components. Return type: Table 13.
sdkcreds.UserCredentials API string/Method: sdkcreds.UserCredentials . Description: Credentials username and password for WSMAN communication with the device. Table 16. Parameters for sdkcreds.UserCredentials Parameter Name Type username String Description User name for WSMAN communication. Table 17. Parameter for password Parameter Name Type Allowed Values password String NA Description Password for WSMAN communication. Example: idrac=sd.
Table 20. Parameter for connection time-out Parameter Name Type Allowed Values connection_timeout Integer NA Description Time in seconds to wait for the server to connect before giving up. Table 21. Parameter for read time-out Parameter Name Type Allowed Values read_timeout Integer NA Description Time in seconds to wait for the server to read data before giving up. Table 22.
Table 26. Parameter for connection time-out Parameter Name Type Allowed Values connection_timeout Integer NA Description Time in seconds to wait for the server to connect before giving up. Table 27. Parameter for read time-out Parameter Name Type Allowed Values read_timeout Integer NA Description Time in seconds to wait for the server to read data before giving up. Table 28.
Parameter Name Type Allowed Values MonitorScope.OtherHealth MonitorScope.OtherInventory Description Defines the category of the filter. The default value of MonitorScope attributes is set to Not Available except for MonitorScope.Health and MonitorScope.Metrics. Example: device.get_entityjson() monitorfilter = MonitorScopeFilter(MonitorScope.Metrics) monitorfilter.setdefaultMap(MonitorScope.Metrics, "NOT AVAL") idrac.get_json_device(monitorfilter) Table 31.
idrac.config_mgr.reset_idrac API string/Method: idrac.config_mgr.reset_idrac. Protocol Support: Redfish. Description: This method is used to reset the iDRAC. Parameters: 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. Graceful - Reset is performed after the device is properly restarted. Force - Reset is performed without a proper shutdown of the device. ResetForceEnum.
Table 35. Parameters for idrac.config_mgr.reset_to_factory Parameter Name Type Allowed Values preserver_config ResetToFactoryPreserveEnum ResetToFactoryPreserveEnum.ResetExceptNIC AndUsers ResetToFactoryPreserveEnum.ResetAll ResetToFactoryPreserveEnum.ResetAllExcept DefaultUser Description Allows you to preserve the configuration 0 - ResetToFactoryPreserveEnum.ResetExceptNICAndUsers Allows you to reset the device without resetting the NIC and User settings. 1 - ResetToFactoryPreserveEnum.
Table 37. Parameters for idrac.config_mgr.scp_export Parameter Name Type export_use Enum Allowed Values ExportUseEnum.Default ExportUseEnum.Clone ExportUseEnum.Replace The output file formats for export_use are: Description ExportUseEnum.Default- By default, none of the options are selected. ExportUseEnum.Clone - This option is used with Redfish protocol to generate an SCP that is ready for cloning. ExportUseEnum.
Parameter Name Type IPAddress - Name of the NFS share server. Sharename - Name of the shared file. Mountpoint - To mount the shared file. UserCredentials - Username and password for accessing the shared file. CIFS - Common Internet File System IPAddress - Name of the CIFS share server. Sharename - Name of the shared file. Sharepath - The share path where file needs to be exported. UserCredentials - Username and password for accessing the shared file. Table 41. Parameters for idrac.config_mgr.
myshare= FileOnShare(remote = ':/Share/file.xml', mount_point = '/mnt/Share', isFolder = True, creds==UserCredentials('username', 'password')) idrac.config_mgr.set_liason_share(myshare) status=idrac.config_mgr.scp_import(end_host_power_state=EndHostPowerStateEnum.On, job_wait=True, share_path=localpath, target = SCPTargetEnum.ALL) Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.scp_import Prerequisites: API string/Method: idrac.config_mgr.
Parameter Name Type IPAddress - Name of the NFS share server. Sharename - The NFS share name. Mountpoint - To mount the shared file. UserCredentials - Username and password for accessing the shared file. CIFS - Common Internet File System IPAddress - Name of the CIFS share server. Sharename - The CIFS share name. Sharepath - The share path where file needs to be imported. UserCredentials - Username and password for accessing the shared file. Table 46. Parameters for idrac.config_mgr.
share_path=localpath, target = SCPTargetEnum.ALL) status=idrac.config_mgr.reset_idrac(force=ResetForceEnum.Force) Returns: Success or Failure. Return Type: JSON. idrac.log_mgr.lclog_export API string/Method: idrac.log_mgr.lclog_export Protocol Support: WSMAN. Description: The ExportLCLog() method is used to export the log from the Lifecycle Controller to a remote share. Parameters: Table 47. Parameters for idrac.log_mgr.
nfs_share = FileOnShare(remote=:/, mount_point=:\>, isFolder=, creds=UserCredentials(, )) lclog_file = nfs_share.new_file() msg = idrac.log_mgr.lclog_export(lclog_file) # Export LC Logs - CIFS Share cifs_share = FileOnShare(remote=\\\, isFolder=, creds=UserCredentials(, )) lclog_file = cifs_share.new_file() msg = idrac.log_mgr.
Parameter Name Type CIFS - Common Internet File System IPAddress - Name of the CIFS share server Sharename - The CIFS share name. Sharepath - The share path where file needs to be exported. UserCredentials - Username and password for accessing the shared file. Example: # Export LC Full Logs - NFS Share nfs_share = FileOnShare(remote=:/, mount_point=:\>, isFolder=, creds=UserCredentials(, )) tsr_file = nfs_share.
Parameter Name Type Allowed Values DataSelectorArrayInEnum.TTY_Logs - Technical support report for TTY Logs. DataSelectorArrayInEnum.Debug_Logs - Technical support report for OSApp Data. Table 52. Parameters for idrac.config_mgr.export_tsr 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 53. Parameters for idrac.config_mgr.
iDRAC User Configuration idrac.user_mgr.Users.new idrac.user_mgr.Users.new API string/Method: idrac.user_mgr.Users.new Protocol Support: Redfish. Description: The idrac.user_mgr.Users.new() returns a JSON to create the user. For more details about the properties and values, refer to iDRAC Attribute Registry Guide. Table 54. 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 55.
Table 58. Parameters for idrac.user_mgr.Users.new Parameter Name Type Allowed Values IpmiSerialPrivilege_Use rs ENUM IpmiSerialPrivilege_UsersTypes.Administra tor IpmiSerialPrivilege_UsersTypes.No_Access IpmiSerialPrivilege_UsersTypes.Operator IpmiSerialPrivilege_UsersTypes.User Description Allows you to set IPMI serial privilege for users. Table 59. Parameters for idrac.user_mgr.Users.new Parameter Name Type Enable_Users ENUM Description Allows you to enable or disable a user.
Table 63. Parameters for idrac.user_mgr.Users.new Parameter Name Type Allowed Values PrivacyProtocol_Users ENUM Description Allows you to set the privacy protocol for a user. PrivacyProtocol_UsersTypes.AES PrivacyProtocol_UsersTypes.DES PrivacyProtocol_UsersTypes.T_None Example: #Set liason share myshare = FileOnShare(remote=":/", mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.
creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.set_liason_share(myshare) idrac.user_mgr.Users.remove(UserName_Users="XYZ123") apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: JSON Returns a json indicating whether the user was deleted successfully or not. Return Type: JSON. iDRAC Network Settings Configuration idrac.config_mgr.configure_dns API string/Method: idrac.config_mgr.configure_dns Protocol Support: WSMAN, Redfish. Description: The idrac.
mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.set_liason_share(myshare) #Configure iDRAC DNS COnfiguration msg = idrac.config_mgr.configure_dns(register_idrac_on_dns = DNSRegister_NICTypes.Enabled, dns_idrac_name = None, auto_config = DNSDomainNameFromDHCP_NICTypes.Disabled, static_dns = None) apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.
Table 73. Parameters for idrac.config_mgr.configure_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 DNSFromDHCP_IPv4Types.Enabled DNSFromDHCP_IPv4Types.Disabled Table 74. Parameters for idrac.config_mgr.configure_ipv4 Parameter Name Type Allowed Values enable_ipv4 Enum Description Indicates whether the IPv4 protocol is Enabled or Disabled. Enable_IPv4Types.Enabled Enable_IPv4Types.
Description: The idrac.config_mgr.configure_static_ipv4() allows you to configure the Static IPv4 Settings. Table 77. Parameters for idrac.config_mgr.configure_static_ipv4 Parameter Name Type Allowed Values ip_address String IP Address Description Displays the iDRAC NIC IPv4 address. Table 78. Parameters for idrac.config_mgr.
mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.set_liason_share(myshare) #Perform iDRAC Static IPv4 configuration idrac.config_mgr.configure_static_ipv4 ( ip_address = "1.1.1.1", dns_1 = None, dns_2 = None, dns_from_dhcp = DNSFromDHCP_IPv4StaticTypes.Enabled, gateway=None, net_mask=None) apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success of Failure. Return Type: JSON. idrac.config_mgr.
Table 84. Parameters for idrac.config_mgr.configure_web_server Parameter Name Type Allowed Values enable_web_server Enum Description Select Enabled to enable the iDRAC web server. This setting is enabled by default. Enable_WebServerTypes.Enabled Enable_WebServerTypes.Disabled NOTE: Disabling the web server disables the current web interface session and you cannot log in to iDRAC web interface or use remote RACADM. Table 85. Parameters for idrac.config_mgr.
Parameter Name Type Allowed Values SSLEncryptionBitLength_WebServerTypes.T_2 56_Bit_or_higher Description To specify the level of SSL encryption for providing authenticated and encrypted communication between clients and servers, select one of the following options: Auto Negotiate—Enables auto-negotiation of the SSL encryption between client and the server by using all industry standard encryption algorithms. NOTE: This option includes weaker SSL encryption algorithm, which reduces the security.
creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.set_liason_share(myshare) #Configure iDRAC WebServer idrac.config_mgr.configure_web_server ( enable_web_server = Enable_WebServerTypes.Enabled, http_port = 80, https_port = 443, timeout = 1800, ssl_encryption = SSLEncryptionBitLength_WebServerTypes.T.T_128_Bit_or_higher, tls_protocol = TLSProtocol_WebServerTypes.TLS_1_1_and_Higher ) apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success or Failure.
Table 93. Parameters for idrac.config_mgr.configure_snmp Parameter Name Type Allowed Values discovery_port Number Discovery port number Description Allows the server to discover the available port. Table 94. Parameters for idrac.config_mgr.configure_snmp Parameter Name Type Allowed Values snmp_protocol Enum Description Allows you to select one of the SNMP formats. SNMPProtocol_SNMPTypes.All SNMPProtocol_SNMPTypes.SNMPv3 Table 95. Parameters for idrac.config_mgr.
Syslog idrac.config_mgr.enable_syslog API string/Method: idrac.config_mgr.enable_syslog Protocol Support: WSMAN. Description: The idrac.config_mgr.enable_syslog() enables System Log configuration. Allows you to enable the System Log configuration. Example: #Set liason share myshare = FileOnShare(remote=":/", mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.
Description: The idrac.config_mgr.enable_system_lockdown() method allows you to enable the Lockdown operation. NOTE: Lockdown is supported only on 14th Generation of PowerEdge Servers Example: #Set liason share myshare = FileOnShare(remote=":/", mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.set_liason_share(myshare) status=idrac.config_mgr.enable_csior() apply_status = idrac.config_mgr.
Example: NOTE: Use the Export LC Logs as required along with the FileOnShare API. # Export LC Logs - NFS Share nfs_share = FileOnShare(remote=:/, mount_point=:\>, isFolder=, creds=UserCredentials(, )) lclog_file = nfs_share.new_file() msg = idrac.log_mgr.lclog_export(lclog_file) # Export LC Logs - CIFS Share cifs_share = FileOnShare(remote=\\\, isFolder=, creds=UserCredentials
Protocol Support: Redfish. Description: The idrac.config_mgr.configure_idrac_alerts() allows you to enable or disable the iDRAC alerts Settings. Table 96. Parameters for idrac.config_mgr.configure_idrac_alerts Parameter Name Type enable_alerts Enum Description Configure the iDRAC alert settings. Allowed Values AlertEnable_IPMILanTypes.Enabled AlertEnable_IPMILanTypes.Disabled Example: #Set liason share myshare = FileOnShare(remote=":/", mount_point='Z:\', isFolder=True
Parameter Name Type Allowed Values NOTE: The destination community must be the same as the iDRAC community. Table 99. Parameters for idrac.config_mgr.configure_snmp_trap_destination Parameter Name Type Allowed Values snmp_v3_username String User defined string Description From the drop-down list, select the SNMP v3 user to whom you want to send the SNMP v3 format traps. Table 100. Parameters for idrac.config_mgr.
Table 101. Parameters for idrac.config_mgr.configure_smtp_server_settings Parameter Name Type Allowed Values smtp_ip_address String SMTP IP Address Description Enter the IPv4 or IPv6 address of the SMTP server or the FQDN / DNS name. The IP address entered must be in the dot separated format. For example, 143.166.154.1. Table 102. Parameters for idrac.config_mgr.
) apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.configure_email_alerts API string/Method: idrac.config_mgr.configure_email_alerts Protocol Support: Redfish. Description: The idrac.config_mgr.configure_email_alerts() allows you to configure email alerts Settings. Table 106. Parameters for idrac.config_mgr.
address = "test@abc.com", custom_message = "test" ) apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success or Failure. Return Type: JSON. Boot Settings Configuration API list This section lists the available Boot settings configuration APIs. idrac.config_mgr.configure_boot_mode API string/Method: idrac.config_mgr.configure_boot_mode Protocol Support: Redfish. Description: The idrac.config_mgr.configure_boot_mode() allows you to configure the boot Mode. Table 110.
Table 111. Parameters for idrac.config_mgr.configure_onetime_boot_mode Parameter Name Type Allowed Values onetime_boot_mode Enum Description Allows you to enable or disable the one time boot mode. OneTimeBootModeTypes.Disabled OneTimeBootModeTypes.OneTimeBootSeq OneTimeBootModeTypes.OneTimeCustomBootSeq Str OneTimeBootModeTypes.OneTimeCustomHddSeqS tr OneTimeBootModeTypes.OneTimeCustomUefiBoo tSeqStr OneTimeBootModeTypes.OneTimeHddSeq OneTimeBootModeTypes.
Table 113. Parameters for idrac.config_mgr.configure_boot_sequence Parameter Name Type Allowed Values boot_sequence String Boot devices FQDDs (Comma separated) in the sequential order for BIOS or UEFI Boot Sequence. Description User defined boot sequence. Example: #Set liason share myshare = FileOnShare(remote=":/", mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) liason_share_status = idrac.config_mgr.set_liason_share(myshare) idrac.
idrac.config_mgr.configure_secure_boot_mode API string/Method: idrac.config_mgr.configure_secure_boot_mode Protocol Support: Redfish. Description: The idrac.config_mgr.configure_secure_boot_mode() allows you to configure the Secure boot Mode. Table 115. Parameters for idrac.config_mgr.configure_secure_boot_mode Parameter Name Type Allowed Values secure_boot_mode Enum Description Configures how the BIOS uses the Secure boot Policy. SecureBootModeTypes.AuditMode SecureBootModeTypes.
mount_point='Z:\', isFolder=True, creds=UserCredentials(, )) msg = idrac.config_mgr.boot_to_network_iso(myshare, ' ' ) Returns: Success or Failure. Return Type: JSON. idrac.update_mgr.update_from_repo API string/Method: idrac.update_mgr.update_from_repo. Protocol Support: WSMAN. Description: The idrac.update_mgr.update_from_repo() allows you to update the server components firmware. Table 117. Parameters for idrac.update_mgr.
apply_update=True, reboot_needed=True, job_wait=True ) Returns: Success or Failure. Return Type: JSON. RAID Configuration API list This section lists the available RAID configuration APIs. 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 121. Parameters for idrac.config_mgr.RaidHelper.
Parameter Name Type Allowed Values RAIDTypesTypes.RAID_6 RAIDTypesTypes.RAID_60 Description Type of the RAID array. Table 125. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDaction ENUM RAIDactionTypes.Create Description RAID action to be performed. Table 126. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type RAIDinitOperation ENUM Description Initializes a RAID operation.
Parameter Name Type Allowed Values RAIDdefaultReadPolicyTypes.NoReadAhead RAIDdefaultReadPolicyTypes.ReadAhead Description Allows you to set the default RAID read policy. Table 130. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDEnhancedAutoImportFore ignConfig ENUM RAIDEnhancedAutoImportForeignConfigTypes. Enabled RAIDEnhancedAutoImportForeignConfigTypes. Disabled Description Allows you to configure the auto import setting. Table 131.
Table 135. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDforeignConfig ENUM Description Allows you to set the external configuration types. RAIDforeignConfigTypes.Clear RAIDforeignConfigTypes.Ignore RAIDforeignConfigTypes.Import Table 136. Parameters for idrac.config_mgr.RaidHelper.new_virtual_disk Parameter Name Type Allowed Values RAIDreconstructRate Number User defined RAID reconstruct rate.
) apply_status = idrac.config_mgr.apply_changes(reboot=True) Returns: Success or Failure. Return Type: JSON. idrac.config_mgr.RaidHelper.delete_virtual_disk API string/Method: idrac.config_mgr.RaidHelper.delete_virtual_disk Protocol Support: WSMAN, Redfish. Description: The idrac.config_mgr.RaidHelper.delete_virtual_disk() allows you to create a RAID. Table 138. Parameters for idrac.config_mgr.RaidHelper.
Returns: Success or Failure. Return Type: JSON. idrac.job_mgr.delete_job API string/Method: idrac.job_mgr.delete_job Protocol Support: WSMAN. Description: The delete_job(jobid) method is used to delete a job. Example: # Delete a job job_status = idrac.job_mgr.delete_job(jobid="JID_123456789012") Returns: Success or Failure. Return Type: JSON. idrac.job_mgr.delete_all_jobs API string/Method: idrac.job_mgr.delete_all_jobs Protocol Support: WSMAN.
Returns: In Use or Ready. Return Type: String. idrac.config_mgr.LCReady API string/Method: idrac.config_mgr.LCReady Protocol Support: WSMAN. Description: This property provides the information regarding whether the LC is Ready. Example: msg = idrac.config_mgr.LCReady Returns: True or False. Return Type: String.
4 Getting Started The following sections provide information about using OMPSDK to connect, disconnect and communicate with the device.
Table 140. 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 142. 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.
