W3cubDocs

/Ansible 2.10

wti.remote.cpm_metering – Get Power and Current data from WTI OOB/Combo and PDU devices

Note

This plugin is part of the wti.remote collection.

To install it use: ansible-galaxy collection install wti.remote.

To use it in a playbook, specify: wti.remote.cpm_metering.

New in version 2.7: of wti.remote

Synopsis

  • Get Power and Current data from WTI OOB/Combo and PDU devices

Parameters

Parameter Choices/Defaults Configuration Comments
_terms
string / required
    Choices:
  • getpower
  • getcurrent
This is the Action to send the module.
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.
enddate
string
End date of the range to look for power data
startdate
string
Start date of the range to look for power data
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.

Examples

# Get Power data
  - name: Get Power data for a given WTI device
  - debug:
        var: lookup('cpm_metering',
                'getpower',
                validate_certs=true,
                use_https=true,
                cpm_url='rest.wti.com',
                cpm_username='restpower',
                cpm_password='restfulpowerpass12')

# Get Current data
  - name: Get Current data for a given WTI device
  - debug:
        var: lookup('cpm_metering',
                'getcurrent',
                validate_certs=true,
                use_https=true,
                cpm_url='rest.wti.com',
                cpm_username='restpower',
                cpm_password='restfulpowerpass12')

# Get Power data for a date range
  - name: Get Power data for a given WTI device given a certain date range
  - debug:
        var: lookup('cpm_metering',
                'getpower',
                validate_certs=true,
                use_https=true,
                cpm_url='rest.wti.com',
                cpm_username='restpower',
                cpm_password='restfulpowerpass12',
                startdate='08-12-2018'
                enddate='08-14-2018')

Return Values

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

Key Returned Description
_list
string
always
The output JSON returned from the commands sent



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_metering_lookup.html