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

Note

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

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_config_backup.

New in wti.remote 2.9.0

Synopsis

  • Get parameters from WTI OOB and PDU devices

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('wti.remote.cpm_config_backup', key1=value1, key2=value2, ...) and query('wti.remote.cpm_config_backup', key1=value1, key2=value2, ...)

Parameter

Comments

cpm_password

string / required

This is the Password of the WTI device to get the parameters from.

cpm_path

string

This is the directory path to store the WTI device configuration file.

Default: "/tmp/"

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

Designates to use an https connection or http connection.

Choices:

  • false

  • true ← (default)

use_proxy

boolean

Flag to control if the lookup will observe HTTP proxy environment variables when present.

Choices:

  • false ← (default)

  • true

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used

on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

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 Value

Key

Description

data

complex

The XML configuration of the WTI device queried

Returned: always

status

list / elements=string

List of status returns from backup operation

Returned: success

Sample: [{"code": 0, "savedfilename": "/tmp/wti-192-10-10-239-2020-02-13T16-05-57.xml", "text": "ok"}]

Authors

  • Western Telematic Inc. (@wtinetworkgear)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.