Dell EMC OpenManage Python Software Development Kit

(1)

Dell EMC OpenManage Python Software Development Kit

Version 1.0

API Reference Guide

(2)

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. Other trademarks may be trademarks of their respective owners. Licensed under the Apache license version 2.0; you may not use this file except in compliance with the license. You may obtain a copy of the license at https://www.apache.org/licenses/LICENSE-2.0. Unless applicable law required or agreed to in writing, software distributed under the license is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the license for the specific language governing permissions and limitations under the license.

(3)

1 Introduction to OpenManage python software development toolkit... 5

SDK concepts and architectural components... 5

2 Installation and Uninstallation of OMPSDK... 6

Installing OMPSDK...6

Uninstalling OMPSDK...6

3 OpenManage Python SDK API introduction... 7

OpenManage Python SDK API list...7

Monitoring API list... 7

Administration tasks API list... 16

Export and Import Tasks API list...18

Server iDRAC Settings Configuration API list... 26

Boot Settings Configuration API list... 44

RAID Configuration API list... 49

iDRAC LC Jobs API list...54

iDRAC LC Status Check API list... 55

4 Getting Started... 56

OMPSDK Infrastructure...56

Initialization of OMPSDK Infrastructure...56

API to setup share... 58

Setting up a remote network share... 58

iDRAC server information... 58

Administration Tasks...58

Server configuration profile overview... 59

Import export server configuration profiles... 59

Export server configuration profile... 59

Import server configuration profile... 59

Exporting LC Logs... 60

Server iDRAC settings and configuration... 60

iDRAC User Configuration settings... 60

iDRAC Network Configuration... 60

iDRAC Service Configuration... 61

iDRAC System Settings... 61

BIOS Boot settings... 62

RAID Configuration... 62

Create Virtual Disk... 62

Delete Virtual Disk...62

(4)

iDRAC LC status check...63

(5)

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. The OMPSDK leverages the DMTF Redfish, DMTF's Web Services Management standard (WS-Man), and IETF's Simple Network Management Protocol (SNMP) standard for managing and monitoring the DellEMC PowerEdge servers and chassis.

SDK concepts and architectural components

An OMPSDK is a complete set of APIs that allow you to perform most of actions you would need for creating, monitoring and managing the servers or chassis applications. An SDK provides a set of APIs, relevant documentation, code samples, processes, that allows developers to create software applications on a specific platform. Components in OMPSDK are:

• OMPSDK Infrastructure

• Driver

• Credential management

• Protocol Management

– Protocol preference and options

• Log Manager

1

(6)

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).

Uninstalling OMPSDK

To uninstall OMPSDK, use the following command:

pip uninstall omsdk

2

(7)

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.

The traditional approach for creating a plug-in always starts from scratch, such as building communication module, business logic module, user interface module, and native console data translation module. In most of the plug-ins the native console data translation module varies, but all other modules remain more or less same. As a result, every plug-in maintains their own set of libraries which adds no uniformity in implementation across plug-ins. Indirectly it increases the overhead sustaining cost of the plug-ins.

OMPSDK is targeted to provide

• A uniform implementation of communication module and core business logic module

• Abstraction of multiple communication protocols with data messaging

• Macro services as per use case—Monitoring, configuration, and more

• Optionally automatic code generating capability

• Quick integration to other DevOps.

OpenManage Python SDK API list

This section describes the resource URIs and related operations that are available in the OpenManage Python SDK(OMPSDK) implementation.

Monitoring API list

sdkinfra.find_driver

API string/Method: sdkinfra.find_driver.

Description: The sdkinfra.find_driver() method is used to initialize and load the device drivers.

Table 1. Parameters for sdkinfra.find_driver

Parameter Name Type Allowed Values

ipaddr String NA

Description The IP address or hostname of the device.

3

(8)

Table 2. Parameters for the Credentials

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

protopref Enumeration of preferred protocol ProtocolEnum.WSMAN ProtocolEnum.SNMP ProtocolEnum.REDFISH Description The preferred protocol used if the device supports the protocol.

Table 4. Parameter for protocol specific options

pOptions Dictionary of protocol-specific

options SNMPOptions

WSMANOptions REDFISHOptions Description A protocol-specific option for passed, port, timeout and so on.

SNMPOptions WSMANOptions REFISHOptions

Return type:

ObjectDevice driver: A driver handle to configure or monitor the drivers.

Example:

find_driver(ipaddr, creds, protopref=None, pOptions=None)

sdkinfra.get_driver

API string/Method: sdkinfra.get_driver.

Description: The sdkinfra.get_driver() method is used to get a device driver for the given IP address or hostname, and check for a particular device type.

(9)

Table 5. Parameters for sdkinfra.get_driver

ipaddr String NA

Description The IP address or hostname of the device.

Table 6. Parameters for device type

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.NSeries Description The enumeration of the device type.

Table 7. Parameters for credentials

creds Dictionary of credentials Snmpv2Credentials

UserCredentials Description A bundle of credentials to find the device driver.

