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 66. Parameters for idrac.user_mgr.Users.new
Parameter Name Type Allowed Values
ProtocolEnable_Users
ENUM
ProtocolEnable_UserTypes.Enabled
ProtocolEnable_UsersTypes.Disabled
Description Allows you to enable a protocol for a user.
Table 67. Parameters for idrac.user_mgr.Users.new
Parameter Name Type Allowed Values
AuthenticationProtocol
_Users
ENUM
AuthenticationProtocol_UsersTypes.SHA
AuthenticationProtocol_UsersTypes.MD5
AuthenticationProtocol_UsersTypes.T_Non
e
Description Allows you to set the authentication protocol.
Table 68. Parameters for idrac.user_mgr.Users.new
Parameter Name Type Allowed Values
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)
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.
Protocol Support: Redfish.
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.
24
OpenManage Python SDK API introduction