ansible.builtin.cpm_serial_port_info (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Get Serial port parameters from WTI OOB and PDU devices

Usage examples

Scanned by Steampunk Spotter

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

- name: Get the Serial Port Parameters for port 2 of a WTI device
  cpm_serial_port_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: 2

Scanned by Steampunk Spotter

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

- name: Get the Serial Port Parameters for ports 2 and 4 of a WTI device
  cpm_serial_port_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: 2,4

Scanned by Steampunk Spotter

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

- name: Get the Serial Port Parameters for all ports of a WTI device
  cpm_serial_port_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: "*"

Inputs

    
port:
    default:
    - '*'
    description:
    - This is the serial port number that is getting retrieved. It can include a single
      port number, multiple port numbers separated by commas, a list of port numbers,
      or an '*' character for all ports.
    required: true
    type: list

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

cpm_username:
    description:
    - This is the 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

data:
  contains:
    serialports:
      description: List of data for each serial port
      returned: success
      sample:
      - baud: 4
        break: 1
        cmd: 1
        connstatus: Free
        echo: 1
        handshake: 2
        logoff: ^X
        mode: 1
        parity: 3
        port: 2
        portname: switch
        seq: 2
        stopbits: 1
        tout: 0
      - baud: 3
        break: 1
        cmd: 1
        connstatus: Free
        echo: 1
        handshake: 2
        logoff: ^X
        mode: 1
        parity: 1
        port: 4
        portname: router
        seq: 2
        stopbits: 1
        tout: 1
      type: list
  description: The output JSON returned from the commands sent
  returned: always
  type: complex