upload_firmware_ilo_repository.py example not working on a local connection?

[bickfordc]

The upload_firmware_ilo_repository.py example does not appear to work when a local connection is used. (running from the same server using the CHIF driver)

When using these lines, and commenting the other lines specifying actual system_url, account, and password:

 SYSTEM_URL = None
 LOGIN_ACCOUNT = None
 LOGIN_PASSWORD = None

it appears that the rest_request() method of Blobstore2Connection is hit, rather than the rest_request method of HttpConnection.

this line results in a TypeError: Object of type bytes is not JSON serializable from the json module. Here's a trace. I have version 3.6.0.0 installed, but it looks like there has been no change in that area anyway.

Traceback (most recent call last):
  File "/tmp/upload_firmware_ilo_repository.py", line 111, in <module>
    upload_firmware(REDFISHOBJ, FIRMWARE_PATH, UPDATE_REPO, UPDATE_TARGET)
  File "/tmp/upload_firmware_ilo_repository.py", line 66, in upload_firmware
    resp = _redfishobj.post(path, body, headers=header)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/redfish/rest/v1.py", line 174, in post
    return self.connection.rest_request(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/redfish/rest/connections.py", line 437, in rest_request
    body = json.dumps(body)
           ^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/__init__.py", line 231, in dumps
    return _default_encoder.encode(obj)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/encoder.py", line 200, in encode
    chunks = self.iterencode(o, _one_shot=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/encoder.py", line 258, in iterencode
    return _iterencode(o, 0)
           ^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/encoder.py", line 180, in default
    raise TypeError(f'Object of type {o.__class__.__name__} '
TypeError: Object of type bytes is not JSON serializable

Is this a known issue or am I missing something? Athough I don't thinks it's related, I did have to comment this import from get_resource_directory import get_resource_directory

and set resources_instances = None because I don't have a get_resource_directory module installed. I have the python3-ilorest package from the Debian bookworm distro, and can't easily move away from that for other reasons. Here's my upload_firmware_ilo_repository.py script:

 # Copyright 2020 Hewlett Packard Enterprise Development LP
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may
 # not use this file except in compliance with the License. You may obtain
 # a copy of the License at
 #
 #      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.

# -*- coding: utf-8 -*-
"""
An example of uploading firmware to the iLO Repository for flashing
"""

import os
import sys
import json
from redfish import RedfishClient
from redfish.rest.v1 import ServerDownOrUnreachableError

#from get_resource_directory import get_resource_directory

def upload_firmware(_redfishobj, firmware_loc, update_repo=True, update_target=False):
    resources_instances = 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
        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")

if __name__ == "__main__":
    # When running on the server locally use the following commented values
    SYSTEM_URL = None
    LOGIN_ACCOUNT = None
    LOGIN_PASSWORD = None

    # When running remotely connect using the secured (https://) address,
    # account name, and password to send https requests
    # SYSTEM_URL acceptable examples:
    # "https://10.0.0.0"
    # "https://ilo.hostname"
    #SYSTEM_URL = "https://16.83.61.104"
    #LOGIN_ACCOUNT = "admin"
    #LOGIN_PASSWORD = "password"

    # The path to the firmware file to upload
    FIRMWARE_PATH = "/tmp/ilo5_301_p10.fwpkg"
    # Upload the firmware file to the iLO Repository
    UPDATE_REPO = True
    # Update the system with the firmware file
    UPDATE_TARGET = False

    # flag to force disable resource directory. Resource directory and associated operations are
    # intended for HPE servers.
    DISABLE_RESOURCE_DIR = True

    try:
        # Create a Redfish client object
        REDFISHOBJ = RedfishClient(base_url=SYSTEM_URL, username=LOGIN_ACCOUNT, \
                                                                            password=LOGIN_PASSWORD)
        # Login with the Redfish client
        REDFISHOBJ.login()
    except ServerDownOrUnreachableError as excp:
        sys.stderr.write("ERROR: server not reachable or does not support RedFish.\n")
        sys.exit()

    upload_firmware(REDFISHOBJ, FIRMWARE_PATH, UPDATE_REPO, UPDATE_TARGET)

    REDFISHOBJ.logout()

[sahanaramavana]

Hi ,

Thanks for writing to us , we shall have a look at it .

Meanwhile could you also verify it on latest library available and let us know the result .

Thanks & Regards, Sahana

[bickfordc]

Reproduces with the latest python-ilorest-library, version 4.8.0.0

(venv) # pip list
Package                Version
---------------------- -------
attrs                  23.2.0
decorator              5.1.1
jsonpatch              1.33
jsonpath-rw            1.4.0
jsonpointer            2.4
pip                    23.0.1
ply                    3.11
python-ilorest-library 4.8.0.0
referencing            0.33.0
rpds-py                0.18.0
setuptools             66.1.1
six                    1.16.0
urllib3                2.2.1
wheel                  0.38.4

(venv) # python3 upload_firmware_ilo_repository.py
Traceback (most recent call last):
  File "/usr/local/venv/upload_firmware_ilo_repository.py", line 111, in <module>
    upload_firmware(REDFISHOBJ, FIRMWARE_PATH, UPDATE_REPO, UPDATE_TARGET)
  File "/usr/local/venv/upload_firmware_ilo_repository.py", line 66, in upload_firmware
    resp = _redfishobj.post(path, body, headers=header)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venv/lib/python3.11/site-packages/redfish/rest/v1.py", line 178, in post
    return self.connection.rest_request(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venv/lib/python3.11/site-packages/redfish/rest/connections.py", line 452, in rest_request
    body = json.dumps(body)
           ^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/__init__.py", line 231, in dumps
    return _default_encoder.encode(obj)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/encoder.py", line 200, in encode
    chunks = self.iterencode(o, _one_shot=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/encoder.py", line 258, in iterencode
    return _iterencode(o, 0)
           ^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/json/encoder.py", line 180, in default
    raise TypeError(f'Object of type {o.__class__.__name__} '
TypeError: Object of type bytes is not JSON serializable

[rajkumar14]

@bickfordc This script only supports remote updates and does not support local operations. For local updates, you can use the 'ilorest' tool. To perform local updates the recommended approach is to utilize the 'ilorest' tool.

[bickfordc]

Ok thanks. I did work around the problem by using the ilorest tool, but was just hoping it would be possible to use the python-ilorest library directly. I'll close the issue.