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

Get status and parameters from WTI OOB 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 various status and parameters from WTI OOB and PDU devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get temperature
  - name: run Get Device Temperature
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - debug:
        var: lookup('cpm_status',
                'temperature',
                validate_certs=true,
                use_https=true,
                cpm_url='rest.wti.com',
                cpm_username='rest',
                cpm_password='restfulpassword')
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get firmware version
  - name: Get the firmware version of a given WTI device
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - debug:
        var: lookup('cpm_status',
                'firmware',
                validate_certs=false,
                use_https=true,
                cpm_url="192.168.0.158",
                cpm_username="super",
                cpm_password="super")
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get status output
  - name: Get the status output from a given WTI device
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - debug:
        var: lookup('cpm_status',
                'status',
                validate_certs=true,
                use_https=true,
                cpm_url="rest.wti.com",
                cpm_username="rest",
                cpm_password="restfulpassword")
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get Alarm output
  - name: Get the alarms status of a given WTI device
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - debug:
        var: lookup('cpm_status',
                'alarms',
                validate_certs=false,
                use_https=false,
                cpm_url="192.168.0.158",
                cpm_username="super",
                cpm_password="super")

Inputs

    
_terms:
    choices:
    - temperature
    - firmware
    - status
    - alarms
    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

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

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 Basic Authentication Password of the WTI device to send the module.
    required: true

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

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