Snmpv2Credentials UserCredentials

Table 8. Parameters for preferred protocol

protopref Enumeration of preferred protocol NA

Description The preferred protocol used if the device supports the protocol.

Table 9. Parameters for protocol specific options

pOptions Dictionary of protocol-specific

options SNMPOptions

WSMANOptions REFISHOptions Description A protocol-specific option for passed, port, timeout and so on.

SNMPOptions

(10)

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. Return type

Returns Return type

True Boolean

Sdkbase.iBaseDriver.get_partial_entityjson

API string/Method: Sdkbase.iBaseDriver.get_partial_entityjson.

Description: The Sdkbase.iBaseDriver.get_partial_entityjson() is used to get the JOSN with the components which are passed as an argument for the function.

Table 11. Parameters for Sdkbase.iBaseDriver.get_partial_entityjson

en iDRACCompEnum

CMCCompEnum

iDRAC CMC

iDRACCompEnum.BIOS

iDRACCompEnum.ControllerBatter y

iDRACCompEnum.Controller iDRACCompEnum.CPU iDRACCompEnum.Enclosure iDRACCompEnum.EnclosureEMM iDRACCompEnum.EnclosurePSU iDRACCompEnum.EnclosureFanSe nsor

iDRACCompEnum.EnclosureTempS ensor

iDRACCompEnum.Fan iDRACCompEnum.FC iDRACCompEnum.HostNIC iDRACCompEnum.iDRAC iDRACCompEnum.iDRACNIC iDRACCompEnum.License

CMCCompEnum.BladeSlot CMCCompEnum.CMC

CMCCompEnum.ComputeModule CMCCompEnum.Controller CMCCompEnum.ControllerBattery CMCCompEnum.Enclosure CMCCompEnum.EnclosureEMM CMCCompEnum.EnclosurePSU CMCCompEnum.Fan

CMCCompEnum.IOModule CMCCompEnum.KVM CMCCompEnum.License CMCCompEnum.PowerSupply CMCCompEnum.PhysicalDisk CMCCompEnum.PCIDevice CMCCompEnum.StorageModule CMCCompEnum.Slots_Summary

(11)

iDRACCompEnum.LogicalSystem iDRACCompEnum.NIC

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.VirtualDisk

CMCCompEnum.System CMCCompEnum.VirtualDisk

Description List of strings or enumeration of the components.

Return type:

Table 12. Return Type

Returns Return type

JSON JSON Only the components passed in enumeration.

Sdkbase.iBaseDriver.ContainmentTree

API string/Method: Sdkbase.iBaseDriver.ContainmentTree.

Description: The Sdkbase.iBaseDriver.ContainmentTree() is used to create and return the component tree of the device with keys of the Components organized in a tree structure.

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.

(12)

Table 13. Parameters for Sdkdevice.iDeviceDriver.get_json_device

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 for Component

compScope String or Enum iDRAC CMC

iDRACCompEnum.BIOS

iDRACCompEnum.ControllerBattery iDRACCompEnum.Controller iDRACCompEnum.CPU iDRACCompEnum.Enclosure iDRACCompEnum.EnclosureEMM iDRACCompEnum.EnclosurePSU iDRACCompEnum.EnclosureFanSensor iDRACCompEnum.EnclosureTempSensor iDRACCompEnum.Fan

iDRACCompEnum.FC iDRACCompEnum.HostNIC iDRACCompEnum.iDRAC iDRACCompEnum.iDRACNIC iDRACCompEnum.License iDRACCompEnum.LogicalSystem iDRACCompEnum.NIC

iDRACCompEnum.PCIDevice iDRACCompEnum.PowerSupply

iDRACCompEnum.PresenceAndStatusSe nsor

iDRACCompEnum.PhysicalDisk iDRACCompEnum.Sensors_Amperage iDRACCompEnum.Sensors_Battery iDRACCompEnum.Sensors_Fan iDRACCompEnum.Sensors_Intrusion iDRACCompEnum.Sensors_Temperature iDRACCompEnum.Sensors_Voltage iDRACCompEnum.SystemMetrics iDRACCompEnum.VFlash

CMCCompEnum.BladeSlot CMCCompEnum.CMC

CMCCompEnum.ComputeModule CMCCompEnum.Controller CMCCompEnum.ControllerBattery CMCCompEnum.Enclosure CMCCompEnum.EnclosureEMM CMCCompEnum.EnclosurePSU CMCCompEnum.Fan

CMCCompEnum.IOModule CMCCompEnum.KVM CMCCompEnum.License CMCCompEnum.PowerSupply CMCCompEnum.PhysicalDisk CMCCompEnum.PCIDevice CMCCompEnum.StorageModule CMCCompEnum.Slots_Summary CMCCompEnum.System CMCCompEnum.VirtualDisk

(13)

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.

Description: Credentials for SNMP version 1 and version 2.

Table 16. Parameters for Sdkcreds.Snmpv2Credentials

Parameter Name Type

