redfish_utils: Add support for "nextLink" property tag pagination

[sseekamp]

SUMMARY

Add support for paginated responses in the _software_inventory method

Fixes #7011

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

redfish_utils

ADDITIONAL INFORMATION

Redfish supports a property in responses @odata.nextLink which indicates a partial set of data is returned (paginated response). The existing method would truncate the returned data with no indication items were missing from the response.

Running a normal firmware inventory task:

  - name: Collect Firmware Inventory
    community.general.redfish_info:
      category: Update
      command: GetFirmwareInventory
      baseuri: "{{ bmc_address }}"
      username: "{{ bmc_username }}"
      password: "{{ bmc_password }}"
    register: redfish_fw_inventory
    delegate_to: localhost

  - debug:
      msg: "{{ redfish_fw_inventory.redfish_facts.firmware.entries | length }}"

Would return:

TASK [debug] ****************************************************************************************************************************************************************************************************************************************************************************************************************************************************
task path: /home/sseekamp/Github/ansible-test/fi.yaml:20
ok: [x.x.x.x] => {
    "msg": "50"
}

which corresponded with the first page of response from a raw curl request:

...
  "Members@odata.count": 65,
  "Members@odata.nextLink": "/redfish/v1/UpdateService/FirmwareInventory?$skip=50",
  "Name": "Firmware Inventory Collection"
...

After the change:

TASK [debug] ****************************************************************************************************************************************************************************************************************************************************************************************************************************************************
task path: /home/sseekamp/Github/ansible-test/fi.yaml:20
ok: [x.x.x.x] => {
    "msg": "98"
}

which is the expected full collection of firmware inventory items.

[ansibullbot]

cc @Bhavya06 @jyundt @mraineri @rajeevkallur @renxulei @tomasg2012 @xmadsen
click here for bot help

[mraineri]

Looks good to me!

[ansibullbot]

@sseekamp This PR contains @ mentions in at least one commit message. Those mentions can cause cascading notifications through GitHub and need to be removed. Please squash or amend your commits to remove the mentions.

click here for bot help

[patchback]

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/b46d5d81973561354461c521d35f0d8e07f9cbab/pr-7020

Backported as #7026

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@sseekamp thanks for your contribution!
@mraineri thanks for reviewing!