zpe.zpecloud.software_upgrade (1.0.1) — module

Apply software upgrade operations on Nodegrid device enrolled in ZPE Cloud.

Authors: Daniel Nesvera (@zpe-dnesvera)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install zpe.zpecloud:==1.0.1


Add to requirements.yml

  collections:
    - name: zpe.zpecloud
      version: 1.0.1

Description

Apply software upgrade operation on Nodegrid devices enrolled in ZPE Cloud.

For software downgrade, it is necessary to set option allow_downgrade to True.

By default, module will fail if a device will be downgraded to prevent device from factory reset.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Software upgrade without allowing downgrade
- name: Software upgrade to NG OS v5.10.10
  zpe.zpecloud.software_upgrade:
    version: "5.10.10"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Software upgrade allowing possible downgrade of devices
- name: Software upgrade to NG OS v5.8.15
  zpe.zpecloud.software_upgrade:
    version: "5.8.15"
    allow_downgrade: true

Inputs

    
version:
    description:
    - Desired Nodegrid OS version for upgrade.
    - Nodegrid OS version follows pattern <major>.<minor>.<patch>
    required: true
    type: str

allow_downgrade:
    default: false
    description:
    - Flag to allow a device to be downgraded if target version is lower than current
      version.
    - This flag is disabled by default, and task will be skipped in case of downgrade.
    - Example of downgrade. upgrade to version 5.8.17 on a device running version 5.10.8.
    type: bool