community String

Description Community string for the SNMP device.

Table 17. Parameter for write community

writeCommunity String NA

Description Write community string for the SNMP device.

Sdkcreds.UserCredentials

API string/Method: Sdkcreds.UserCredentials .

Description: Credentials username and password for WSMAN communication with the device.

Table 18. Parameters for Sdkcreds.UserCredentials

Parameter Name Type

username String

Description User name for WSMAN communication.

(14)

Table 19. Parameter for password

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

authentication AuthenticationType NA

Description HTTP authentication type Basic, Digest.

Table 21. Parameter for port

port Integer NA

Description HTTPS port number for WSMAN communication.

Table 22. Parameter for connection time-out

connection_timeout Integer NA

Description Time in seconds to wait for the server to connect before giving up.

Table 23. Parameter for read time-out

read_timeout Integer NA

Description Time in seconds to wait for the server to read data before giving up.

Table 24. Parameter for max retries

max_retries Integer NA

Description HTTP connection retries in case of failures.

(15)

Table 25. Parameter for verifying SSL certificate

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. Parameter for port

port Integer NA

Description HTTPS port number for WSMAN communication.

Table 28. Parameter for connection time-out

connection_timeout Integer NA

Description Time in seconds to wait for the server to connect before giving up.

Table 29. Parameter for read time-out

read_timeout Integer NA

Description Time in seconds to wait for the server to read data before giving up.

Table 30. Parameter for max retries

max_retries Integer NA

Description HTTP connection retries in case of failures.

(16)

Table 31. Parameter for verify ssl

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.Enabled)

power_boot(power_state) Enum PowerBootEnum Enabled Disabled Reset Description Allows you to power On/Off the Server.

1 - Reset 2 - Enabled 3 - Disabled

Returns: None.

Return Type: None.

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:

(17)

Table 33. Parameters for idrac.config_mgr.reset_idrac

Force ResetForceEnum ResetForceEnum.Graceful

ResetForceEnum.Force 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.

idrac.config_mgr.reset_to_factory

API string/Method: idrac.config_mgr.reset_to_factory.

Protocol Support: WSMAN, Redfish.

Description: This method is used to reset the iDRAC to factory default.

Parameters:

Table 34. Parameters for idrac.config_mgr.reset_to_factory

Force ResetForceEnum ResetForceEnum.Graceful

ResetForceEnum.Force Description Description: This method is used to reset the iDRAC.

ResetForceEnum.Graceful - Reset is performed after the device is properly restarted.

ResetForceEnum.Force - Reset is performed without a proper shutdown of the device.

Table 35. Parameters for idrac.config_mgr.reset_to_factory

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.ResetAll

Allows you to reset the device along with the NIC and the User settings.

2 - ResetToFactoryPreserveEnum.ResetAllExceptDefaultUser Allows you to reset without resetting the default user.

(18)

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.

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

export_format ExportFormatEnum ExportFormatEnum.XML

ExportFormatEnum.JSON

Description

Allows you to export the configuration detail as XML or JSON file.

0 - ExportFormatEnum.XML 1 - ExportFormatEnum.JSON Default - XML

export_use ExportUseEnum ExportUseEnum.Default

ExportUseEnum.Clone ExportUseEnum.Replace

Description

The output file formats for export_use are:

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.Replace - This option is used to retire a server from the data center and replace it with another.

include_in_export IncludeInExportEnum IncludeInExportEnum.Default

IncludeInExportEnum.Include_Read_Only IncludeInExportEnum.Include_Password_Hash

(19)

Parameter Name Type Allowed Values _Values

IncludeInExportEnum.Include_Both

Description

This API allows you to include more while exporting the file. The additional information added with include_in_export are:

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

job_wait Boolean True/False

Description True - Wait for the performed export Server Configuration Profile jobs to complete.

False - Returns only the JobID.

Table 40. Parameters for idrac.config_mgr.scp_export Parameter Name Type

share_path FileOnShare (for CIFS & NFS Share) LocalFile (For Local Share)

Description

SCP exports can be directed to local file systems and network shares.

NFS - Network File System

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.

Target SCPTargetEnum SCPTargetEnum.ALL

SCPTargetEnum.IDRAC SCPTargetEnum.BIOS

(20)

SCPTargetEnum.NIC SCPTargetEnum.RAID

Description

To identify the component for export. It identifies one or more FQDDs. Selective list of FQDDs should be given in comma-separated format.

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.RAID - The module exports RAID configuration in SCP file.

This module will import the configuration component from the exported SCP

Default - SCPTargetEnum.ALL - This module exports the complete system configuration from the Lifecycle Controller to a file on local or remote share location.

time_to_wait unit16

Description The time to wait for the host to shut down. Default and minimum value is 300 seconds. Maximum value is 3600 seconds.

Workgroup String

Description The applicable workgroup.

Returns: Success or Failure Return type: JSON

idrac.config_mgr.scp_import

API string/Method: idrac.config_mgr.scp_import.

