Examples

The Rest and Redfish folders contain a few examples for performing different iLO tasks using legacy RESTful API and Redfish API respectively. The examples in this page are legacy RESTful examples and are very similar to their Redfish equivalents. The HPE RESTful API 1.x expresses the root Uniform Resource Identifier (URI) protocol version as “/rest/v1”. Redfish 1.0 expresses the starting URI as “/redfish/v1/”.

Redfish changes the linking between resources, for example “href” is renamed to “@odata.id”. For more information about Redfish implementation click here.

The following examples can all be used as guidance for managing iLO using iLO RESTful API.

These examples use _restobject.py and _redfishobject.py, simple example clients for Rest/Redfish, to complete their operations. In order for the examples to run properly these files need to be placed in the same directory as the examples you are running.

Examples

• Example 1: get resource directory
• Example 2: get base registry
• Example 3: change server BIOS settings
• Example 4: reset the server
• Example 5: enable secure boot
• Example 6: revert to default BIOS settings
• Example 7: change UEFI boot order
• Example 8: change temporary boot order
• Example 9: find iLO mac address
• Example 10: add iLO user account
• Example 11: modify iLO user account
• Example 12: remove an iLO user account
• Example 13: dump iLO NIC state
• Example 14: create, use and delete user session
• Example 15: set UID led
• Example 16: get computer details
• Example 17: mount virtual media ISO
• Example 18: set server asset tag
• Example 19: reset iLO
• Example 20: get iLO NIC
• Example 21: set iLO NIC active
• Example 22: dump Integrated Management Log
• Example 23: dump iLO Event Log
• Example 24: clear Integrated Management Log
• Example 25: clear iLO Event Log
• Example 26: configure SNMP
• Example 27: get schema
• Example 28: set iLO time zone
• Example 29: set iLO NTP servers
• Example 30: get power metrics average
• Example 31: set license key
• Example 32: set BIOS DHCP
• Example 33: set BIOS service
• Example 34: set BIOS UEFI shell startup
• Example 35: set BIOS iSCSI
• Example 36: set BIOS url boot file
• Example 37: set ESKM PrimaryKeyServer
• Example 38: set ESKM username password
• Example 39: test ESKM connection
• Example 40: reset ESKM Event Log
• Example 41: dump ESKM Event Log
• Example 42: get ESKM
• Example 43: get encryption settings
• Example 44: get logical drives
• Example 45: get license key