wti.remote.cpm_alarm_info (1.0.5) — module

Get alarm information from WTI OOB and PDU devices

| "added in version" 2.9.0 of wti.remote"

Authors: Western Telematic Inc. (@wtinetworkgear)

preview | supported by community

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 temperature alarm from WTI OOB and PDU devices

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the Alarm Information for a WTI device
  cpm_alarm_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the Alarm Information for a WTI device
  cpm_alarm_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: false
    validate_certs: false

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_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

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:
    alarms:
      description: Current alarm status of the WTI device after module execution.
      returned: success
      sample:
      - name: OVER CURRENT (INITIAL)
        status: '0'
      - name: OVER CURRENT (CRITICAL)
        status: '0'
      - name: OVER TEMPERATURE (INITIAL)
        status: '0'
      type: dict
    status:
      description: Return status after module completion
      returned: always
      sample:
        code: '0'
        text: OK
      type: dict
  description: The output JSON returned from the commands sent
  returned: always
  type: complex