Description: This method is used to import the system configuration.

Parameters:

(21)

Table 44. Parameters for idrac.config_mgr.scp_import

end_host_power_state EndHostPowerStateEnum EndHostPowerStateEnum.Off EndHostPowerStateEnum.On Description The desired host power state after the import operation is complete.

0 - Off 1 - On

Default value is 0

Description This API raises a flag to wait for the job to complete. A false value will return the Job ID.

Parameter Name Type

share_path FileOnShare (for CIFS & NFS Share) LocalFile (For Local Share)

Description SCP exports can be directed to local file systems and network shares.

NFS - Network File System

Sharename - The NFS share name.

Sharename - The CIFS share name.

Sharepath - The share path where file needs to be imported.

Target SCPTargetEnum SCPTargetEnum.ALL

SCPTargetEnum.IDRAC SCPTargetEnum.BIOS

(22)

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.RAID - The module imports RAID configuration in SCP file.

This module will import the configuration component from the imported SCP

Default - SCPTargetEnum.ALL - This module imports the complete system configuration from the Lifecycle Controller to a file on local or remote share location.

Parameter Name Type

time_to_wait unit16

Description The time to wait for the host to shut down. Default and minimum value is 300 seconds.

Maximum value is 3600 seconds.

Parameter Name Type

Workgroup String

Return type:

Parameter Name Return Type

(job-wait=True)]

(job-wait = False)

XML or JSON file

Description

Exports the server configuration profile to the provided network share or to the local path.

JobID - It is in the format JID_XXXXXXXXXXXX.

Job Status - It allows the user to check the status of job completion.

idrac.log_mgr.lclog_export

API string/Method: idrac.log_mgr.lclog_export.

Description: The ExportLCLog() method is used to export the log from the Lifecycle Controller to a remote share.

(23)

Parameters:

Table 51. Parameters for idrac.log_mgr.lclog_export

Parameter Name Type

share_path FileOnShare (for CIFS & NFS Share)

LocalFile (For Local Share)

Description LC log exports can be directed to local file systems and network shares NFS - Network File System

UserCredentials - Username and password for accessing the shared filed.

Sharename - The CIFS share name.

Parameter Name Type

work_group String

Example:

# Export LC Logs - NFS Share

nfs_share = FileOnShare(remote=<IP OR HOSTNAME>:/<NFS-SHARE-PATH>, mount_point=<MOUNT-DRIVE>:\>, isFolder=<True/False>, creds=UserCredentials(<USERNAME>, <PASSWORD>)) lclog_file = nfs_share.new_file(<FILE-NAME>)

msg = idrac.log_mgr.lclog_export(lclog_file)

# Export LC Logs - CIFS Share

cifs_share = FileOnShare(remote=\\<IP OR HOSTNAME>\<CIFS-SHARE-PATH>, isFolder=<True/False>, creds=UserCredentials(<USERNAME>, <PASSWORD>))

lclog_file = cifs_share.new_file(<FILE-NAME>) msg = idrac.log_mgr.lclog_export(lclog_file)

(24)

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.

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.complete_lclog_export

Description True - It will wait for the export the full LC logs job to complete and return the job completion status.

False - It will return immediately with a JOB ID after queuing the export LC logs job in LC job

Table 55. Parameters for idrac.log_mgr.complete_lclog_export

Parameter Name Type

share_path FileOnShare (for CIFS & NFS Share)

LocalFile (For Local Share)

Description LC log exports can be directed to local file systems and network shares NFS - Network File System

CIFS - Common Internet File System IPAddress - Name of the CIFS share server Sharename - The CIFS share name.

Example:

# Export LC Full Logs - NFS Share

nfs_share = FileOnShare(remote=<IP OR HOSTNAME>:/<NFS-SHARE-PATH>, mount_point=<MOUNT-DRIVE>:\>, isFolder=<True/False>, creds=UserCredentials(<USERNAME>, <PASSWORD>)) tsr_file = nfs_share.new_file(<FILE-NAME>)

(25)

idrac.log_mgr.complete_lclog_export(tsr_file)

# Export LC Full Logs - CIFS Share

tsr_file = cifs_share.new_file(<FILE-NAME>) idrac.log_mgr.complete_lclog_export(tsr_file)

# Export LC Full Logs - Local Share

local_share = LocalFile(local=os.path.join(, "path", "to", <FILE_NAME>)) idrac.log_mgr.complete_lclog_export(local_share)

Returns: Success or Failure.

Return type: JSON

idrac.config_mgr.export_tsr

API string/Method: idrac.config_mgr.export_tsr.

Description: The idrac.config_mgr.export_tsr is used to collects the TSR i.e hardware, OS and App data, then compressed the .zip file saves into the respective remote share path—cifs/nfs.

Parameters:

Table 56. Parameters for idrac.config_mgr.export_tsr

data_selector_arra

y_in DataSelectorArrayInEnum DataSelectorArrayInEnum.HW_Data

