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
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 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))
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.config_mgr.configure_ipv4
API string/Method: idrac.config_mgr.configure_ipv4.
Protocol Support: Redfish.
Description: The idrac.config_mgr.configure_ipv4() allows you to configure the IPv4 Settings.
Table 74. Parameters for idrac.config_mgr.configure_ipv4
Parameter Name Type Allowed Values
ip_address
String IP Address
Description Enter an IP (IPv4) address or a hostname of the shared folder. The maximum character
limit is 64.
Table 75. Parameters for idrac.config_mgr.configure_ipv4
Parameter Name Type Allowed Values
enable_dhcp
Enum
DHCPEnable_IPv4Types.Enabled
DHCPEnable_IPv4Types.Disabled
Description Indicates whether the DHCP server is Enabled or Disabled.
Table 76. Parameters for idrac.config_mgr.configure_ipv4
Parameter Name Type Allowed Values
dns_1
String User defined values
Description Indicates the static DNS server IPv4 address if DHCP is not used to get the DNS
address.
Table 77. Parameters for idrac.config_mgr.configure_ipv4
Parameter Name Type Allowed Values
dns_2
String User defined values
Description Indicates the static alternate DNS server IPv4 address if DHCP is not used to get the
DNS address.
Table 78. Parameters for idrac.config_mgr.configure_ipv4
Parameter Name Type Allowed Values
dns_from_dhcp
Enum
DNSFromDHCP_IPv4Types.Enabled
DNSFromDHCP_IPv4Types.Disabled
26 OpenManage Python SDK API introduction