wti.remote.cpm_serial_port_action_set module – Set Serial port connection/disconnection commands in WTI OOB and PDU devices

Note

This module is part of the wti.remote collection (version 1.0.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install wti.remote.

To use it in a playbook, specify: wti.remote.cpm_serial_port_action_set.

New in version 2.9: of wti.remote

Synopsis

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

Parameters

Parameter

Comments

action

integer

This is the baud rate to assign to the port.

1=Connect, 2=Disconnect

Choices:

  • 1

  • 2

cpm_password

string / required

This is the Password of the WTI device to send the module.

cpm_url

string / required

This is the URL of the WTI device to send the module.

cpm_username

string / required

This is the Username of the WTI device to send the module.

port

integer / required

This is the port number that is getting the action performed on.

portremote

integer / required

This is the port number that is getting the action performed on.

use_https

boolean

Designates to use an https connection or http connection.

Choices:

  • no

  • yes ← (default)

use_proxy

boolean

Flag to control if the lookup will observe HTTP proxy environment variables when present.

Choices:

  • no ← (default)

  • yes

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used

on personally controlled sites using self-signed certificates.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Use groups/cpm in module_defaults to set common options used between CPM modules.

Examples

# 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"

# 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"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

data

string

The output JSON returned from the commands sent

Returned: always

Authors

  • Western Telematic Inc. (@wtinetworkgear)