API Guide
Table Of Contents
- Dell EMC OpenManage Python Software Development Kit Version 1.0 API Reference Guide
- Introduction to OpenManage python software development toolkit
- Installation and Uninstallation of OMPSDK
- OpenManage Python SDK API introduction
- OpenManage Python SDK API list
- Monitoring API list
- Administration tasks API list
- Export and Import Tasks API list
- Server iDRAC Settings Configuration API list
- Boot Settings Configuration API list
- RAID Configuration API list
- iDRAC LC Jobs API list
- iDRAC LC Status Check API list
- OpenManage Python SDK API list
- Getting Started
Table 94. Parameters for idrac.config_mgr.configure_web_server (continued)
Parameter Name Type Allowed Values
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
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)
#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
)
apply_status = idrac.config_mgr.apply_changes(reboot=False)
Returns: Success or Failure.
Return Type: JSON.
idrac.config_mgr.configure_snmp
API string/Method: idrac.config_mgr.configure_snmp.
Protocol Support: Redfish.
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. 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).
OpenManage Python SDK API introduction 31