wti.remote.cpm_temp_info – Get temperature information from WTI OOB and PDU devices

From Get docs
Ansible/docs/2.10/collections/wti/remote/cpm temp info module


wti.remote.cpm_temp_info – Get temperature information 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_temp_info.


New in version 2.9: of wti.remote


Synopsis

  • Get temperature information 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

  • no
  • yes

Designates to use an https connection or http connection.

use_proxy

boolean

  • no

  • yes

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

validate_certs

boolean

  • 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 Temperature Information of a WTI device
  cpm_temp_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

- name: Get the Temperature Information of a WTI device
  cpm_temp_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


format

string

success

Current Temperature format (Celsius or Fahrenheit) of the WTI device after module execution.


Sample:

F

status

dictionary

always

Return status after module completion


Sample:

{'code': '0', 'text': 'OK'}

temperature

string

success

Current Temperature of the WTI device after module execution.


Sample:

76

timestamp

string

success

Current timestamp of the WTI device after module execution.


Sample:

2020-02-24T20:54:03+00:00




Authors

  • Western Telematic Inc. (@wtinetworkgear)

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