wti.remote.cpm_serial_port_action_set (1.0.5) — module

Set Serial port connection/disconnection commands in 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

Set Serial port connection/disconnection commands in WTI OOB and PDU devices

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Set Serial Port Action (Connect)
- name: Connect port 2 to port 3 of a WTI device
  cpm_serial_port_action_set:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: "2"
    portremote: "3"
    action: "1"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Set Serial port Action (Disconnect)
- name: Disconnect port 2 and 3 of a WTI device
  cpm_serial_port_action_set:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: "2"
    action: "2"

Inputs

    
port:
    description:
    - This is the port number that is getting the action performed on.
    required: true
    type: int

action:
    choices:
    - 1
    - 2
    description:
    - This is the baud rate to assign to the port.
    - 1=Connect, 2=Disconnect
    required: false
    type: int

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

portremote:
    description:
    - This is the port number that is getting the action performed on.
    required: false
    type: int

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:
  description: The output JSON returned from the commands sent
  returned: always
  type: str