DataSelectorArrayInEnum.OSApp_Data DataSelectorArrayInEnum.TTY_Logs DataSelectorArrayInEnum.Debug_Logs Description The DataSelectorArrayIn allows you to select the one of the data

DataSelectorArrayInEnum.HW_Data - Technical support report for Hardware Data.

DataSelectorArrayInEnum.OSApp_Data - Technical support report for OSApp Data Without PII.

DataSelectorArrayInEnum.TTY_Logs - Technical support report for TTY Logs.

DataSelectorArrayInEnum.Debug_Logs - Technical support report for OSApp Data.

(26)

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=<IP OR HOSTNAME>:/<NFS-SHARE-PATH>, mount_point=<MOUNT-DRIVE>:\>, isFolder=<True/False>, creds=UserCredentials(<USERNAME>, <PASSWORD>)) tsr_file = nfs_share.new_file(<FILE-NAME>)

idrac.config_mgr.export_tsr(tsr_file, data_selector_array_in = DataSelectorArrayInEnum.HW_Data)

# Export TSR - CIFS Share

tsr_file = cifs_share.new_file(<FILE-NAME>)

idrac.config_mgr.export_tsr(tsr_file, data_selector_array_in = DataSelectorArrayInEnum.HW_Data) Returns: Success or Failure.

Return type: JSON

Server iDRAC Settings Configuration API list

This section lists the available Server iDRAC Settings Configuration APIs.

iDRAC User Configuration

idrac.user_mgr.Users.new idrac.user_mgr.Users.new

API string/Method: idrac.user_mgr.Users.new.

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.

(27)

Table 59. Parameters for idrac.user_mgr.Users.new

UserName_Users String User defined string

Description Allows you to create a user name.

Password_Users String User defined string

Description Allows you to create a password.

Privilege_Users ENUM Privilege_UsersTypes.Administrator

Privilege_UsersTypes.NoAccess Privilege_UsersTypes.Readonly Privilege_UsersTypes.Operator Description Allows you to create a privileged user,

IpmiLanPrivilege_Users ENUM IpmiLanPrivilege_UsersTypes.Administrator

IpmiLanPrivilege_UsersTypes.No_Access IpmiLanPrivilege_UsersTypes.Operator IpmiLanPrivilege_UsersTypes.User Description Allows you to set IPMI LAN privilege for users.

IpmiSerialPrivilege_Use rs

ENUM IpmiSerialPrivilege_UsersTypes.Administra

tor

IpmiLanPrivilege_UsersTypes.No_Access IpmiLanPrivilege_UsersTypes.Operator IpmiLanPrivilege_UsersTypes.User Description Allows you to set IPMI serial privilege for users.

(28)

Enable_Users ENUM Enable_UsersTypes.Enabled

Enable_UserTypes.Disabled Description Allows you to enable a user.

SolEnable_Users ENUM SolEnable_UsersTypes.Enabled

SolEnable_UsersTypes.Disabled Description Allows you to enable a SOL user.

ProtocolEnable_Users ENUM ProtocolEnable_UserTypes.Enabled

ProtocolEnable_UsersTypes.Disabled Description Allows you to enable a protocol for a user.

AuthenticationProtocol_

Users

ENUM AuthenticationProtocol_UsersTypes.SHA

AuthenticationProtocol_UsersTypes.MD5 AuthenticationProtocol_UsersTypes.T_None Description Allows you to set the authentication protocol.

PrivacyProtocol_Users ENUM PrivacyProtocol_UsersTypes.AES

PrivacyProtocol_UsersTypes.DES PrivacyProtocol_UsersTypes.T_None Description Allows you to set the privacy protocol for a user.

Example:

#Set liason share

myshare = FileOnShare(remote="<IP OR HOSTNAME>:/<NFS-SHARE-PATH>/<FILE-NAME>", mount_point='Z:\', isFolder=False,

creds=UserCredentials(<USERNAME>, <PASSWORD>))

liason_share_status = idrac.config_mgr.set_liason_share(myshare)

(29)

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.SHA, PrivacyProtocol_Users=PrivacyProtocol_UsersTypes.AES

)

apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: JSON Returns a json indicating whether the user was created successfully or not.

Return Type: JSON.

idrac.user_mgr.Users.remove idrac.user_mgr.Users.remove

API string/Method: idrac.user_mgr.Users.remove.

Description: The idrac.user_mgr.Users.remove() returns a JSON to create the user. For more details about the properties and values, refer to iDRAC Attribute Registry Guide.

Table 69. Parameters for idrac.user_mgr.Users.remove

UserName_Users String User Defined string

Description Allows you to create a user name.

Example:

#Set liason share

idrac.user_mgr.Users.remove(UserName_Users="XYZ123")

Return Type: JSON.

iDRAC Network Settings Configuration

idrac.config_mgr.configure_dns

API string/Method: idrac.config_mgr.configure_dns.

(30)

Description: The idrac.config_mgr.configure_dns allows you to configure the DNS server.

Table 70. Parameters for idrac.config_mgr.configure_dns

