W3cubDocs

/Ansible

wti.remote.cpm_status_info – Get general status information from WTI OOB and PDU devices

Note

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

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

New in version 2.9: of wti.remote

Synopsis

  • Get temperature general status from WTI OOB and PDU devices

Parameters

Parameter Choices/Defaults 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
    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 Status Information for a WTI device
  cpm_status_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

- name: Get the Status Information for a WTI device
  cpm_status_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 Returned Description
data
complex
always
The output JSON returned from the commands sent
analogmodemphonenumber
string
success
Current Analog Modem (if installed) Phone number of the WTI device.

Sample:
9495869959
apacheversion
string
success
Current Apache Web version running on the WTI device.

Sample:
2.4.41
apirelease
string
success
Current Date of the API release of the WTI device.

Sample:
March 2020
assettag
string
success
Current Asset Tag of the WTI device.

Sample:
ARTE121
cpu_boardprogramdate
string
success
Current Board and Program date of the WTI device.

Sample:
ARM, 4-30-2019
currentmonitor
string
success
Identifies if the unit has current monitoring capabilites.

Sample:
Yes
energywise
string
success
Current Energywise version of the WTI device.

Sample:
1.2.0
gig_dualphy
string
success
Identifies dual ethernet port and gigabyte ethernet ports in the WTI device.

Sample:
Yes, Yes
interface_list
string
success
Current ethernet ports of the WTI device.

Sample:
eth0
keylength
string
success
Current key length of the WTI device.

Sample:
2048
lineinputcount_rating
string
success
Identifies total power inlets and their power rating.

Sample:
1 , 20 Amps
macaddresses
dictionary
always
Current mac addresses of the WTI device.

Sample:
{'mac': '00-09-9b-02-9a-26'}
modeminstalled
string
success
Identifies if a modem is installed in the WTI device.

Sample:
Yes, 4G/LTE
modemmodel
string
success
Identifies the modem model number (if installed) in the WTI device.

Sample:
MTSMC-LVW2
opensshversion
string
success
Current OpenSSH running on the WTI device.

Sample:
8.2p1
opensslversion
string
success
Current OpenSSL version running on the WTI device.

Sample:
1.1.1d 10 Sep 2019
option1/2
string
success
Various Identity options of the WTI.

Sample:
WPO-STRT-CPM8 / W4G-VZW-CPM8
product
string
success
Current Product Part Number of the WTI device.

Sample:
CPM-800-1-CA
ram_flash
string
success
Total RAM and FLASH installed in the WTI device..

Sample:
512 MB, 128 MB
restful
string
success
Current RESTful version of the WTI device.

Sample:
v1.0, v2 (Mar20)
serialnumber
string
success
Current Serial number of the WTI device.

Sample:
12345678901234
siteid
string
success
Current Site-ID of the WTI device.

Sample:
GENEVARACK
softwareversion
string
success
Expanded Firmware version of the WTI device.

Sample:
6.60 19 Feb 2020
status
dictionary
always
Return status after module completion

Sample:
{'code': '0', 'text': 'OK'}
totalplugs
string
success
Total Power Outlet plugs of the WTI device.

Sample:
8
totalports
string
success
Total serial ports of the WTI device.

Sample:
9
uptime
string
success
Current uptime of the WTI device.

Sample:
259308.26
vendor
string
success
Identifies WTI device as a WTI device.

Sample:
wti


Authors

  • Western Telematic Inc. (@wtinetworkgear)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/wti/remote/cpm_status_info_module.html