API Guide

Table Of Contents
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)
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
)
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 the SNMP Trap Destination
Settings.
Table 111. Parameters for idrac.config_mgr.configure_email_alerts
Parameter Name Type Allowed Values
alert_number
Number Alert number
Description Configure up to 4 email destinations that can be set to receive alerts.
Table 112. Parameters for idrac.config_mgr.configure_email_alerts
Parameter Name Type Allowed Values
state
Enum
Enable_EmailAlertTypes.Enabled
Enable_EmailAlertTypes.Disabled
Description Configure to receive the alerts, select this option.
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.configure_email_alerts
Parameter Name Type Allowed Values
custom_message
String Custom Message
Description Allows you to enter a custom email message.
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)
OpenManage Python SDK API introduction
37