register_idrac_on_dns Enum DNSRegister_NICTypes.Enabled

DNSRegister_NICTypes.Disabled Description Allows you to register the iDRAC on DNS.

dns_idrac_name String None

Description Allows you to configure the DNS iDRAC name.

auto_config Enum DNSDomainNameFromDHCP_NICTypes.Enabled

DNSDomainNameFromDHCP_NICTypes.Disabled Description Alows you to disable the DNS name from the DHCP.

statis_dns String User defined values

Description Configure the DNS server.

Example:

#Set liason share

#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) print(Prettifyer().prettify_json(msg))

Return Type: JSON.

idrac.config_mgr.configure_ipv4

API string/Method: idrac.config_mgr.configure_ipv4.

(31)

Description: The idrac.config_mgr.configure_ipv4() allows you to configure the IPv4 Settings.

Table 74. Parameters for idrac.config_mgr.configure_ipv4

ip_address String IP Address

Description Enter an IP (IPv4) address or a hostname of the shared folder. The maximum character limit is 64.

enable_dhcp Enum DHCPEnable_IPv4Types.Enabled

DHCPEnable_IPv4Types.Disabled Description Indicates whether the DHCP server is Enabled or Disabled.

dns_1 String User defined values

Description Indicates the static DNS server IPv4 address if DHCP is not used to get the DNS address.

Description Indicates the static alternate DNS server IPv4 address if DHCP is not used to get the DNS address.

dns_from_dhcp Enum DNSFromDHCP_IPv4Types.Enabled

DNSFromDHCP_IPv4Types.Disabled

Description Indicates whether DHCP is used to obtain primary and secondary DNS server addresses from

enable_ipv4 Enum Enable_IPv4Types.Enabled

Enable_IPv4Types.Disabled

(32)

gateway String User defined values

Description Configure the Default Gateway IP address.

net_mask String User defined values

Description Configure the iDRAC subnet mask.

Example:

#Set liason share

liason_share_status = idrac.config_mgr.set_liason_share(myshare) idrac.config_mgr.configure_ipv4

(

ip_address = "1.1.1.1", enable_dhcp = DHCPEnable_IPv4Types.Enabled,

dns_1 = None, dns_2 = None, dns_from_dhcp = DNSFromDHCP_IPv4Types.Enabled, enable_ipv4 = Enable_IPv4Types.Enabled, gateway = None, net_mask = None )

apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success or Failure.

Return Type: JSON.

idrac.config_mgr.configure_static_ipv4

API string/Method: idrac.config_mgr.configure_static_ipv4.

Description: The idrac.config_mgr.configure_static_ipv4() allows you to configure the Static IPv4 Settings.

Table 82. Parameters for idrac.config_mgr.configure_static_ipv4

ip_address String IP Address

Description Displays the iDRAC NIC IPv4 address.

Description Indicates the static DNS server IPv4 address if DHCP is not used to get the DNS address.

(33)

Description Indicates the static alternate DNS server IPv4 address if DHCP is not used to get the DNS address.

dns_from_dhcp Enum DNSFromDHCP_IPv4Types.Enabled

DNSFromDHCP_IPv4Types.Disabled

Description Indicates whether DHCP is used to obtain primary and secondary DNS server addresses from the DHCPv4 server.

gateway String User defined values

net_mask String User defined values

Example:

#Set liason share

#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.configure_timezone

API string/Method: idrac.config_mgr.configure_timezone.

(34)

Description: The idrac.config_mgr.configure_timezone() allows you to configure the time zone Settings.

Table 88. Parameters for idrac.config_mgr.configure_timezone

timezone String Timezone

Description Configures the time zone.

Example:

#Set liason share

# Configure Timezone

msg = idrac.config_mgr.configure_timezone('US/Pacific') apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: Success or Failure.

Return Type: JSON.

iDRAC Services Configuration API list

idrac.config_mgr.configure_web_server

API string/Method: idrac.config_mgr.configure_web_server.

Description: The idrac.config_mgr.configure_web_server() allows you to configure web server Settings.

Table 89. Parameters for idrac.config_mgr.configure_web_server

enable_web_server Enum Enable_WebServerTypes.Enabled

Enable_WebServerTypes.Disabled Description Select Enabled to enable the iDRAC web server. This setting is enabled by default.

NOTE: Disabling the web server disables the current web interface session and you cannot log in to iDRAC web interface or use remote RACADM.

http_port Number HTTP Port number

Description Enter the port number that iDRAC uses to listen for a browser connection. The default value is 80. The value must be 1–65535.

(35)

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.

Timeout Number Timeout seconds

Description Enter the time (in seconds) for which a connection is allowed to remain Idle.

The session is canceled when the time-out is reached.

Changes to the timeout setting do not affect the current session.

When you change this time, you must logout and log in again for the new setting to take effect.

Timeout range is 60–10,800 seconds.

The default value is 1800 seconds.

ssl_encryption Enum SSLEncryptionBitLength_WebServerTypes.Aut

