wti.remote.cpm_config_backup – Get parameters from WTI OOB and PDU devices

Note

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

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

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

New in version 2.9: of wti.remote

Synopsis

• Get parameters from WTI OOB and PDU devices

Parameters

Parameter	Choices/Defaults	Comments
cpm_password string / required		This is the Password of the WTI device to get the parameters from.
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 get the parameters from.
cpm_username string / required		This is the Username of the WTI device to get the parameters from.
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

-   name: Get the Parameters for a WTI device
    cpm_config_backup:
        cpm_url: "nonexist.wti.com"
        cpm_username: "super"
        cpm_password: "super"
        use_https: true
        validate_certs: false

Return Values

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

Key		Returned	Description
data complex		always	The XML configuration of the WTI device queried
	status list / elements=string	success	List of status returns from backup operation Sample: [{'code': 0, 'savedfilename': '/tmp/wti-192-10-10-239-2020-02-13T16-05-57.xml', 'text': 'ok'}]

Authors

• Western Telematic Inc. (@wtinetworkgear)