wti.remote.cpm_power_info – Get the Power Information of a WTI device

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

New in version 2.9: of wti.remote

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Get the Power Information of a WTI device

Parameters

Parameter	Choices/Defaults	Comments
cpm_enddate string		End date of the range to look for power data
cpm_password string / required		This is the Password of the WTI device to send the module.
cpm_startdate string		Start date of the range to look for power data
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 Power Information of a WTI device
  cpm_power_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

- name: Get the Power Information of a WTI device
  cpm_power_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: false
    validate_certs: false
    startdate: 01-12-2020"
    enddate: 02-16-2020"

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
	ats string	success	Identifies if the WTI device is an ATS type of power device. Sample: 1
	outletmetering string	success	Identifies if the WTI device has Poiwer Outlet metering. Sample: 1
	plugcount string	success	Current outlet plug count of the WTI device after module execution. Sample: 8
	powerdata dictionary	success	Power data of the WTI device after module execution. Sample: [{'branch1': [{'current1': '0.00', 'current2': '0.00', 'current3': '0.00', 'current4': '0.00', 'current5': '0.00', 'current6': '0.00', 'current7': '0.00', 'current8': '0.00', 'voltage1': '118.00'}], 'timestamp': '2020-02-24T21:45:18+00:00'}]
	powerdatacount string	success	Total powerdata samples returned after module execution. Sample: 1
	powereff string	success	Power efficiency of the WTI device after module execution. Sample: 100
	powerfactor string	success	Power factor of the WTI device after module execution. Sample: 100
	powerunit string	success	Identifies if the WTI device is a power type device. Sample: 1
	status dictionary	always	Return status after module completion Sample: {'code': '0', 'text': 'OK'}
	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_power_info_module.html