o_Negotiate

SSLEncryptionBitLength_WebServerTypes.

128–bit or higher

168–bit or higher

256–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.

128–bit or higher—Enables SSL encryption between client and server using the industry standard 128-bit or higher.

168–bit or higher—Enables SSL encryption between client and server using 168-bit or higher.

256–bit or higher—Enables SSL encryption between client and server using 256-bit or higher.

If you select 256–bit or higher an are using Java, the following warning message is displayed:

Selecting a higher SSL encryption enhances the security.

However, the cryptography settings for your virtual machine

(36)

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.

tls_protocol Enum TLSProtocol_WebServerTypes.TLS 1.0 and

Higher

TLSProtocol_WebServerTypes.TLS 1.1 and Higher

TLSProtocol_WebServerTypes.TLS 1.2 Only Description To specify the minimum supported level of TLS protocol, select one of the following options:

TLS 1.0 and Higher TLS 1.1 and Higher TLS 1.2 Only

NOTE: TLS 1.1 and Higher is the default option. For better security, Dell recommends to use TLS 1.2.

Example:

#Set liason share

#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_128_Bit_or_higher, tls_protocol = TLSProtocol_WebServerTypes.TLS_1_1_and_Higher

)

Return Type: JSON.

idrac.config_mgr.configure_snmp

API string/Method: idrac.config_mgr.configure_snmp.

(37)

Description: The idrac.config_mgr.configure_snmp() allows you to configure SNMP Settings.

Table 95. Parameters for idrac.config_mgr.configure_snmp

snmp_enable Enum AgentEnable_SNMPTypes.Disabled

AgentEnable_SNMPTypes.Enabled Description Allows you to enable to disable the SNMP server.

community_name String User provided input

Description Enter the SNMP community name. The name can have up to 31 nonblank characters. The default name is public. iDRAC uses it to validate SNMP queries and gets (received from remote systems requesting SNMP data Access from iDRAC).

alert_port Number Alert port number

Description Enter the SNMP port number that must be used for SNMP traps. The default value is 162.

Range is 1-65535.

discovery_port Number Discovery port number

Description Allows the server to discover the available port.

snmp_protocol Enum SNMPProtocol_SNMPTypes.All

SNMPProtocol_SNMPTypes.SNMPv3 Description Allows you to select one of the SNMP formats.

(38)

trap_format Enum TrapFormat_SNMPTypes.SNMPv1

TrapFormat_SNMPTypes.SNMPv2 TrapFormat_SNMPTypes.SNMPv3 Description Allows you to select one of the SNMP trap formats.

Example:

#Set liason share

# Configure SNMP Settings

msg = idrac.config_mgr.configure_snmp (

snmp_enable = AgentEnable_SNMPTypes.Disabled, community_name = "test",

snmp_protocol = SNMPProtocol_SNMPTypes.SNMPv3, alert_port = 161,

discovery_port = 162,

trap_format = TrapFormat_SNMPTypes.SNMPv3 )

Return Type: JSON.

iDRAC System Settings API list

This section list the available iDRAC system setting APIs.

Syslog

idrac.config_mgr.enable_syslog

API string/Method: idrac.config_mgr.enable_syslog.

Description: The idrac.config_mgr.enable_syslog() enables System Log configuration.

Allows you to enable the System Log configuration.

Return type: JSON Example:

#Set liason share

(39)

# Enable Syslog

msg = idrac.config_mgr.enable_syslog()

idrac.config_mgr.disable_syslog

API string/Method: idrac.config_mgr.disable_syslog.

Description: The idrac.config_mgr.disable_syslog() enables System Log configuration.

Allows you to disable the System Log configuration.

#Set liason share

# Disable Syslog

msg = idrac.config_mgr.disable_syslog()

Lockdown

idrac.config_mgr.enable_system_lockdown

API string/Method: idrac.config_mgr.enable_system_lockdown.

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

# Enable System Lockdown

msg = idrac.config_mgr.enable_system_lockdown()

idrac.config_mgr.disable_system_lockdown

API string/Method: idrac.config_mgr.disable_system_lockdown.

Description: The idrac.config_mgr.disable_system_lockdown() performs a Lockdown disable operation.

NOTE: Lockdown is supported only on 14th Generation of PowerEdge Servers.

(40)

CSIOR

idrac.config_mgr.enable_csior

API string/Method: idrac.config_mgr.enable_csior.

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.

Description: The idrac.config_mgr.disable_csior() method allows you to disable the CSIOR option in iDRAC which disables the collection of system inventory on reboot.

Return type: JSON

idrac.config_mgr.configure_idrac_alerts

API string/Method: idrac.config_mgr.configure_idrac_alerts.

Description: The idrac.config_mgr.configure_idrac_alerts() allows you to enable or disable the iDRAC alerts Settings.

Table 101. Parameters for idrac.config_mgr.configure_idrac_alerts

enable_alerts Number

AlertEnable_IPMILanTypes.Enabled AlertEnable_IPMILanTypes.Disabled Description Configure the iDRAC alert settings.

