ansible.builtin.cpm_metering (v2.9.27) — lookup

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

| "added in version" 2.7 of ansible.builtin"

Authors: Western Telematic Inc. (@wtinetworkgear)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get Power data
  - name: Get Power data for a given WTI device
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - debug:
        var: lookup('cpm_metering',
                'getpower',
                validate_certs=true,
                use_https=true,
                cpm_url='rest.wti.com',
                cpm_username='restpower',
                cpm_password='restfulpowerpass12')
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get Current data
  - name: Get Current data for a given WTI device
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - debug:
        var: lookup('cpm_metering',
                'getcurrent',
                validate_certs=true,
                use_https=true,
                cpm_url='rest.wti.com',
                cpm_username='restpower',
                cpm_password='restfulpowerpass12')
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get Power data for a date range
  - name: Get Power data for a given WTI device given a certain date range
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - 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')

Inputs

    
_terms:
    choices:
    - getpower
    - getcurrent
    description:
    - This is the Action to send the module.
    required: true

cpm_url:
    description:
    - This is the URL of the WTI device  to send the module.
    required: true

enddate:
    description:
    - End date of the range to look for power data
    required: false

startdate:
    description:
    - Start date of the range to look for power data
    required: false

use_https:
    choices:
    - true
    - false
    default: true
    description:
    - Designates to use an https connection or http connection.
    required: false

use_proxy:
    default: true
    description: Flag to control if the lookup will observe HTTP proxy environment variables
      when present.
    type: boolean

cpm_password:
    description:
    - This is the Password of the WTI device to send the module.

cpm_username:
    description:
    - This is the Username of the WTI device to send the module.

validate_certs:
    default: true
    description:
    - If false, SSL certificates will not be validated. This should only be used on personally
      controlled sites using self-signed certificates.
    required: false
    type: bool

Outputs

_list:
  description: The output JSON returned from the commands sent
  returned: always
  type: str