You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

wti.remote.cpm_hostname_info – Get Hostname (Site ID), Location, Asset Tag 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_hostname_info.

New in version 2.11: of wti.remote

Synopsis

• Get Hostname (Site ID), Location, Asset Tag parameters from WTI OOB and PDU devices

Parameters

Parameter	Comments
cpm_password string / required	This is the Password of the WTI device to send the module.
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.
use_https boolean	Designates to use an https connection or http connection. Choices: no yes ← (default)
use_proxy boolean	Flag to control if the lookup will observe HTTP proxy environment variables when present. Choices: no ← (default) yes
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: no yes ← (default)

Notes

Note

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

Examples

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

- name: Get the Hostname parameters for a WTI device
  cpm_hostname_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: false
    validate_certs: false

Return Values

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

Key	Description
data complex	The output JSON returned from the commands sent Returned: always
assettag integer	Current Asset Tag of the WTI device after module execution. Returned: success Sample: “irvine92395”
hostname string	Current Hostname (Site-ID) of the WTI device after module execution. Returned: success Sample: “myhostname”
location integer	Current Location of the WTI device after module execution. Returned: success Sample: “Irvine”
timestamp string	Current timestamp of the WTI device after module execution. Returned: success Sample: “2021-08-17T21:33:50+00:00”

Authors

• Western Telematic Inc. (@wtinetworkgear)