Example:

#Set liason share

#Alert Configuration

idrac.config_mgr.configure_idrac_alerts (

enable_alerts=AlertEnable_IPMILanTypes.Disabled )

apply_status = idrac.config_mgr.apply_changes(reboot=False)

(41)

Returns: Success or Failure.

Return Type: JSON.

idrac.config_mgr.configure_snmp_trap_destination

API string/Method: idrac.config_mgr.configure_snmp_trap_destination.

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

destination_number Number Destination number

Description Displays up to 4 IPv4 and IPv6 addresses.

destination String Destination Address

Description To receive trap alerts, enter the address (IPv4, IPv6, or FQDN). If all destination addresses display existing IP addresses, you have configured all the existing alert destinations and must reuse a disabled alert.

NOTE: The destination community must be the same as the iDRAC community.

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.

state Enum State_SNMPAlertTypes.Enabled

State_SNMPAlertTypes.Disabled Description To enable the IP address to receive traps, select this option.

Example:

#Set liason share

(42)

# 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.

Description: The idrac.config_mgr.configure_smtp_server_settings() allows you to configure the SMTP Server Settings.

Table 106. Parameters for idrac.config_mgr.configure_smtp_server_settings

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.

smtp_port Number SMTP Port numer

Description Enter the destination port for email alerts. The default value is 25. Range is 1-65535.

authentication Enum SMTPAuthentication_RemoteHostsTypes.Enabl

ed

SMTPAuthentication_RemoteHostsTypes.Disab led

Description To specify the user name and password for SMTP mail server authentication, select this option.

(43)

username String User defined string

Description To connect to the SMTP server, enter the user name.

password String User defined string

Description To connect for NFS or CIFS file system, enter the password. The maximum length is 255 characters.

Example:

#Set liason share

liason_share_status = idrac.config_mgr.set_liason_share(myshare) idrac.config_mgr.configure_smtp_server_settings

(

smtp_ip_address = "1.1.1.1", smtp_port = 26,

authentication = SMTPAuthentication_RemoteHostsTypes.Enabled, username = None, password = None

)

Return Type: JSON.

idrac.config_mgr.configure_email_alerts

API string/Method: idrac.config_mgr.configure_email_alerts.

Description: The idrac.config_mgr.configure_email_alerts() allows you to configure the SNMP Trap Destination Settings.

Table 111. Parameters for idrac.config_mgr.configure_email_alerts

alert_number Number Alert number

Description Configure up to 4 email destinations that can be set to receive alerts.

(44)

state Enum Enable_EmailAlertTypes.Enabled

Enable_EmailAlertTypes.Disabled Description Configure to receive the alerts, select this option.

address String Destination email Address

Description Enter the email address that must receive the alerts.

custom_message String Custom Message

Description Allows you to enter a custom email message.

Example:

#Set liason share

liason_share_status = idrac.config_mgr.set_liason_share(myshare) idrac.config_mgr.configure_email_alerts

(

alert_number = 4, state=Enable_EmailAlertTypes.Enabled, address = "[email protected]", custom_message = "test"

)

apply_status = idrac.config_mgr.apply_changes(reboot=False) Returns: True or False.

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.

Description: The idrac.config_mgr.configure_boot_mode() allows you to configure the boot Mode.

(45)

Table 115. Parameters for idrac.config_mgr.configure_boot_mode

boot_mode Enum Bios - BootModeTypes.BIOS

Uefi - BootModeTypes.Uefi Description Configures the boot mode to BIOS or UEFI.

Example:

#Set liason share

# Configure Boot Mode

msg = idrac.config_mgr.configure_boot_mode(BootModeTypes.Uefi) apply_status = idrac.config_mgr.apply_changes(reboot=True) Returns: Success or Failure.

Return Type: JSON.

idrac.config_mgr.configure_onetime_boot_mode

API string/Method: idrac.config_mgr.configure_onetime_boot_mode.

Description: The idrac.config_mgr.configure_onetime_boot_mode() allows you to set the specified device as the first device in the boot order for the next boot cycle only. The device must be a device from the bootseq option device list.

Table 116. Parameters for idrac.config_mgr.configure_onetime_boot_mode

onetime_boot_mode Enum OneTimeBootModeTypes.Disabled

OneTimeBootModeTypes.OneTimeBootSeq OneTimeBootModeTypes.OneTimeCustomBootSeq Str

OneTimeBootModeTypes.OneTimeCustomHddSeqS tr

OneTimeBootModeTypes.OneTimeCustomUefiBoo tSeqStr

OneTimeBootModeTypes.OneTimeHddSeq OneTimeBootModeTypes.OneTimeUefiBootSeq Description Allows you to enable or disable the one time boot mode.

Example:

#Set liason share

myshare = FileOnShare(remote="<IP OR HOSTNAME>:/<NFS-SHARE-PATH>/<FILE-NAME>",

Dell EMC OpenManage Python Software Development Kit