Examples¶
Note
Successful creation, modification or deletion of a resource will usually result in a response code of 200 or 201. An unsuccessful attempt will likely result in a 400 error code with a more detailed error message within the body of the response, ‘@Message.ExtendedInfo’.
Note
Examples showcasing Redfish standard properties and Actions will work for any BMC implementing Redfish. Any HPE OEM extensions are labeled in the examples as such.
The Redfish and Legacy_Rest folders contain many examples for performing different iLO tasks using the Redfish API and Legacy RESTful API respectively.
Redfish Example Reference Table¶
Example |
Link |
Add an iLO Manager Account |
|
Revert the BIOs to default values |
|
Change the BIOs settings. |
|
Change the boot order for HPE iLO systems. |
|
Change the temporary boot order. |
|
Clear AHS data for HPE iLO systems. |
|
Clear IEL or IML Logs for HPE iLO systems. |
|
Gather the computer system details. |
|
Configure SNMP for HPE iLO systems. |
|
Enable NTP servers for HPE iLO systems. |
|
Enable secure boot. |
|
Expand data responses. |
|
Clear IEL or IML Logs for HPE iLO systems. |
|
Generate a certificate signing request for |
|
Gather ESKM data for HPE iLO systems. |
|
Gather the Logical Drives on an HPE iLO system. |
|
Gather the Smart Array encryption settings on |
|
Gather AHS data for HPE iLO systems. |
|
Obtain the base message registry. |
|
Obtain the Manager IP. |
|
Obtain the Manager NIC data. |
|
Obtain an iLO license key for HPE iLO systems. |
|
Obtain the power metrics average on HPE iLO |
|
Obtain iLO information. |
|
Obtain iLO utility information, such as iLO |
|
Obtain schema data on any BMC with schemas |
|
Import an SSL certificate for HPE iLO systems. |
|
Modify a user account. |
|
Mount virtual media for HPE iLO systems. |
|
Create Redfish client. |
|
Reboot a server. |
|
Remove a user account. |
|
Reset the ESKM event log for HPE iLO systems. |
|
Reset a Manager. |
|
Reset a sever. |
|
Manually manage sessions with Redfish |
|
Set the primary ESKM key server properties |
|
Set the ESKM username and password for HPE |
|
Set active Manager NIC. |
|
Set an ISCSI boot instance for HPE iLO |
|
Set the BIOS password for HPE iLO systems. |
|
Set the Manager ethernet interface static IP. |
|
Set the NTP servers for HPE iLO systems. |
|
Set the time zone for HPE iLO systems. |
|
Add a license key for HPE iLO systems. |
|
Set the server asset tag. |
|
Configure SNMP alert for HPE iLO systems. |
|
Set the UID light. |
|
Provide the firmware inventory on HPE iLO |
|
Test a connection to the ESKM system for HPE |
|
Update the firmware by using an HTTP URL. |
|
Upload the firmware to the iLO Repository for |
|
Upload a firmware component with a size less |
Legacy Rest Example Reference Table¶
Example |
Link |
Add an iLO user account. |
|
Revert the BIOs to default values. |
|
Change the BIOs settings. |
|
Change the boot order for HPE iLO systems. |
|
Change the temporary boot order. |
|
Clear the AHS data. |
|
Clear IEL or IML Logs for HPE iLO systems. |
|
Clear the IML. |
|
Gather the computer system details. |
|
Configure SNMP for HPE iLO systems. |
|
Dump the ESKM event log. |
|
Dump the iLO event log. |
|
Dump the Manager NIC data. |
|
Dump the IML. |
|
Enables secure boot. |
|
Clear IEL or IML Logs for HPE iLO systems. |
|
Generate a certificate signing request for |
|
Gather ESKM data for HPE iLO systems. |
|
Gather the encryption settings on HPE iLO systems. |
|
Obtain the logical drives. |
|
Gather AHS data for HPE iLO systems. |
|
Obtain the base message registry. |
|
Obtain the CSR. |
|
Obtain the Manager IP. |
|
Obtain the Manager NIC data. |
|
Obtain an iLO license key for HPE iLO systems. |
|
Obtain the power metrics average on HPE iLO |
|
Obtain the iLO information, such as iLO |
|
Obtain the schema data on any system with |
|
Import an SSL certificate for HPE iLO systems. |
|
Modify a user account. |
|
Mount virtual media for HPE iLO systems. |
|
Remove an iLO user account. |
|
Reset the ESKM event log for HPE iLO systems. |
|
Reset iLO. |
|
Reset a sever. |
|
Create a session. |
|
Set active Manager NIC. |
|
Set the DHCP boot instance for HPE iLO systems. |
|
Set the primary ESKM key server for HPE iLO |
|
Set the ESKM username and password for HPE iLO |
|
Set the NTP servers for HPE iLO systems. |
|
Set an ISCSI boot instance for HPE iLO systems. |
|
Set the BIOS password for HPE iLO systems. |
|
Set the BIOS service. |
|
Set the UEFI shell startup. |
|
Set the URL boot file. |
|
Set the time zone for HPE iLO systems. |
|
Add a license key for HPE iLO systems. |
|
Set the server asset tag. |
|
Set the UID light. |
|
Test a connection to the ESKM system for HPE |
|
Update the firmware by using an HTTP URL. |
Add iLO Manager Account¶
Add an iLO Manager Account based on permissions (iLO 4 and iLO 5) or role ID (iLO 5).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | def add_ilo_user_account(_redfishobj, new_loginname, new_username, new_password, role_id, \
privilege_dict):
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#resource directory is not available so we will navigate through paths manually to obtain
#account info
account_service_uri = _redfishobj.root.obj['AccountService']['@odata.id']
account_service_response = _redfishobj.get(account_service_uri)
account_collection_uri = account_service_response.obj['Accounts']['@odata.id']
#Add via role id
body = {"RoleId": role_id}
else:
#obtain all account instances from resource directory
for instance in resource_instances:
if '#ManagerAccountCollection.' in instance['@odata.type']:
account_collection_uri = instance['@odata.id']
body = {"Oem": {"Hpe": {"Privileges": {}}}}
#HPE server, so add via privileges
for priv in privilege_dict:
body["Oem"]["Hpe"]["Privileges"][priv] = privilege_dict[priv]
#Add login name
body["Oem"]["Hpe"]["LoginName"] = new_loginname
#Fill in the rest of the payload
body["UserName"] = new_username
body["Password"] = new_password
#We pass the URI and the dictionary as a POST command (part of the redfish object)
resp = _redfishobj.post(account_collection_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception:
sys.stderr.write("A response error occurred, unable to access iLO Extended Message "\
"Info...")
elif not resp.status in [200, 201]:
sys.stderr.write("An http response of '%s' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
BIOS Revert Default¶
Set all BIOS attributes to their respective factory default states.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | def bios_revert_default(_redfishobj):
bios_reset_action_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
bios_uri = systems_members_response.obj['Bios']['@odata.id']
bios_response = _redfishobj.get(bios_uri)
bios_reset_action_uri = bios_response.obj['Actions']['#Bios.ResetBios']['target']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#Bios.' in instance['@odata.type']:
bios_uri = instance['@odata.id']
bios_data = _redfishobj.get(bios_uri)
bios_reset_action_uri = bios_data.obj['Actions']['#Bios.ResetBios']['target']
break
body = {'Action': 'Bios.ResetBios', 'ResetType':'default'}
resp = _redfishobj.post(bios_reset_action_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception:
sys.stderr.write("A response error occurred, unable to access iLO Extended Message "\
"Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Change BIOS Setting¶
Alter one ore more BIOS attributes.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | def change_bios_setting(_redfishobj, bios_property, property_value, bios_password):
bios_uri = None
bios_data = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
bios_uri = systems_members_response.obj['Bios']['@odata.id']
bios_data = _redfishobj.get(bios_uri)
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#Bios.' in instance['@odata.type']:
bios_uri = instance['@odata.id']
bios_data = _redfishobj.get(bios_uri)
break
if bios_data:
print("\n\nShowing bios attributes before changes:\n\n")
print(json.dumps(bios_data.dict, indent=4, sort_keys=True))
if bios_uri:
#Bios settings URI is needed
bios_settings_uri = bios_data.obj['@Redfish.Settings']['SettingsObject']['@odata.id']
body = {'Attributes': {bios_property: property_value}}
#update bios password
if bios_password:
_redfishobj.bios_password = bios_password
resp = _redfishobj.patch(bios_settings_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("\nSuccess!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
#uncomment if you would like to see the full list of attributes
#print("\n\nShowing bios attributes after changes:\n\n")
#bios_data = _redfishobj.get(bios_uri)
#print(json.dumps(bios_data.dict, indent=4, sort_keys=True))
|
Change Temporary Boot Order¶
Alter the temporary boot order.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | def change_temporary_boot_order(_redfishobj, boottarget):
systems_members_uri = None
systems_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
else:
for instance in resource_instances:
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
if systems_members_response:
print("\n\nShowing bios attributes before changes:\n\n")
print(json.dumps(systems_members_response.dict.get('Boot'), indent=4, sort_keys=True))
body = {'Boot': {'BootSourceOverrideTarget': boottarget}}
resp = _redfishobj.patch(systems_members_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended Message "\
"Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("\nSuccess!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
if systems_members_response:
print("\n\nShowing boot override target:\n\n")
print(json.dumps(systems_members_response.dict.get('Boot'), indent=4, sort_keys=True))
|
Example of the Boot Object¶
The folowing JSON output can be obtained first by noting the systems_members_response on line 42 above.
else:
for instance in resource_instances:
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
if systems_members_response:
print("\n\nShowing bios attributes before changes:\n\n")
print(json.dumps(systems_members_response.dict.get('Boot'), indent=4, sort_keys=True))
The user can preview the data prior:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | {
"BootOptions": {
"@odata.id": "/redfish/v1/Systems/1/BootOptions/"
},
"BootOrder": [
"Boot0011",
"Boot0019",
"Boot0009",
"Boot0012",
"Boot0010",
"Boot0014",
"Boot000C",
"Boot000E",
"Boot000F",
"Boot0017",
"Boot000D",
"Boot0013"
],
"BootSourceOverrideEnabled": "Disabled",
"BootSourceOverrideMode": "UEFI",
"BootSourceOverrideTarget": "None",
"BootSourceOverrideTarget@Redfish.AllowableValues": [
"None",
"Cd",
"Hdd",
"Usb",
"SDCard",
"Utilities",
"Diags",
"BiosSetup",
"Pxe",
"UefiShell",
"UefiHttp",
"UefiTarget"
],
"UefiTargetBootSourceOverride": "None",
"UefiTargetBootSourceOverride@Redfish.AllowableValues": [
"HD(1,GPT,0940C33C-EAF1-43CD-8C8F-4426672227FE,0x800,0x4E000)/\\EFI\\sles\\shim.efi",
"HD(1,GPT,22F62F69-47E7-4334-BCE6-A0B321810BA1,0x800,0x64000)/\\EFI\\redhat\\shimx64.efi",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv4(0.0.0.0)/Uri()",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv4(0.0.0.0)",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)/Uri()",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x1)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x2)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x3)",
"PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x1,0x0)",
"PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x1,0x1)"
]
}
|
Change Boot Order¶
Alter the default boot order.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | def change_boot_order(_redfishobj, bios_password):
bios_boot_uri = None
bios_boot_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
bios_uri = systems_members_response.obj['Bios']['@odata.id']
bios_response = _redfishobj.get(bios_uri)
bios_boot_uri = bios_response.obj.Oem.Hpe.Links.Boot['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeServerBootSettings.' in instance['@odata.type']:
bios_boot_uri = instance['@odata.id']
break
if bios_boot_uri:
bios_boot_response = _redfishobj.get(bios_boot_uri)
#Bios boot settings URI is needed
bios_boot_settings_uri = bios_boot_response.obj['@Redfish.Settings']['SettingsObject']\
['@odata.id']
#update bios password
if bios_password:
_redfishobj.bios_password = bios_password
sys.stdout.write("Rotating the first boot device to the end of the boot order.\n")
sys.stdout.write('Current Order:\n')
boot_order = bios_boot_response.obj['DefaultBootOrder']
for indx, boot_device in enumerate(boot_order):
sys.stdout.write('Pos ' + str(indx) + ' : ' + boot_device + '\n')
device = boot_order.pop(0)
sys.stdout.write("Rotating device: \'%s\' to the end of the boot order.\n" % device)
boot_order.append(device)
body = {'DefaultBootOrder': boot_order}
resp = _redfishobj.patch(bios_boot_settings_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended Message"\
" Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success! Your system may need to be restarted.\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
else:
sys.stderr.write("Unable to find Boot Order URI.\n")
|
Clear AHS Data¶
Clear Active Health System log data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | def clear_ahs_data(_redfishobj):
active_health_system_clear_log_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
active_health_system_uri = managers_members_response.obj.Oem.Hpe.Links\
['ActiveHealthSystem']['@odata.id']
active_health_system_response = _redfishobj.get(active_health_system_uri)
active_health_system_clear_log_uri = active_health_system_response.obj['Actions']\
['#HpeiLOActiveHealthSystem.ClearLog']['target']
else:
for instance in resource_instances:
if '#HpeiLOActiveHealthSystem.' in instance['@odata.type']:
active_health_system_uri = instance['@odata.id']
active_health_system_response = _redfishobj.get(active_health_system_uri)
active_health_system_clear_log_uri = active_health_system_response['Actions']\
['#HpeiLOActiveHealthSystem.ClearLog']['target']
break
if active_health_system_clear_log_uri:
body = {"Action": "HpeiLOActiveHealthSystem.ClearLog"}
resp = _redfishobj.redfish_client.post(active_health_system_clear_log_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4,\
sort_keys=True))
except Exception:
sys.stderr.write("A response error occurred, unable to access iLO Extended " \
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Clear IEL/IML Data¶
Clear iLO event log and management log data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | def clear_ilo_event_log(_redfishobj, clear_IML_IEL):
clear_log_services_uri = []
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
log_services_uri = systems_members_response.obj['LogServices']['@odata.id']
log_services_response = _redfishobj.get(log_services_uri)
log_services_uris = log_services_response.obj['Members']
for log_services_uri in log_services_uris:
log_services_response = _redfishobj.get(log_services_uri['@odata.id'])
clear_log_services_uri.append(log_services_response.obj['Actions']\
['#LogService.ClearLog']['target'])
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#LogService.' in instance['@odata.type']:
log_service_uri = instance['@odata.id']
clear_log_services_uri.append(_redfishobj.get(log_service_uri).dict['Actions']\
['#LogService.ClearLog']['target'])
if clear_log_services_uri:
body = {"Action": "LogService.ClearLog"}
for path in clear_log_services_uri:
if ("IEL" in clear_IML_IEL and "IEL" in path) or ("IML" in clear_IML_IEL and \
"IML" in path):
if "IEL" in path:
sys.stdout.write("Clearing IEL log.\n")
else:
sys.stdout.write("Clearing IML log.\n")
resp = _redfishobj.post(path, body)
else:
continue
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended
#info error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO "\
"Extended Message Info...\n")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Clear IEL/IML Data¶
Print computer system JSON data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | def computer_details(_redfishobj):
systems_members_uri = None
systems_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
print("\n\nPrinting computer system details:\n\n")
print(json.dumps(systems_members_response.dict, indent=4, sort_keys=True))
|
Computer System Data¶
The folowing JSON output is obtained when accessing type ComputerSystem. Values may vary from system to system, and key entries may differ based on the schema version for #ComputerSystem.
The user can preview the data prior:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | {
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.etag": "W/\"7010F715\"",
"@odata.id": "/redfish/v1/Systems/1/",
"@odata.type": "#ComputerSystem.v1_10_0.ComputerSystem",
"Actions": {
"#ComputerSystem.Reset": {
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff",
"GracefulShutdown",
"ForceRestart",
"Nmi",
"PushPowerButton"
],
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset/"
}
},
"AssetTag": "",
"Bios": {
"@odata.id": "/redfish/v1/systems/1/bios/"
},
"BiosVersion": "U32 v2.22 (11/13/2019)",
"Boot": {
"BootOptions": {
"@odata.id": "/redfish/v1/Systems/1/BootOptions/"
},
"BootOrder": [
"Boot0011",
"Boot0019",
"Boot0009",
"Boot0012",
"Boot0010",
"Boot0014",
"Boot000C",
"Boot000E",
"Boot000F",
"Boot0017",
"Boot000D",
"Boot0013"
],
"BootSourceOverrideEnabled": "Once",
"BootSourceOverrideMode": "UEFI",
"BootSourceOverrideTarget": "Hdd",
"BootSourceOverrideTarget@Redfish.AllowableValues": [
"None",
"Cd",
"Hdd",
"Usb",
"SDCard",
"Utilities",
"Diags",
"BiosSetup",
"Pxe",
"UefiShell",
"UefiHttp",
"UefiTarget"
],
"UefiTargetBootSourceOverride": "None",
"UefiTargetBootSourceOverride@Redfish.AllowableValues": [
"HD(1,GPT,0940C33C-EAF1-43CD-8C8F-4426672227FE,0x800,0x4E000)/\\EFI\\sles\\shim.efi",
"HD(1,GPT,22F62F69-47E7-4334-BCE6-A0B321810BA1,0x800,0x64000)/\\EFI\\redhat\\shimx64.efi",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv4(0.0.0.0)/Uri()",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv4(0.0.0.0)",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)/Uri()",
"PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x1)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x2)",
"PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x3)",
"PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x1,0x0)",
"PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x1,0x1)"
]
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/"
},
"HostName": "localhost.americas.hpqcorp.net",
"Id": "1",
"IndicatorLED": "Off",
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1/"
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/1/"
}
]
},
"LogServices": {
"@odata.id": "/redfish/v1/Systems/1/LogServices/"
},
"Manufacturer": "HPE",
"Memory": {
"@odata.id": "/redfish/v1/Systems/1/Memory/"
},
"MemoryDomains": {
"@odata.id": "/redfish/v1/Systems/1/MemoryDomains/"
},
"MemorySummary": {
"Status": {
"HealthRollup": "OK"
},
"TotalSystemMemoryGiB": 32,
"TotalSystemPersistentMemoryGiB": 0
},
"Model": "ProLiant DL360 Gen10",
"Name": "Computer System",
"NetworkInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/"
},
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeComputerSystemExt.HpeComputerSystemExt",
"@odata.type": "#HpeComputerSystemExt.v2_9_0.HpeComputerSystemExt",
"Actions": {
"#HpeComputerSystemExt.PowerButton": {
"PushType@Redfish.AllowableValues": [
"Press",
"PressAndHold"
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.PowerButton/"
},
"#HpeComputerSystemExt.SecureSystemErase": {
"target": "/redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.SecureSystemErase/"
},
"#HpeComputerSystemExt.SystemReset": {
"ResetType@Redfish.AllowableValues": [
"ColdBoot",
"AuxCycle"
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.SystemReset/"
}
},
"AggregateHealthStatus": {
"AgentlessManagementService": "Unavailable",
"BiosOrHardwareHealth": {
"Status": {
"Health": "OK"
}
},
"FanRedundancy": "Redundant",
"Fans": {
"Status": {
"Health": "OK"
}
},
"Memory": {
"Status": {
"Health": "OK"
}
},
"Network": {
"Status": {
"Health": "OK"
}
},
"PowerSupplies": {
"PowerSuppliesMismatch": false,
"Status": {
"Health": "OK"
}
},
"Processors": {
"Status": {
"Health": "OK"
}
},
"Storage": {
"Status": {
"Health": "Warning"
}
},
"Temperatures": {
"Status": {
"Health": "OK"
}
}
},
"Bios": {
"Backup": {
"Date": "11/13/2019",
"Family": "U32",
"VersionString": "U32 v2.22 (11/13/2019)"
},
"Current": {
"Date": "11/13/2019",
"Family": "U32",
"VersionString": "U32 v2.22 (11/13/2019)"
},
"UefiClass": 2
},
"CriticalTempRemainOff": false,
"CurrentPowerOnTimeSeconds": null,
"DeviceDiscoveryComplete": {
"AMSDeviceDiscovery": "NoAMS",
"DeviceDiscovery": "vMainDeviceDiscoveryComplete",
"SmartArrayDiscovery": "Complete"
},
"ElapsedEraseTimeInMinutes": 0,
"EndOfPostDelaySeconds": null,
"EstimatedEraseTimeInMinutes": 0,
"IntelligentProvisioningAlwaysOn": true,
"IntelligentProvisioningIndex": 8,
"IntelligentProvisioningLocation": "System Board",
"IntelligentProvisioningVersion": "3.60.12",
"IsColdBooting": false,
"Links": {
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/"
},
"HpeIpProvider": {
"@odata.id": "/redfish/v1/systems/1/hpeip/"
},
"NetworkAdapters": {
"@odata.id": "/redfish/v1/Systems/1/BaseNetworkAdapters/"
},
"PCIDevices": {
"@odata.id": "/redfish/v1/Systems/1/PCIDevices/"
},
"PCISlots": {
"@odata.id": "/redfish/v1/Systems/1/PCISlots/"
},
"SUT": {
"@odata.id": "/redfish/v1/systems/1/hpsut/"
},
"SecureEraseReportService": {
"@odata.id": "/redfish/v1/Systems/1/SecureEraseReportService/"
},
"SmartStorage": {
"@odata.id": "/redfish/v1/Systems/1/SmartStorage/"
},
"USBDevices": {
"@odata.id": "/redfish/v1/Systems/1/USBDevices/"
},
"USBPorts": {
"@odata.id": "/redfish/v1/Systems/1/USBPorts/"
},
"WorkloadPerformanceAdvisor": {
"@odata.id": "/redfish/v1/Systems/1/WorkloadPerformanceAdvisor/"
}
},
"PCAPartNumber": "847479-001",
"PCASerialNumber": "PVZEK0ARHA014I",
"PostDiscoveryCompleteTimeStamp": null,
"PostDiscoveryMode": null,
"PostMode": null,
"PostState": "FinishedPost",
"PowerAllocationLimit": 500,
"PowerAutoOn": "Restore",
"PowerOnDelay": "Minimum",
"PowerOnMinutes": 80051,
"PowerRegulatorMode": "OSControl",
"PowerRegulatorModesSupported": [
"OSControl",
"Dynamic",
"Max",
"Min"
],
"ProcessorJitterControl": {
"ConfiguredFrequencyLimitMHz": 0,
"Mode": "Disabled"
},
"SMBIOS": {
"extref": "/smbios"
},
"ServerFQDN": "",
"SmartStorageConfig": [
{
"@odata.id": "/redfish/v1/systems/1/smartstorageconfig/"
}
],
"SystemROMAndiLOEraseComponentStatus": {
"BIOSSettingsEraseStatus": "Idle",
"iLOSettingsEraseStatus": "Idle"
},
"SystemROMAndiLOEraseStatus": "Idle",
"UserDataEraseComponentStatus": {},
"UserDataEraseStatus": "Idle",
"VirtualProfile": "Inactive"
}
},
"PowerState": "On",
"ProcessorSummary": {
"Count": 1,
"Model": "Intel(R) Xeon(R) Bronze 3106 CPU @ 1.70GHz",
"Status": {
"HealthRollup": "OK"
}
},
"Processors": {
"@odata.id": "/redfish/v1/Systems/1/Processors/"
},
"SKU": "DL3000GEN10",
"SecureBoot": {
"@odata.id": "/redfish/v1/Systems/1/SecureBoot/"
},
"SerialNumber": "TX86NP0121",
"Status": {
"Health": "Warning",
"HealthRollup": "Warning",
"State": "Enabled"
},
"Storage": {
"@odata.id": "/redfish/v1/Systems/1/Storage/"
},
"SystemType": "Physical",
"TrustedModules": [
{
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeTrustedModuleExt.HpeTrustedModuleExt",
"@odata.type": "#HpeTrustedModuleExt.v2_0_0.HpeTrustedModuleExt"
}
},
"Status": {
"State": "Absent"
}
}
],
"UUID": "30334C44-3030-5854-3836-4E5030313231"
}
|
Configure SNMP¶
Configure iLO Simple Network Management Protocol.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | def configure_snmp(_redfishobj, read_communities, snmp_alerts):
snmp_service_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
snmp_service_uri = managers_members_response.obj.Oem.Hpe.Links['Snmp']['@odata.id']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#HpeiLOSnmpService.' in instance['@odata.type']:
snmp_service_uri = instance['@odata.id']
if snmp_service_uri:
body = {"AlertsEnabled": snmp_alerts, "ReadCommunities": read_communities}
resp = _redfishobj.patch(snmp_service_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Enable NTP¶
In order to configure iLO Network Time Protocol, certain settings must be in-place on the iLO Management NIC(s) including settings the value of the OEM/HPE object key-value pair UseNTPServers to True.
Note
An iLO Reset will be required in order for the change to be applied.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | def enable_ntp(_redfishobj, ntp_servers):
ethernet_data = {}
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
manager_ethernet_interfaces = managers_members_response.obj['EthernetInterfaces']\
['@odata.id']
manager_ethernet_interfaces_response = _redfishobj.get(manager_ethernet_interfaces)
manager_ethernet_interfaces_members = manager_ethernet_interfaces_response.\
obj['Members']
for _member in manager_ethernet_interfaces_members:
_tmp = _redfishobj.get(_member['@odata.id']).obj
ethernet_data[_member['@odata.id']] = _tmp
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#EthernetInterfaceCollection.' in instance['@odata.type'] and 'Managers' in \
instance['@odata.id']:
ethernet_uri = instance['@odata.id']
ethernet_interfaces = _redfishobj.get(ethernet_uri).obj['Members']
for _ethernet_interface in ethernet_interfaces:
ethernet_data[_ethernet_interface['@odata.id']] = _redfishobj.\
get(_ethernet_interface['@odata.id']).dict
break
if ethernet_data:
print("\n\nShowing all available ethernet management interfaces before changes:\n\n")
print(json.dumps(ethernet_data, indent=4, sort_keys=True))
body = {"Oem": {"Hpe": {"DHCPv4": {"UseNTPServers": ntp_servers}, \
"DHCPv6": {"UseNTPServers": ntp_servers}}}}
for ethernet in ethernet_data:
resp = _redfishobj.patch(ethernet, body)
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
_data = _redfishobj.get(ethernet).dict
sys.stdout.write("\nShowing \'%s\' interface after changes:\n" % ethernet)
print(json.dumps(_data, indent=4, sort_keys=True))
|
Enable Secure Boot¶
Enable/Disable Secure Boot.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | def enable_secure_boot(_redfishobj, secure_boot_enable):
secure_boot_uri = None
secure_boot_data = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
secure_boot_uri = systems_members_response.obj['SecureBoot']['@odata.id']
secure_boot_data = _redfishobj.get(secure_boot_uri)
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#SecureBoot.' in instance['@odata.type']:
secure_boot_uri = instance['@odata.id']
secure_boot_data = _redfishobj.get(secure_boot_uri)
if secure_boot_data:
print("\n\nShowing Secure Boot properties before changes:\n\n")
print(json.dumps(secure_boot_data.dict, indent=4, sort_keys=True))
if secure_boot_uri:
body = {'SecureBootEnable': secure_boot_enable}
resp = _redfishobj.patch(secure_boot_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception:
sys.stderr.write("A response error occurred, unable to access iLO Extended " \
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("\nSuccess!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
print("\n\nShowing Secure Boot properties after changes:\n\n")
secure_boot_data = _redfishobj.get(secure_boot_uri)
print(json.dumps(secure_boot_data.dict, indent=4, sort_keys=True))
|
Expand Data¶
JSON data is typically provided in a collapsed/compactted state. Use $expand as a query string on the desired URI.
1 2 3 4 5 6 7 8 | def expand_data(_redfishobj, expand_url="/redfish/v1/"):
response = _redfishobj.get(expand_url)
exp_response = _redfishobj.get(expand_url+'?$expand=.')
sys.stdout.write('Standard response:\n')
sys.stdout.write('\t'+str(response.dict)+'\n')
sys.stdout.write('Expanded response:\n')
sys.stdout.write('\t'+str(exp_response.dict)+'\n')
|
Response Example¶
Standard response:
{'@odata.context': '/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection', '@odata.etag': 'W/"AA6D42B0"', '@odata.id': '/redfish/v1/Systems/', '@odata.type': '#ComputerSystemCollection.ComputerSystemCollection', 'Description': 'Computer Systems view', 'Name': 'Computer Systems', 'Members': [{'@odata.id': '/redfish/v1/Systems/1/'}], 'Members@odata.count': 1}
Expanded response:
{'@odata.context': '/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection', '@odata.etag': 'W/"5737F79D"', '@odata.id': '/redfish/v1/Systems/', '@odata.type': '#ComputerSystemCollection.ComputerSystemCollection', 'Description': 'Computer Systems view', 'Name': 'Computer Systems', 'Members': [{'@odata.context': '/redfish/v1/$metadata#ComputerSystem.ComputerSystem', '@odata.id': '/redfish/v1/Systems/1/', '@odata.type': '#ComputerSystem.v1_10_0.ComputerSystem', 'Id': '1', 'Actions': {'#ComputerSystem.Reset': {'ResetType@Redfish.AllowableValues': ['On', 'ForceOff', 'GracefulShutdown', 'ForceRestart', 'Nmi', 'PushPowerButton'], 'target': '/redfish/v1/Systems/1/Actions/ComputerSystem.Reset/'}}, 'AssetTag': '', 'Bios': {'@odata.id': '/redfish/v1/systems/1/bios/'}, 'BiosVersion': 'U32 v2.22 (11/13/2019)', 'Boot': {'BootOptions': {'@odata.id': '/redfish/v1/Systems/1/BootOptions/'}, 'BootOrder': ['Boot0011', 'Boot0019', 'Boot0009', 'Boot0012', 'Boot0010', 'Boot0014', 'Boot000C', 'Boot000E', 'Boot000F', 'Boot0017', 'Boot000D', 'Boot0013'], 'BootSourceOverrideEnabled': 'Once', 'BootSourceOverrideMode': 'UEFI', 'BootSourceOverrideTarget': 'Hdd', 'BootSourceOverrideTarget@Redfish.AllowableValues': ['None', 'Cd', 'Hdd', 'Usb', 'SDCard', 'Utilities', 'Diags', 'BiosSetup', 'Pxe', 'UefiShell', 'UefiHttp', 'UefiTarget'], 'UefiTargetBootSourceOverride': 'None', 'UefiTargetBootSourceOverride@Redfish.AllowableValues': ['HD(1,GPT,0940C33C-EAF1-43CD-8C8F-4426672227FE,0x800,0x4E000)/\\EFI\\sles\\shim.efi', 'HD(1,GPT,22F62F69-47E7-4334-BCE6-A0B321810BA1,0x800,0x64000)/\\EFI\\redhat\\shimx64.efi', 'PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv4(0.0.0.0)/Uri()', 'PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv4(0.0.0.0)', 'PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)/Uri()', 'PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(98F2B32CB4A8,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)', 'PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)', 'PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x1)', 'PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x2)', 'PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x3)', 'PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x1,0x0)', 'PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x1,0x1)']}, 'EthernetInterfaces': {'@odata.id': '/redfish/v1/Systems/1/EthernetInterfaces/'}, 'HostName': 'localhost.americas.hpqcorp.net', 'IndicatorLED': 'Off', 'Links': {'ManagedBy': [{'@odata.id': '/redfish/v1/Managers/1/'}], 'Chassis': [{'@odata.id': '/redfish/v1/Chassis/1/'}]}, 'LogServices': {'@odata.id': '/redfish/v1/Systems/1/LogServices/'}, 'Manufacturer': 'HPE', 'Memory': {'@odata.id': '/redfish/v1/Systems/1/Memory/'}, 'MemoryDomains': {'@odata.id': '/redfish/v1/Systems/1/MemoryDomains/'}, 'MemorySummary': {'Status': {'HealthRollup': 'OK'}, 'TotalSystemMemoryGiB': 32, 'TotalSystemPersistentMemoryGiB': 0}, 'Model': 'ProLiant DL360 Gen10', 'Name': 'Computer System', 'NetworkInterfaces': {'@odata.id': '/redfish/v1/Systems/1/NetworkInterfaces/'}, 'Oem': {'Hpe': {'@odata.context': '/redfish/v1/$metadata#HpeComputerSystemExt.HpeComputerSystemExt', '@odata.type': '#HpeComputerSystemExt.v2_9_0.HpeComputerSystemExt', 'Actions': {'#HpeComputerSystemExt.PowerButton': {'PushType@Redfish.AllowableValues': ['Press', 'PressAndHold'], 'target': '/redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.PowerButton/'}, '#HpeComputerSystemExt.SecureSystemErase': {'target': '/redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.SecureSystemErase/'}, '#HpeComputerSystemExt.SystemReset': {'ResetType@Redfish.AllowableValues': ['ColdBoot', 'AuxCycle'], 'target': '/redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.SystemReset/'}}, 'AggregateHealthStatus': {'AgentlessManagementService': 'Unavailable', 'BiosOrHardwareHealth': {'Status': {'Health': 'OK'}}, 'FanRedundancy': 'Redundant', 'Fans': {'Status': {'Health': 'OK'}}, 'Memory': {'Status': {'Health': 'OK'}}, 'Network': {'Status': {'Health': 'OK'}}, 'PowerSupplies': {'PowerSuppliesMismatch': False, 'Status': {'Health': 'OK'}}, 'Processors': {'Status': {'Health': 'OK'}}, 'Storage': {'Status': {'Health': 'Warning'}}, 'Temperatures': {'Status': {'Health': 'OK'}}}, 'Bios': {'Backup': {'Date': '11/13/2019', 'Family': 'U32', 'VersionString': 'U32 v2.22 (11/13/2019)'}, 'Current': {'Date': '11/13/2019', 'Family': 'U32', 'VersionString': 'U32 v2.22 (11/13/2019)'}, 'UefiClass': 2}, 'CriticalTempRemainOff': False, 'CurrentPowerOnTimeSeconds': None, 'DeviceDiscoveryComplete': {'AMSDeviceDiscovery': 'NoAMS', 'DeviceDiscovery': 'vMainDeviceDiscoveryComplete', 'SmartArrayDiscovery': 'Complete'}, 'ElapsedEraseTimeInMinutes': 0, 'EndOfPostDelaySeconds': None, 'EstimatedEraseTimeInMinutes': 0, 'IntelligentProvisioningAlwaysOn': True, 'IntelligentProvisioningIndex': 8, 'IntelligentProvisioningLocation': 'System Board', 'IntelligentProvisioningVersion': '3.60.12', 'IsColdBooting': False, 'Links': {'HpeIpProvider': {'@odata.id': '/redfish/v1/systems/1/hpeip/'}, 'SUT': {'@odata.id': '/redfish/v1/systems/1/hpsut/'}, 'PCIDevices': {'@odata.id': '/redfish/v1/Systems/1/PCIDevices/'}, 'PCISlots': {'@odata.id': '/redfish/v1/Systems/1/PCISlots/'}, 'NetworkAdapters': {'@odata.id': '/redfish/v1/Systems/1/BaseNetworkAdapters/'}, 'SmartStorage': {'@odata.id': '/redfish/v1/Systems/1/SmartStorage/'}, 'USBPorts': {'@odata.id': '/redfish/v1/Systems/1/USBPorts/'}, 'USBDevices': {'@odata.id': '/redfish/v1/Systems/1/USBDevices/'}, 'EthernetInterfaces': {'@odata.id': '/redfish/v1/Systems/1/EthernetInterfaces/'}, 'WorkloadPerformanceAdvisor': {'@odata.id': '/redfish/v1/Systems/1/WorkloadPerformanceAdvisor/'}, 'SecureEraseReportService': {'@odata.id': '/redfish/v1/Systems/1/SecureEraseReportService/'}}, 'PCAPartNumber': '847479-001', 'PCASerialNumber': 'PVZEK0ARHA014I', 'PostDiscoveryCompleteTimeStamp': None, 'PostDiscoveryMode': None, 'PostMode': None, 'PostState': 'FinishedPost', 'PowerAllocationLimit': 500, 'PowerAutoOn': 'Restore', 'PowerOnDelay': 'Minimum', 'PowerOnMinutes': 80090, 'PowerRegulatorMode': 'OSControl', 'PowerRegulatorModesSupported': ['OSControl', 'Dynamic', 'Max', 'Min'], 'ProcessorJitterControl': {'ConfiguredFrequencyLimitMHz': 0, 'Mode': 'Disabled'}, 'SMBIOS': {'extref': '/smbios'}, 'ServerFQDN': '', 'SmartStorageConfig': [{'@odata.id': '/redfish/v1/systems/1/smartstorageconfig/'}], 'SystemROMAndiLOEraseComponentStatus': {'BIOSSettingsEraseStatus': 'Idle', 'iLOSettingsEraseStatus': 'Idle'}, 'SystemROMAndiLOEraseStatus': 'Idle', 'UserDataEraseComponentStatus': {}, 'UserDataEraseStatus': 'Idle', 'VirtualProfile': 'Inactive'}}, 'PowerState': 'On', 'ProcessorSummary': {'Count': 1, 'Model': 'Intel(R) Xeon(R) Bronze 3106 CPU @ 1.70GHz', 'Status': {'HealthRollup': 'OK'}}, 'Processors': {'@odata.id': '/redfish/v1/Systems/1/Processors/'}, 'SKU': 'DL3000GEN10', 'SecureBoot': {'@odata.id': '/redfish/v1/Systems/1/SecureBoot/'}, 'SerialNumber': 'TX86NP0121', 'Status': {'Health': 'Warning', 'HealthRollup': 'Warning', 'State': 'Enabled'}, 'Storage': {'@odata.id': '/redfish/v1/Systems/1/Storage/'}, 'SystemType': 'Physical', 'TrustedModules': [{'Oem': {'Hpe': {'@odata.context': '/redfish/v1/$metadata#HpeTrustedModuleExt.HpeTrustedModuleExt', '@odata.type': '#HpeTrustedModuleExt.v2_0_0.HpeTrustedModuleExt'}}, 'Status': {'State': 'Absent'}}], 'UUID': '30334C44-3030-5854-3836-4E5030313231'}], 'Members@odata.count': 1}
Find iLO MAC Address¶
Retrieve MAC Addresses for iLO Management Network Interfaces.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | def find_ilo_mac_address(_redfishobj):
ethernet_data = {}
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
manager_ethernet_interfaces = managers_members_response.obj['EthernetInterfaces']\
['@odata.id']
manager_ethernet_interfaces_response = _redfishobj.get(manager_ethernet_interfaces)
manager_ethernet_interfaces_members = manager_ethernet_interfaces_response.\
obj['Members']
for _member in manager_ethernet_interfaces_members:
_tmp = _redfishobj.get(_member['@odata.id']).obj
ethernet_data[_member['@odata.id']] = _tmp
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#EthernetInterfaceCollection.' in instance['@odata.type'] and 'Managers' in \
instance['@odata.id']:
ethernet_uri = instance['@odata.id']
ethernet_interfaces = _redfishobj.get(ethernet_uri).obj['Members']
for _ethernet_interface in ethernet_interfaces:
ethernet_data[_ethernet_interface['@odata.id']] = _redfishobj.\
get(_ethernet_interface['@odata.id']).dict
for iface in ethernet_data:
sys.stdout.write("iLO Network Manager Interface: \'%s\'\n" % ethernet_data[iface]['Id'])
sys.stdout.write("\tiLO Mac Address: \'%s\'\n" % ethernet_data[iface].get('MACAddress'))
|
Response Example¶
Standard response:
iLO Network Manager Interface: '1'
iLO Mac Address: '98:F2:B3:21:7B:48'
iLO Network Manager Interface: '2'
iLO Mac Address: '98:F2:B3:21:7B:49'
iLO Network Manager Interface: '3'
iLO Mac Address: '0A:CA:FE:F0:0D:04'
Get Certificate Signing Request¶
Obtain an iLO Certificate Signing Request for use with Secure Socket Layer (SSL)/Transport Layer Security (TLS) Certificate.
Note
This process may take some time to complete on iLO (~5 minutes).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | def generate_csr(_redfishobj, csr_file, csr_properties):
csr_uri = None
generate_csr_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links\
['SecurityService']['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
csr_uri = security_service_response.obj.Links['HttpsCert']['@odata.id']
https_cert_response = _redfishobj.get(csr_uri)
generate_csr_uri = https_cert_response.obj['Actions']['#HpeHttpsCert.GenerateCSR']\
['target']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeHttpsCert.' in instance['@odata.type']:
csr_uri = instance['@odata.id']
generate_csr_uri = _redfishobj.get(csr_uri).obj['Actions']\
['#HpeHttpsCert.GenerateCSR']['target']
break
if generate_csr_uri:
body = dict()
body["Action"] = "HpeHttpsCert.GenerateCSR"
body["City"] = csr_properties["City"]
body["CommonName"] = csr_properties["CommonName"]
body["Country"] = csr_properties["Country"]
body["OrgName"] = csr_properties["OrgName"]
body["OrgUnit"] = csr_properties["OrgUnit"]
body["State"] = csr_properties["State"]
resp = _redfishobj.post(generate_csr_uri, body)
if resp.status in [200, 201]:
sys.stdout.write("Generating CSR, this may take a few minutes\n")
sys.stdout.write("Sleeping for 5 minutes...\n")
time.sleep(600)
csr_resp = _redfishobj.get(csr_uri).dict['CertificateSigningRequest']
with open(csr_file, 'wb') as csroutput:
csroutput.write(csr_resp)
sys.stdout.write("CSR Data saved to file: '%s'\n" % csr_file)
else:
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended
#info error message to see what went wrong
if resp.status not in [200, 201]:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO "\
"Extended Message Info...\n")
|
Get AHS Data¶
Obtain Active Health System Data.
Note
AHS data is saved to a file, the contents of which are encoded. The use of an AHS Viewer to decode and parse is required. Please review Active Health System Viewer Documentation for further details: https://support.hpe.com/hpesc/public/docDisplay?docId=c05384164
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | def get_ahs_data(_redfishobj, logfile):
active_health_system_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
active_health_system_uri = managers_members_response.obj.Oem.Hpe.Links\
['ActiveHealthSystem']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeiLOActiveHealthSystem.' in instance['@odata.type']:
active_health_system_uri = instance['@odata.id']
if active_health_system_uri:
active_health_system_response = _redfishobj.get(active_health_system_uri)
active_health_system_log_uri = active_health_system_response.obj.Links['AHSLocation']\
['extref']
active_health_system_log_resp = _redfishobj.get(active_health_system_log_uri)
if active_health_system_log_resp.status == 400:
try:
print(json.dumps(active_health_system_log_resp.obj['error']\
['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif active_health_system_log_resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
with open(logfile, 'wb') as ahsoutput:
ahsoutput.write(active_health_system_log_resp.ori)
ahsoutput.close()
sys.stdout.write("AHS Data saved successfully as: \'%s\'" % logfile)
|
Get Base Registries¶
Obtain Registry Providers. Registry providers allow for the transaction of data between properties and firmware.
1 2 3 4 5 6 7 8 | def get_base_registry(_redfishobj):
registries_uri = _redfishobj.root.obj['Registries']['@odata.id']
if registries_uri:
registries_members = _redfishobj.get(registries_uri).obj['Members']
for registry in registries_members:
sys.stdout.write("Registry URI at '%s'\n" % registry['@odata.id'])
|
Get ESKM¶
Obtain HPE Enterprise Secure Key Manager Encryption Data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | def get_ESKM(_redfishobj):
security_service_eskm_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links\
['SecurityService']['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
security_service_eskm_uri = security_service_response.obj.Links['ESKM']['@odata.id']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#HpeESKM.' in instance['@odata.type']:
security_service_eskm_uri = instance['@odata.id']
break
if security_service_eskm_uri:
security_service_eskm_resp = _redfishobj.get(security_service_eskm_uri)
print(json.dumps(security_service_eskm_resp.dict, indent=4, sort_keys=True))
|
Response Example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | {
"@odata.context": "/redfish/v1/$metadata#HpeESKM.HpeESKM",
"@odata.etag": "W/\"87058EB1\"",
"@odata.id": "/redfish/v1/Managers/1/SecurityService/ESKM/",
"@odata.type": "#HpeESKM.v2_0_0.HpeESKM",
"Actions": {
"#HpeESKM.ClearESKMLog": {
"target": "/redfish/v1/Managers/1/SecurityService/ESKM/Actions/HpeESKM.ClearESKMLog/"
},
"#HpeESKM.TestESKMConnections": {
"target": "/redfish/v1/Managers/1/SecurityService/ESKM/Actions/HpeESKM.TestESKMConnections/"
}
},
"Id": "ESKM",
"KeyManagerConfig": {
"AccountGroup": "",
"AccountName": "ilo-98f2b3217b48",
"ESKMLocalCACertificateName": "",
"ImportedCertificateIssuer": "",
"ImportedCertificateSubject": ""
},
"KeyServerRedundancyReq": false,
"PrimaryKeyServerAddress": null,
"PrimaryKeyServerPort": null,
"SecondaryKeyServerAddress": null,
"SecondaryKeyServerPort": null
}
|
Get iLO IP¶
Obtain iLO Network Management Interface(s) IP Address(s).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | def get_ilo_ip(_redfishobj):
ethernet_data = {}
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
manager_ethernet_interfaces = managers_members_response.obj['EthernetInterfaces']\
['@odata.id']
manager_ethernet_interfaces_response = _redfishobj.get(manager_ethernet_interfaces)
manager_ethernet_interfaces_members = manager_ethernet_interfaces_response.\
obj['Members']
for _member in manager_ethernet_interfaces_members:
_tmp = _redfishobj.get(_member['@odata.id']).obj
ethernet_data[_member['@odata.id']] = _tmp
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#EthernetInterfaceCollection.' in instance['@odata.type'] and 'Managers' in \
instance['@odata.id']:
ethernet_uri = instance['@odata.id']
ethernet_interfaces = _redfishobj.get(ethernet_uri).obj['Members']
for _ethernet_interface in ethernet_interfaces:
ethernet_data[_ethernet_interface['@odata.id']] = _redfishobj.\
get(_ethernet_interface['@odata.id']).dict
break
if ethernet_data:
for ethernet_interface in ethernet_data:
sys.stdout.write("\n\nShowing iLO IPv4 Address Info on: %s\n\n" % ethernet_interface)
print(json.dumps(ethernet_data[ethernet_interface]['IPv4Addresses'],\
indent=4, sort_keys=True))
|
Response Example¶
Response data for each available network management interface is parsed for the Redfish IPv4 Data including: IP Address, Address Origin (Static/DHCP), Network Gateway, and Network Subnet Mask
Get iLO NIC¶
Obtain iLO Network Management Interface(s) Interface Enabled states. Modify lines 34-37 to display relevant desired data or all key-value pairs.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | def get_ilo_nic(_redfishobj, get_enabled):
ethernet_data = {}
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
manager_ethernet_interfaces = managers_members_response.obj['EthernetInterfaces']\
['@odata.id']
manager_ethernet_interfaces_response = _redfishobj.get(manager_ethernet_interfaces)
manager_ethernet_interfaces_members = manager_ethernet_interfaces_response.\
obj['Members']
for _member in manager_ethernet_interfaces_members:
_tmp = _redfishobj.get(_member['@odata.id']).obj
ethernet_data[_member['@odata.id']] = _tmp
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#EthernetInterfaceCollection.' in instance['@odata.type'] and 'Managers' in \
instance['@odata.id']:
ethernet_uri = instance['@odata.id']
ethernet_interfaces = _redfishobj.get(ethernet_uri).obj['Members']
for _ethernet_interface in ethernet_interfaces:
ethernet_data[_ethernet_interface['@odata.id']] = _redfishobj.\
get(_ethernet_interface['@odata.id']).dict
break
if ethernet_data:
for ethernet_interface in ethernet_data:
sys.stdout.write("\n\nShowing iLO IPv4 Address Info on: %s\n\n" % ethernet_interface)
sys.stdout.write("\n\'Interface_Enabled\': \'%s\'\n" % json.dumps(ethernet_data\
[ethernet_interface][get_enabled], indent=4, sort_keys=True))
|
Response Example¶
Response data for each available network management interface is parsed for the Redfish IPv4 Data including: IP Address, Address Origin (Static/DHCP), Network Gateway, and Network Subnet Mask
Get License Key¶
Obtain iLO Licensing Key Information.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | def get_license_key(_redfishobj):
license_uri = None
license_data = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
hp_hpe = next(iter(managers_members_response.obj.Oem))
license_collection_uri = managers_members_response.obj.Oem[hp_hpe].Links['LicenseService']\
['@odata.id']
license_collection_response = _redfishobj.get(license_collection_uri)
license_collection_members_uri = next(iter(license_collection_response.obj\
['Members']))['@odata.id']
license_data = _redfishobj.get(license_collection_members_uri).dict
license_uri = _redfishobj.get(license_collection_members_uri).dict['@odata.id']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#HpeiLOLicense.' in instance['@odata.type']:
license_uri = instance['@odata.id']
license_data = _redfishobj.get(license_uri).dict
break
if license_data:
try:
sys.stdout.write("\n\'License Info\': \'%s\'\n" % \
json.dumps(license_data['ConfirmationRequest']['EON'], indent=4, sort_keys=True))
except KeyError:
sys.stdout.write("\n\'License Info\': \'%s\'\n" % \
json.dumps(license_data['LicenseKey'], indent=4, sort_keys=True))
|
Response Example¶
Response Data will include the License Type, License Key (iLO 5) and State.
Get Logical Drives¶
List all logical drives associated with a smart array controller.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | def get_SmartArray_LogicalDrives(_redfishobj):
smartstorage_response = []
smartarraycontrollers = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
smart_storage_uri = systems_members_response.obj.Oem.Hpe.Links\
['SmartStorage']['@odata.id']
smart_storage_arraycontrollers_uri = _redfishobj.get(smart_storage_uri).obj.Links\
['ArrayControllers']['@odata.id']
smartstorage_response = _redfishobj.get(smart_storage_arraycontrollers_uri).obj['Members']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#HpeSmartStorageArrayController.' in instance['@odata.type']:
smartstorage_uri = instance['@odata.id']
smartstorage_resp = _redfishobj.get(smartstorage_uri).obj
sys.stdout.write("Logical Drive URIs for Smart Storage Array Controller " \
"'%s\' : \n" % smartstorage_resp.get('Id'))
logicaldrives_uri = smartstorage_resp.Links['LogicalDrives']['@odata.id']
logicaldrives_resp = _redfishobj.get(logicaldrives_uri)
if not logicaldrives_resp.dict['Members']:
sys.stderr.write("\tLogical drives are not available for this controller.\n")
for drives in logicaldrives_resp.dict['Members']:
sys.stdout.write("\t An associated logical drive: %s\n" % drives)
drive_data = _redfishobj.get(drives['@odata.id']).dict
print(json.dumps(drive_data, indent=4, sort_keys=True))
|
Response Example¶
Logical drives listed
Get Power Metrics¶
Obtain Redfish power metrics.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | def get_powermetrics_average(_redfishobj):
power_metrics_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
chassis_uri = _redfishobj.root.obj['Chassis']['@odata.id']
chassis_response = _redfishobj.get(chassis_uri)
chassis_members_uri = next(iter(chassis_response.obj['Members']))['@odata.id']
chassis_members_response = _redfishobj.get(chassis_members_uri)
power_metrics_uri = chassis_members_response.obj.Oem.Hpe['Power']['@odata.id']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#Power.' in instance['@odata.type']:
power_metrics_uri = instance['@odata.id']
break
if power_metrics_uri:
power_metrics_data = _redfishobj.get(power_metrics_uri).obj.Oem.Hpe
print("\n\nPower Data:\n\n")
print(json.dumps(power_metrics_data, indent=4, sort_keys=True))
|
Response Example¶
Power Metric Data
Get Resource Directory¶
Obtain iLO Resource Directory, quick access to all ‘@odata.type’ references and respective ‘@odata.id’.
Note
This resource is only available on iLO systems.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | def get_resource_directory(redfishobj):
try:
resource_uri = redfishobj.root.obj.Oem.Hpe.Links.ResourceDirectory['@odata.id']
except KeyError:
sys.stderr.write("Resource directory is only available on HPE servers.\n")
return None
response = redfishobj.get(resource_uri)
resources = []
if response.status == 200:
sys.stdout.write("\tFound resource directory at /redfish/v1/resourcedirectory" + "\n\n")
resources = response.dict["Instances"]
else:
sys.stderr.write("\tResource directory missing at /redfish/v1/resourcedirectory" + "\n")
return resources
|
Response Example¶
Snippet of Resource directory
Get Schemas¶
Obtain schema data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | def get_schema(_redfishobj):
schema_members_uris = []
schema_members_expanded = {}
schema_uri = _redfishobj.root.obj['JsonSchemas']['@odata.id']
schema_response = _redfishobj.get(schema_uri)
schema_members_uris = schema_response.obj['Members']
for member in schema_members_uris:
data = _redfishobj.get(member['@odata.id']).dict
instance_id = data['Location'].index(next(iter(data['Location'])))
schema_uri = data['Location'][instance_id]['Uri']
schema = _redfishobj.get(schema_uri).dict
#I am just replacing the URI link for the sub-schema with the actual schema. You will
#see EVERYTHING
_tmp = {schema_uri + ' ->': schema}
data['Location'][instance_id]['Uri'] = _tmp
schema_members_expanded[member['@odata.id']] = data
print(json.dumps(schema_members_expanded, indent=4, sort_keys=True))
|
Response Example¶
Snippet of schema data for HpeiLOManagerNetworkService
Get Smart Array Encryption¶
Obtain Smart Array controller encryption property data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | def get_SmartArray_EncryptionSettings(_redfishobj, desired_properties):
smartstorage_response = []
smartarraycontrollers = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
smart_storage_uri = systems_members_response.obj.Oem.Hpe.Links\
['SmartStorage']['@odata.id']
smart_storage_arraycontrollers_uri = _redfishobj.get(smart_storage_uri).obj.Links\
['ArrayControllers']['@odata.id']
smartstorage_response = _redfishobj.get(smart_storage_arraycontrollers_uri).obj['Members']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#HpeSmartStorageArrayControllerCollection.' in instance['@odata.type']:
smartstorage_uri = instance['@odata.id']
smartstorage_response = _redfishobj.get(smartstorage_uri).obj['Members']
break
for controller in smartstorage_response:
smartarraycontrollers[controller['@odata.id']] = _redfishobj.get(controller['@odata.id']).\
obj
sys.stdout.write("Encryption Properties for Smart Storage Array Controller \'%s\' : \n" \
% smartarraycontrollers[controller['@odata.id']].get('Id'))
for data in smartarraycontrollers[controller['@odata.id']]:
if data in desired_properties:
sys.stdout.write("\t %s : %s\n" % (data, smartarraycontrollers[controller\
['@odata.id']].get(data)))
|
Response Example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | {
"@odata.context": "/redfish/v1/$metadata#HpeESKM.HpeESKM",
"@odata.etag": "W/\"87058EB1\"",
"@odata.id": "/redfish/v1/Managers/1/SecurityService/ESKM/",
"@odata.type": "#HpeESKM.v2_0_0.HpeESKM",
"Actions": {
"#HpeESKM.ClearESKMLog": {
"target": "/redfish/v1/Managers/1/SecurityService/ESKM/Actions/HpeESKM.ClearESKMLog/"
},
"#HpeESKM.TestESKMConnections": {
"target": "/redfish/v1/Managers/1/SecurityService/ESKM/Actions/HpeESKM.TestESKMConnections/"
}
},
"Id": "ESKM",
"KeyManagerConfig": {
"AccountGroup": "",
"AccountName": "ilo-98f2b3217b48",
"ESKMLocalCACertificateName": "",
"ImportedCertificateIssuer": "",
"ImportedCertificateSubject": ""
},
"KeyServerRedundancyReq": false,
"PrimaryKeyServerAddress": null,
"PrimaryKeyServerPort": null,
"SecondaryKeyServerAddress": null,
"SecondaryKeyServerPort": null
}
|
Import SSL Certificate¶
Import Secure Socket Layer Certificate.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | def import_ssl(_redfishobj, ssl_file_path):
https_cert_uri = None
body = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links['SecurityService']\
['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
https_cert_uri = security_service_response.obj.Links['HttpsCert']['@odata.id']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#HpeHttpsCert.' in instance['@odata.type']:
https_cert_uri = instance['@odata.id']
break
if https_cert_uri:
https_cert_import_uri = _redfishobj.get(https_cert_uri).obj['Actions']\
['#HpeHttpsCert.ImportCertificate']['target']
body = dict()
body["Action"] = "HpeHttpsCert.ImportCertificate"
body["Certificate"] = ssl_cert
resp = _redfishobj.post(https_cert_import_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
print("\nImporting SSL Certificate may take a few minutes...\n "\
"iLO will reset with new changes.\n")
|
Modify iLO Management User Account¶
Modify a management interface user account.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | def modify_ilo_user_account(_redfishobj, username_to_modify, new_loginname, new_username, \
new_password, role_id, privilege_dict):
account_collection_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#resource directory is not available so we will navigate through paths manually to obtain
#account info
account_service_uri = _redfishobj.root.obj['AccountService']['@odata.id']
account_service_response = _redfishobj.get(account_service_uri)
account_collection_uri = account_service_response.obj['Accounts']['@odata.id']
#modify role id
if role_id:
body = {"RoleId": role_id}
else:
#obtain all account instances from resource directory
for instance in resource_instances:
if '#ManagerAccountCollection.' in instance['@odata.type']:
account_collection_uri = instance['@odata.id']
if privilege_dict:
#HPE server, so modify privileges
body = {"Oem": {"Hpe": {"Privileges": {}}}}
for priv in privilege_dict:
body["Oem"]["Hpe"]["Privileges"][priv] = privilege_dict[priv]
if new_loginname:
#modify login name
body["Oem"]["Hpe"]["LoginName"] = new_loginname
if new_username:
body["UserName"] = new_username
if new_password:
body["Password"] = new_password
#find the account to modify
account_uri_to_modify = None
account_uris = REDFISHOBJ.get(account_collection_uri)
for account_uri in account_uris.dict['Members']:
account = REDFISHOBJ.get(account_uri['@odata.id'])
if account.dict['UserName'] == username_to_modify:
account_uri_to_modify = account_uri['@odata.id']
break
if not account_uri_to_modify:
sys.stderr.write("Cannot find account to modify")
return
#modify the account
resp = REDFISHOBJ.patch(account_uri_to_modify, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended Message "\
"Info...")
elif resp.status != 200:
sys.stderr.write("An http response of '%s' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example¶
An example Redfish response error message.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.AccountModified"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Modify Virtual Media¶
Modify a virtual media entry.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | def mount_virtual_media_iso(_redfishobj, iso_url, media_type, boot_on_next_server_reset):
virtual_media_uri = None
virtual_media_response = []
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
virtual_media_uri = managers_members_response.obj['VirtualMedia']['@odata.id']
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#VirtualMediaCollection.' in instance['@odata.type']:
virtual_media_uri = instance['@odata.id']
if virtual_media_uri:
virtual_media_response = _redfishobj.get(virtual_media_uri)
for virtual_media_slot in virtual_media_response.obj['Members']:
data = _redfishobj.get(virtual_media_slot['@odata.id'])
if media_type in data.dict['MediaTypes']:
virtual_media_mount_uri = data.obj['Actions']['#VirtualMedia.InsertMedia']['target']
post_body = {"Image": iso_url}
if iso_url:
resp = _redfishobj.post(virtual_media_mount_uri, post_body)
if boot_on_next_server_reset is not None:
patch_body = {}
patch_body["Oem"] = {"Hpe": {"BootOnNextServerReset": \
boot_on_next_server_reset}}
boot_resp = _redfishobj.patch(data.obj['@odata.id'], patch_body)
if not boot_resp.status == 200:
sys.stderr.write("Failure setting BootOnNextServerReset")
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO"
"Extended Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
break
|
Response Example¶
An example Redfish response error message following a successful modification of a user account.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Reboot Server¶
Reboot a server.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | def reboot_server(_redfishobj):
systems_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_uri)
if systems_members_response:
system_reboot_uri = systems_members_response.obj['Actions']['#ComputerSystem.Reset']\
['target']
body = dict()
body['Action'] = 'ComputerSystem.Reset'
body['ResetType'] = "ForceRestart"
resp = _redfishobj.post(system_reboot_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example¶
An example Redfish response error message following a successful application of virtual media.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Remove an iLO User Management Account¶
Delete an iLO User Management Account
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | def reboot_server(_redfishobj):
systems_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
else:
for instance in resource_instances:
#Use Resource directory to find the relevant URI
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_uri)
if systems_members_response:
system_reboot_uri = systems_members_response.obj['Actions']['#ComputerSystem.Reset']\
['target']
body = dict()
body['Action'] = 'ComputerSystem.Reset'
body['ResetType'] = "ForceRestart"
resp = _redfishobj.post(system_reboot_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example¶
An example Redfish response error message following a successful application of virtual media.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Reset ESKM Event log¶
Reset Enterprise Secure Key Manager event log.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | def reset_ESKM_eventlog(_redfishobj):
body = dict()
security_service_eskm_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links\
['SecurityService']['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
security_service_eskm_uri = security_service_response.obj.Links['ESKM']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeESKM.' in instance['@odata.type']:
security_service_eskm_uri = instance['@odata.id']
break
if security_service_eskm_uri:
security_service_eskm_uri = _redfishobj.get(security_service_uri).obj.Links\
['ESKM']['@odata.id']
security_service_eskm_resp = _redfishobj.get(security_service_eskm_uri)
security_service_eskm_clearlog_uri = security_service_eskm_resp.obj['Actions']\
['#HpeESKM.ClearESKMLog']['target']
body["Action"] = "HpeESKM.ClearESKMLog"
#We pass the URI and the dictionary as a POST command (part of the redfish object)
resp = _redfishobj.post(security_service_eskm_clearlog_uri, body)
#If iLO responds with something outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example¶
An example Redfish response error message following a successful reset of ESKM log.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Reset iLO¶
Reset iLO BMC.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | def reset_ilo(_redfishobj):
managers_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#Manager.' in instance['@odata.type']:
managers_members_uri = instance['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
if managers_members_response:
reset_ilo_uri = managers_members_response.obj['Actions']['#Manager.Reset']['target']
body = {'Action': 'Manager.Reset'}
resp = _redfishobj.post(reset_ilo_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended Message "\
"Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example¶
An example Redfish response error message following a successful reset of iLO.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "iLO.2.14.ResetInProgress"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Sessions¶
Example of session management.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | def sessions(_redfishobj, login_account, login_password):
new_session = {"UserName": login_account, "Password": login_password}
response = _redfishobj.post('/redfish/v1/Sessions', new_session)
if response.status == 201:
print("Success!\n")
session_uri = response.getheader("location")
session_uri = urllib.parse.urlparse(session_uri)
sys.stdout.write("\tSession " + session_uri.path + " created.\n")
x_auth_token = response.getheader("x-auth-token")
sys.stdout.write("\tThis is the session X-Auth Token key " + x_auth_token + ".\n")
print(json.dumps(response.dict, indent=4, sort_keys=True))
# Delete the created session
sys.stdout.write("\tTerminating this session.\n")
sessresp = _redfishobj.delete(session_uri.path)
print(json.dumps(sessresp.dict, indent=4, sort_keys=True))
else:
sys.stderr.write("ERROR: failed to create a session.\n")
try:
print(json.dumps(sessresp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended"
" Message Info...")
|
Session Creation¶
Session token and URI. Session tokens can be cached and used for authentication for all subsequent calls as long as the session has not been terminated by the client or timed out by the server.
Note
This is only true in production mode. Some higher security modes may require additional authentication techniques to be performed.
Session X-Auth Token: 61ac3d750eeda276749cdd2138117a8f
Session URI: /redfish/v1/SessionService/Sessions/admin000000005f3d4cbfdbde43a8
An example Redfish response error message following a successful creation.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | {
"@odata.context": "/redfish/v1/$metadata#Session.Session",
"@odata.etag": "W/\"F1F51DF3\"",
"@odata.id": "/redfish/v1/SessionService/Sessions/admin000000005f3d4cbfdbde43a8",
"@odata.type": "#Session.v1_0_0.Session",
"Description": "Manager User Session",
"Id": "admin000000005f3d4cbfdbde43a8",
"Name": "User Session",
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeiLOSession.HpeiLOSession",
"@odata.type": "#HpeiLOSession.v2_1_0.HpeiLOSession",
"AccessTime": "2020-08-19T16:01:03Z",
"LoginTime": "2020-08-19T16:01:03Z",
"MySession": false,
"UserExpires": "2020-08-19T16:31:03Z",
"UserIP": "16.214.34.25",
"UserTag": "REST",
"UserType": "Local"
}
},
"UserName": "admin"
}
|
Session Creation¶
Terminating a session from the client side simply requires deletion of the session URI. Attempting to re-access the session results in the following response message.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.NoValidSession"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
iLO Management NIC Data¶
Example of ethernet management NIC enablement/disablement. On iLO systems: * Ethernet Management Interface 1 is typically the physical NIC port * Ethernet Management Interface 2 is typically the shared NIC interface. ** Shared physical System/iLO NIC. ** iLO USB port (requires the use of a USB to NIC adapter) * Ethernet Management Interface 3 is typically the virtual NIC interface. This is generally PnP with a supported Kernel/kernel virtual usb drivers.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | def set_active_ilo_nic(_redfishobj):
ethernet_data = {}
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
manager_ethernet_interfaces = managers_members_response.obj['EthernetInterfaces']\
['@odata.id']
manager_ethernet_interfaces_response = _redfishobj.get(manager_ethernet_interfaces)
manager_ethernet_interfaces_members = manager_ethernet_interfaces_response.\
obj['Members']
for _member in manager_ethernet_interfaces_members:
_tmp = _redfishobj.get(_member['@odata.id']).obj
ethernet_data[_member['@odata.id']] = _tmp
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#EthernetInterfaceCollection.' in instance['@odata.type'] and 'Managers' in \
instance['@odata.id']:
ethernet_uri = instance['@odata.id']
ethernet_interfaces = _redfishobj.get(ethernet_uri).obj['Members']
for _ethernet_interface in ethernet_interfaces:
ethernet_data[_ethernet_interface['@odata.id']] = _redfishobj.\
get(_ethernet_interface['@odata.id']).dict
break
if ethernet_data:
print("\n\nShowing all available ethernet management interfaces before changes:\n\n")
for interface in ethernet_data:
sys.stdout.write("Ethernet Management Inteface \'%s\'\n" % ethernet_data\
[interface].get('Id'))
sys.stdout.write("\t\'Interface Enabled\': %s\n" % ethernet_data[interface].\
get('InterfaceEnabled'))
for ethernet in ethernet_data:
sys.stdout.write("Ethernet Interface: %s\n" % ethernet)
ans = input("Would you like to enable/disable this interface? (enable/disable)\n")
if "en" in ans:
body = {"InterfaceEnabled": True}
else:
body = {"InterfaceEnabled": False}
resp = _redfishobj.patch(ethernet, body)
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success! You will need to reset iLO for this change to take effect.\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
BIOS iSCSI¶
Configure iSCSI (Internet Small Computer Systems Interface) for ip based network attached storage.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | def set_bios_iscsi(_redfishobj, iscsi_properties):
iscsi_uri = None
iscsi_data = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
bios_uri = systems_members_response.obj['Bios']['@odata.id']
bios_response = _redfishobj.get(bios_uri)
iscsi_uri = bios_response.obj.Oem.Hpe.Links['iScsi']['@odata.id']
iscsi_data = _redfishobj.get(iscsi_uri)
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeiSCSISoftwareInitiator.' in instance['@odata.type']:
iscsi_uri = instance['@odata.id']
iscsi_data = _redfishobj.get(iscsi_uri)
if iscsi_data:
for indx, inst in enumerate(iscsi_data.obj['iSCSISources']):
if iscsi_properties['iSCSIBootInstance'] == indx:
iscsi_data.dict['iSCSISources'][indx].update(iscsi_properties)
resp = _redfishobj.patch(iscsi_uri, {'iSCSISources' : iscsi_data.dict['iSCSISources']})
#If iLO responds with soemthing outside of 200 or 201 then lets check the
#iLO extended info error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], \
indent=4, sort_keys=True))
except Exception as excp:
print(json.dumps(resp.ori, indent=4, sort_keys=True))
sys.stderr.write("A response error occurred, unable to access iLO " \
"Extended Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success! A system reboot will be required to complete the change.\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
break
|
Response Example¶
Successful modification of iSCSI data.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "iLO.2.14.SystemResetRequired"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Set BIOS Password¶
Set BIOS Password.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | def set_bios_password(_redfishobj, new_password, bios_password):
bios_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
bios_uri = systems_members_response.obj['Bios']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#Bios.' in instance['@odata.type']:
bios_uri = instance['@odata.id']
break
if bios_uri:
bios_data = _redfishobj.get(bios_uri)
bios_change_pass_uri = bios_data.obj['Actions']['#Bios.ChangePassword']['target']
body = dict()
body["PasswordName"] = "Administrator"
body["OldPassword"] = bios_password
body["NewPassword"] = new_password
resp = _redfishobj.post(bios_change_pass_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example¶
Successful modification of BIOS password.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Set ESKM Primary Key¶
Set HPE Enterprise Secure Key Manager Key Manager Config.
Note
A valid ESKM key manager config is required and is tested upon patch submission. An error initializing ESKM may occur if the ESKM key manager or associated required properties are invalid. See ‘@Message.ExtendedInfo’ in the http response message.
{
"error": {
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information.",
"@Message.ExtendedInfo": [{
"MessageId": "iLO.2.14.ErrorIntializingESKM"
}]
}
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | def set_ESKM_PrimaryKeyServer(_redfishobj, primary_key_server_address, primary_key_server_port):
eskm_uri = None
body = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links['SecurityService']\
['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
eskm_uri = security_service_response.obj.Links['ESKM']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeESKM.' in instance['@odata.type']:
eskm_uri = instance['@odata.id']
break
if eskm_uri:
body["PrimaryKeyServerAddress"] = primary_key_server_address
body["PrimaryKeyServerPort"] = int(primary_key_server_port)
resp = _redfishobj.post(eskm_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Configure Ethernet Management NIC(s) for DHCP/Static Network Addressing.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | def set_ilo_static_ipv4(_redfishobj, ipv4_dict, dns_dict):
ethernet_data = {}
body = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
manager_ethernet_interfaces = managers_members_response.obj['EthernetInterfaces']\
['@odata.id']
manager_ethernet_interfaces_response = _redfishobj.get(manager_ethernet_interfaces)
manager_ethernet_interfaces_members = manager_ethernet_interfaces_response.\
obj['Members']
for _member in manager_ethernet_interfaces_members:
_tmp = _redfishobj.get(_member['@odata.id']).obj
ethernet_data[_member['@odata.id']] = _tmp
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#EthernetInterfaceCollection.' in instance['@odata.type'] and 'Managers' in \
instance['@odata.id']:
ethernet_uri = instance['@odata.id']
ethernet_interfaces = _redfishobj.get(ethernet_uri).obj['Members']
for _ethernet_interface in ethernet_interfaces:
ethernet_data[_ethernet_interface['@odata.id']] = _redfishobj.\
get(_ethernet_interface['@odata.id']).dict
break
if ethernet_data:
print("\n\nShowing all available ethernet management interfaces before changes:\n\n")
for interface in ethernet_data:
sys.stdout.write("Ethernet Management Inteface \'%s\'\n" % ethernet_data\
[interface].get('Id'))
sys.stdout.write("\'DHCPv4\':\n")
if ethernet_data[interface].get('DHCPv4'):
print(json.dumps(ethernet_data[interface].get('DHCPv4'), indent=4, sort_keys=True))
else:
print(json.dumps(ethernet_data[interface]['Oem']['Hpe'].get('DHCPv4'), indent=4, \
sort_keys=True))
sys.stdout.write("\'IPv4\':\n")
if ethernet_data[interface].get('IPv4StaticAddresses'):
print(json.dumps(ethernet_data[interface].get('IPv4Addresses'), indent=4, \
sort_keys=True))
sys.stdout.write("\'StaticNameServers\':\n")
if ethernet_data[interface].get('StaticNameServers'):
print(json.dumps(ethernet_data[interface].get('StaticNameServers'), indent=4, \
sort_keys=True))
for ethernet in ethernet_data:
sys.stdout.write("Ethernet Interface: %s\n" % ethernet)
ans = input("Would you like to modify this interface? (y/n)\n")
if "n" in ans:
continue
if 'DHCPv4' in ethernet_data[ethernet]:
if ethernet_data[ethernet]['DHCPv4'].get('UseDNSServers'):
resp = _redfishobj.patch(ethernet, {"DHCPv4": {"UseDNSServers": False}})
ilo_response(_redfishobj, resp)
if ethernet_data[ethernet]['DHCPv4'].get('UseGateway'):
resp = _redfishobj.pathc(ethernet, {"DHCPv4": {"UseGateway": False}})
ilo_response(_redfishobj, resp)
if 'IPv4StaticAddresses' in ethernet_data[ethernet]:
body.update({"IPv4Addresses": [ipv4_dict]})
if 'StaticNameServers' in ethernet_data[ethernet]:
body.update({"StaticNameServers" : [dns_dict.get('PrimaryDNS'), \
dns_dict.get('SecondaryDNS')]})
else:
body.update({"Oem": {"Hpe": {"IPv4": {"DNSServers": [dns_dict.get('PrimaryDNS'), \
dns_dict.get('SecondaryDNS')]}}}})
resp = _redfishobj.patch(ethernet, body)
ilo_response(_redfishobj, resp)
break
|
Set iLO NTP Server Settings¶
Configure NTP Server Settings.
Note
The physical or shared ethernet networking adapter must be configured with ‘StaticNTPServers’:’True’, if static network time protocol servers are to be used. DHCP must also be disabled. The following is an error message which will occur in the event DHCP is enabled while attempting to configure static NTP server entries.
{
"MessageArgs": [
"StaticNTPServers"
],
"MessageId": "iLO.2.14.SNTPConfigurationManagedByDHCPAndIsReadOnly"
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | def set_ilo_ntp_servers(_redfishobj, ntp_server_list):
date_time_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
date_time_uri = managers_members_response.obj.Oem.Hpe.Links['DateTimeService']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeiLODateTime.' in instance['@odata.type']:
date_time_uri = instance['@odata.id']
if date_time_uri:
data = _redfishobj.get(date_time_uri)
if data.dict.get('StaticNTPServers'):
resp = _redfishobj.patch(date_time_uri, {'StaticNTPServers': ntp_server_list})
else:
raise Exception("\'StaticNTPServers\' property is not available/modifyable.\n")
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended " \
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
ntp_data = _redfishobj.get(date_time_uri).dict.get('StaticNTPServers')
print("Printing updated NTP Servers:\n")
print(json.dumps(ntp_data, indent=4, sort_keys=True))
|
Response Example¶
Successful modification of StaticNTPServers. (Only displaying response from iLODateTime)
Set Timezone¶
Configure Network Time Protocol Time zone.
Note
DHCP must be disabled. The following is an error message which will occur in the event DHCP is enabled while attempting to modify the NTP timezone.
{
"MessageArgs": [
"StaticNTPServers"
],
"MessageId": "iLO.2.14.SNTPConfigurationManagedByDHCPAndIsReadOnly"
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | def set_timezone(_redfishobj, timezone):
date_time_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
date_time_uri = managers_members_response.obj.Oem.Hpe.Links['DateTimeService']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeiLODateTime.' in instance['@odata.type']:
date_time_uri = instance['@odata.id']
if date_time_uri:
data = _redfishobj.get(date_time_uri)
if data.dict.get('TimeZone'):
_data = {'TimeZone': {"Name": timezone}}
resp = _redfishobj.patch(date_time_uri, _data)
else:
raise Exception("\'TimeZone\' property is not available/modifyable.\n")
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
print(json.dumps(data.obj.get('TimeZoneList'), indent=4, sort_keys=True))
sys.stderr.write("Check the TimeZone value...\n")
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended " \
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
ntp_data = _redfishobj.get(date_time_uri).dict.get('TimeZone')
print("Printing updated NTP Servers:\n")
print(json.dumps(ntp_data, indent=4, sort_keys=True))
|
Response Example¶
Successful modification of iLO timezone.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Configure iLO License Key¶
Configure iLO License Key.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | def set_license_key(_redfishobj, ilo_key):
ilo_lic_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
ilo_lic_uri = managers_members_response.obj.Oem.Hpe.Links['LicenseService']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeiLOLicense.' in instance['@odata.type']:
ilo_lic_uri = instance['@odata.id']
if ilo_lic_uri:
ilo_license_collection = _redfishobj.get(ilo_lic_uri)
ilo_license_member_uri = next(iter(ilo_license_collection.obj['Members']))['@odata.id']
try:
ilo_license_data = _redfishobj.get(ilo_license_member_uri).obj['ConfirmationRequest']\
['EON']
except KeyError:
sys.stdout.write("This machine will not show the full License Key.\n")
ilo_license_data = _redfishobj.get(ilo_license_member_uri).obj['LicenseKey']
sys.stdout.write("Current iLO License Data:\n")
print(json.dumps(ilo_license_data, indent=4, sort_keys=True))
resp = _redfishobj.post(ilo_lic_uri, {'LicenseKey' : ilo_key})
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
sys.stderr.write("Check the validity of your license key...\n")
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO " \
"Extended Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example Valid¶
Successful addition/modification of iLO license key.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Response Example Invalid¶
An invalid iLO license key.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "iLO.2.14.InvalidLicenseKey"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Server Asset Tag¶
Configure Redfish asset tag.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | def set_server_asset_tag(_redfishobj, tag):
systems_members_uri = None
systems_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
if systems_members_response and systems_members_uri and tag:
print("Current Asset Tag: \'%s\'\n" % systems_members_response.dict.get("AssetTag"))
resp = _redfishobj.patch(systems_members_uri, {"AssetTag" : tag})
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
time.sleep(10) #going to wait 10 seconds before obtaining the LED indicator state
sys.stdout.write("\nUpdated Asset Tag: \'%s\'\n" % _redfishobj.\
get(systems_members_uri).dict.get("AssetTag"))
|
Response Example¶
Successful addition/modification of Redfish asset tag.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Server UID Light¶
Configure System Unit Identification Light as either ‘Lit’ or ‘Off’.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | def set_uid_light(_redfishobj):
body = dict()
systems_members_uri = None
systems_members_response = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
systems_uri = _redfishobj.root.obj['Systems']['@odata.id']
systems_response = _redfishobj.get(systems_uri)
systems_members_uri = next(iter(systems_response.obj['Members']))['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#ComputerSystem.' in instance['@odata.type']:
systems_members_uri = instance['@odata.id']
systems_members_response = _redfishobj.get(systems_members_uri)
if systems_members_response and systems_members_uri:
print("Current Indicator LED Status: \'%s\'\n" % systems_members_response.dict.\
get("IndicatorLED"))
if "Off" in systems_members_response.dict.get("IndicatorLED"):
print("Will illuminate indicator LED.\n")
body["IndicatorLED"] = "Lit"
else:
print("Will extinguish indicator LED.\n")
body["IndicatorLED"] = "Off"
resp = _redfishobj.patch(systems_members_uri, body)
#If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
time.sleep(10) #going to wait 10 seconds before obtaining the LED indicator state
sys.stdout.write("\nUpdated Indicator LED Status: \'%s\'\n" % _redfishobj.\
get(systems_members_uri).dict['IndicatorLED'])
|
Response Example¶
Successful addition/modification of UID light.
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "Base.1.4.Success"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Server Firmware Inventory¶
List all iLO onboard device firmware.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | def get_inventory_uri(_redfishobj, select):
update_service_uri = None
inventory_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
update_service_uri = _redfishobj.root.obj['UpdateService']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#UpdateService.' in instance['@odata.type']:
update_service_uri = instance['@odata.id']
if update_service_uri:
update_service_resp = _redfishobj.get(update_service_uri)
if "software" in select.lower():
inventory_uri = update_service_resp.obj['SoftwareInventory']['@odata.id']
elif "firmware" in select.lower():
inventory_uri = update_service_resp.obj['FirmwareInventory']['@odata.id']
else:
raise Exception("Invalid selection provided: Please select 'software' or 'firmware' " \
"to obtain the relevant invetory data.")
sys.stdout.write("Printing data in invetory: %s\n" % inventory_uri)
get_inventory(_redfishobj, inventory_uri)
|
Response Example¶
Snippet of Firmware Inventory Response.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | [
{
"@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
"@odata.etag": "W/\"0539D502\"",
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/15/",
"@odata.type": "#SoftwareInventory.v1_0_0.SoftwareInventory",
"Description": "102b0538159000e4",
"Id": "15",
"Name": "Embedded Video Controller",
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeiLOSoftwareInventory.HpeiLOSoftwareInventory",
"@odata.type": "#HpeiLOSoftwareInventory.v2_0_0.HpeiLOSoftwareInventory",
"DeviceClass": null,
"DeviceContext": "Embedded Device",
"DeviceInstance": "PciRoot(0x0)/Pci(0x1C,0x4)/Pci(0x0,0x1)",
"Targets": [
"a6b1a447-382a-5a4f-102b-0538159000e4"
]
}
},
"Version": "2.5"
},
{
"@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
"@odata.etag": "W/\"0539D502\"",
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/13/",
"@odata.type": "#SoftwareInventory.v1_0_0.SoftwareInventory",
"Description": "14e41657103c22be",
"Id": "13",
"Name": "HPE Ethernet 1Gb 4-port 331i Adapter - NIC",
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeiLOSoftwareInventory.HpeiLOSoftwareInventory",
"@odata.type": "#HpeiLOSoftwareInventory.v2_0_0.HpeiLOSoftwareInventory",
"DeviceClass": null,
"DeviceContext": "Embedded LOM",
"DeviceInstance": "PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)",
"Targets": [
"a6b1a447-382a-5a4f-14e4-1657103c22be"
]
}
},
"Version": "20.6.61"
}
]
|
Test ESKM Connectivity¶
Test HPE Enterprise Secure Key Manager connectivity.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | def test_ESKM_connection(_redfishobj):
eskm_uri = None
body = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links['SecurityService']\
['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
eskm_uri = security_service_response.obj.Links['ESKM']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeESKM.' in instance['@odata.type']:
eskm_uri = instance['@odata.id']
break
if eskm_uri:
eskm_test_conn_uri = _redfishobj.get(eskm_uri).obj['Actions']\
['#HpeESKM.TestESKMConnections']['target']
body["Action"] = "HpeESKM.TestESKMConnections"
resp = _redfishobj.post(eskm_test_conn_uri, body)
#If iLO responds with something outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example Not Configured¶
Response of a failed test ESKM connection action. (ESKM not properly configured)
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "iLO.2.14.ESKMServersNotConfigured"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Test ESKM Connectivity¶
Test HPE Enterprise Secure Key Manager connectivity.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | def test_ESKM_connection(_redfishobj):
eskm_uri = None
body = dict()
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
managers_uri = _redfishobj.root.obj['Managers']['@odata.id']
managers_response = _redfishobj.get(managers_uri)
managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']
managers_members_response = _redfishobj.get(managers_members_uri)
security_service_uri = managers_members_response.obj.Oem.Hpe.Links['SecurityService']\
['@odata.id']
security_service_response = _redfishobj.get(security_service_uri)
eskm_uri = security_service_response.obj.Links['ESKM']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#HpeESKM.' in instance['@odata.type']:
eskm_uri = instance['@odata.id']
break
if eskm_uri:
eskm_test_conn_uri = _redfishobj.get(eskm_uri).obj['Actions']\
['#HpeESKM.TestESKMConnections']['target']
body["Action"] = "HpeESKM.TestESKMConnections"
resp = _redfishobj.post(eskm_test_conn_uri, body)
#If iLO responds with something outside of 200 or 201 then lets check the iLO extended info
#error message to see what went wrong
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, \
sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.dict, indent=4, sort_keys=True))
|
Response Example Not Configured¶
Response of a failed test ESKM connection action. (ESKM not properly configured)
1 2 3 4 5 6 7 8 9 10 11 | {
"error": {
"@Message.ExtendedInfo": [
{
"MessageId": "iLO.2.14.ESKMServersNotConfigured"
}
],
"code": "iLO.0.10.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
|
Update iLO Firmware¶
Process for a client to invoke a simple update of iLO firmware. Firmware is intended to be hosted and gathered by iLO by pointing to a URL for iLO to consume. A valid URL will result in an http 202 response code; however, this only indicates iLO will separately handle both downloading and processing the firmware update. The client will need to separately poll for status information regarding the update progress.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | def update_ilo_firmware(_redfishobj, fw_url, tpm_flag):
body = dict()
update_service_uri = None
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#if we do not have a resource directory or want to force it's non use to find the
#relevant URI
update_service_uri = _redfishobj.root.obj['UpdateService']['@odata.id']
else:
#Use Resource directory to find the relevant URI
for instance in resource_instances:
if '#UpdateService.' in instance['@odata.type']:
update_service_uri = instance['@odata.id']
break
if update_service_uri and fw_url:
update_uri = _redfishobj.get(update_service_uri).obj['Actions']\
['#UpdateService.SimpleUpdate']['target']
body["ImageURI"] = fw_url
if tpm_flag:
body["TPMOverrideFlag"] = tpm_flag
resp = _redfishobj.post(update_uri, body)
if resp.status == 400:
try:
print(json.dumps(resp.obj['error']\
['@Message.ExtendedInfo'], indent=4, sort_keys=True))
except Exception as excp:
sys.stderr.write("A response error occurred, unable to access iLO Extended "\
"Message Info...")
elif resp.status != 200:
sys.stderr.write("An http response of \'%s\' was returned.\n" % resp.status)
else:
print("Success!\n")
print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))
|
Upload firmware to iLO Repository¶
Upload firmware to iLO’s Absaroka flash based repository. Firmware can be stored and catalogued, to be used at a later date or in the need to recover the platform from a failure condition. An http response code of 200 will be supplied upon completion of a successful upload; no other extended message information is provided.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | def upload_firmware(_redfishobj, firmware_loc, update_repo=True, update_target=False):
resource_instances = get_resource_directory(_redfishobj)
if DISABLE_RESOURCE_DIR or not resource_instances:
#resource directory is not available so we will navigate through paths manually
update_service_uri = _redfishobj.root.obj['UpdateService']['@odata.id']
else:
#obtain all account instances from resource directory
for instance in resource_instances:
if '#UpdateService.' in instance['@odata.type']:
update_service_uri = instance['@odata.id']
update_service_response = _redfishobj.get(update_service_uri)
path = update_service_response.obj.HttpPushUri
body = []
json_data = {'UpdateRepository': update_repo, 'UpdateTarget': update_target, 'ETag': 'atag', 'Section': 0}
session_key = _redfishobj.session_key
filename = os.path.basename(firmware_loc)
with open(firmware_loc, 'rb') as fle:
output = fle.read()
session_tuple = ('sessionKey', session_key)
parameters_tuple = ('parameters', json.dumps(json_data))
file_tuple = ('file', (filename, output, 'application/octet-stream'))
#Build the payload from each multipart-form data tuple
body.append(session_tuple)
body.append(parameters_tuple)
body.append(file_tuple)
#Create our header dictionary
header = {'Cookie': 'sessionKey=' + session_key}
#We pass the whole list payload to post
resp = _redfishobj.post(path, body, headers=header)
if resp.status == 400:
sys.stderr.write("Failed to upload firmware...")
elif not resp.status in [200, 201]:
sys.stderr.write("An http response of '%s' was returned.\n" % resp.status)
else:
print("Upload complete!\n")
|