wti.remote.cpm_current_info (1.0.5) — module

Install collection

Install with ansible-galaxy collection install wti.remote:==1.0.5

Add to requirements.yml

  collections:
    - name: wti.remote
      version: 1.0.5

Description

Get the Current Information of a WTI device

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get the Current Information of a WTI device
  cpm_current_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get the Current Information of a WTI device
  cpm_current_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"

Inputs

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

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

use_proxy:
    default: false
    description:
    - Flag to control if the lookup will observe HTTP proxy environment variables when
      present.
    required: false
    type: bool

cpm_enddate:
    description:
    - End date of the range to look for current data
    required: false
    type: str

cpm_password:
    description:
    - This is the Password of the WTI device to send the module.
    required: true
    type: str

cpm_username:
    description:
    - This is the Username of the WTI device to send the module.
    required: true
    type: str

cpm_startdate:
    description:
    - Start date of the range to look for current data
    required: false
    type: str

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

data:
  contains:
    ats:
      description: Identifies if the WTI device is an ATS type of power device.
      returned: success
      sample: '1'
      type: str
    outletmetering:
      description: Identifies if the WTI device has Poiwer Outlet metering.
      returned: success
      sample: '1'
      type: str
    plugcount:
      description: Current outlet plug count of the WTI device after module execution.
      returned: success
      sample: '8'
      type: str
    powerdata:
      description: Power data of the WTI device after module execution.
      returned: success
      sample:
      - branch1:
        - current1: '0.00'
          voltage1: '118.00'
        format: F
        temperature: '90'
        timestamp: '2020-02-24T23:29:31+00:00'
      type: dict
    powerdatacount:
      description: Total powerdata samples returned after module execution.
      returned: success
      sample: '1'
      type: str
    powereff:
      description: Power efficiency of the WTI device after module execution.
      returned: success
      sample: '100'
      type: str
    powerfactor:
      description: Power factor of the WTI device after module execution.
      returned: success
      sample: '100'
      type: str
    powerunit:
      description: Identifies if the WTI device is a power type device.
      returned: success
      sample: '1'
      type: str
    status:
      description: Return status after module completion
      returned: always
      sample:
        code: '0'
        text: OK
      type: dict
    timestamp:
      description: Current timestamp of the WTI device after module execution.
      returned: success
      sample: '2020-02-24T20:54:03+00:00'
      type: str
  description: The output JSON returned from the commands sent
  returned: always
  type: complex