wti.remote.cpm_hostname_config – Set 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_config.

New in version 2.11: of wti.remote

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
assettag
string
This is the Asset Tag to be set for the WTI OOB and PDU device.
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.
hostname
string
This is the Hostname (Site-ID) tag to be set for the WTI OOB and PDU device.
location
string
This is the Location tag to be set for the WTI OOB and PDU device.
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

# Set Hostname, Location and Site-ID variables of a WTI device
- name: Set known fixed hostname variables of a WTI device
  cpm_time_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    hostname: "myhostname"
    location: "Irvine"
    assettag: "irvine92395"

# Set the Hostname variable of a WTI device
- name: Set the Hostname of a WTI device
  cpm_time_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    hostname: "myhostname"

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 JSON returned from the commands sent

 
assettag
integer
success
Current Asset Tag of the WTI device after module execution.

Sample:
irvine92395
 
hostname
string
success
Current Hostname (Site-ID) of the WTI device after module execution.

Sample:
myhostname
 
location
integer
success
Current Location of the WTI device after module execution.

Sample:
Irvine
 
timestamp
string
success
Current timestamp of the WTI device after module execution.

Sample:
2021-08-17T21:33:50+00:00


Authors

  • Western Telematic Inc. (@wtinetworkgear)