wti.remote.cpm_serial_port_info lookup – Get Serial port parameters in WTI OOB and PDU devices
Note
This lookup plugin is part of the wti.remote collection (version 1.0.8).
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_info
.
New in wti.remote 2.9.0
Synopsis
Get Serial port parameters from WTI OOB and PDU devices
Keyword parameters
This describes keyword parameters of the lookup. These are the values key1=value1
, key2=value2
and so on in the following
examples: lookup('wti.remote.cpm_serial_port_info', key1=value1, key2=value2, ...)
and query('wti.remote.cpm_serial_port_info', key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
This is the Password of the WTI device to send the module. |
|
This is the URL of the WTI device to send the module. |
|
This is the Username of the WTI device to send the module. |
|
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. Default: |
|
Designates to use an https connection or http connection. Choices:
|
|
Flag to control if the lookup will observe HTTP proxy environment variables when present. Choices:
|
|
If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Notes
Note
Use
groups/cpm
inmodule_defaults
to set common options used between CPM modules.)
Examples
- 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
- 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
- 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: "*"
Return Value
Key |
Description |
---|---|
The output JSON returned from the commands sent Returned: always |
|
List of data for each serial port Returned: success Sample: |