wti.remote.cpm_firmware_update – Set Serial port parameters in WTI OOB and PDU devices

Note

This plugin is part of the wti.remote collection (version 1.0.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install wti.remote.

To use it in a playbook, specify: wti.remote.cpm_firmware_update.

New in version 2.9: of wti.remote

Synopsis

  • Set Serial port parameters in WTI OOB and PDU devices

Parameters

Parameter Choices/Defaults Comments
cpm_file
string
If a file is defined, this file will be used to update the WTI device.
cpm_password
string / required
This is the Password of the WTI device to send the module.
cpm_path
string
Default:
"/tmp/"
This is the directory path to store the WTI device configuration file.
cpm_url
string / required
This is the URL of the WTI device to send the module.
cpm_username
string / required
This is the Username of the WTI device to send the module.
family
integer
    Choices:
  • 0
  • 1
Default:
1
Force the download to both either Console (1) or Power (0)
removefileonexit
integer
    Choices:
  • 0
  • 1
Default:
1
After an upgrade, remove the upgrade OS image
use_force
boolean
    Choices:
  • no ←
  • yes
If set to True, the upgrade will happen even if the device doesnt need it.
use_https
boolean
    Choices:
  • no
  • yes ←
Designates to use an https connection or http connection.
use_proxy
boolean
    Choices:
  • no ←
  • yes
Flag to control if the lookup will observe HTTP proxy environment variables when present.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If false, SSL certificates will not be validated. This should only be used - on personally controlled sites using self-signed certificates.

Notes

Note

  • Use groups/cpm in module_defaults to set common options used between CPM modules.

Examples

# Upgrade the firmware of a WTI device
- name: Upgrade the firmware of a WTI device
  cpm_firmware_update:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false


# Upgrade the firmware of a WTI device and keep the download OS image after exit
- name: Upgrade the firmware of a WTI device and keep the download OS image after exit
  cpm_firmware_update:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    removefileonexit: "0"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data
complex
always
The output XML configuration of the WTI device being updated

 
filelength
integer
success
Length of the file uploaded in bytes

Sample:
[{'filelength': 329439}]
 
status
list / elements=string
success
List of status returns from backup operation

Sample:
[{'code': 0}, {'text': 'ok'}, {'unittimestamp': '2020-02-14T00:18:57+00:00'}]


Authors

  • Western Telematic Inc. (@wtinetworkgear)