wti.remote.cpm_syslog_server_config – Set network SYSLOG Server parameters in WTI OOB and PDU devices
Note
This plugin 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_syslog_server_config
.
New in version 2.11: of wti.remote
Parameters
Parameter |
Comments |
---|---|
Sets the IP Address to block message logging. |
|
Removes all the IP block entries for the protocol being defined before setting the newly defined entries. Choices:
|
|
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. |
|
Activates SYSLOG listening for the specified interface and protocol. Choices:
|
|
Index of the IP block being modified. |
|
The ethernet port for the SYSLOG we are defining. Choices:
|
|
Defines the port number used by the SYSLOG Server (1 - 65535). |
|
The protocol that the SYSLOG entry should be applied. 0 = ipv4, 1 = ipv6. Choices:
|
|
Defines if a secure connection is used by the SYSLOG Server (TCP Transport required). Choices:
|
|
Defines the transfer protocol type used by the SYSLOG Server. 0=UDP, 1=TCP; Choices:
|
|
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:
|
Examples
# Sets the device SYSLOG Server Parameters
- name: Set the an SYSLOG Server Parameter for a WTI device
cpm_iptables_config:
cpm_url: "nonexist.wti.com"
cpm_username: "super"
cpm_password: "super"
use_https: true
validate_certs: false
interface: "eth0"
protocol: 0
port: 514
transport: 0
secure: 0
clear: 1
# Sets the device SYSLOG Server Parameters
- name: Set the SYSLOG Server Parameters a WTI device
cpm_iptables_config:
cpm_url: "nonexist.wti.com"
cpm_username: "super"
cpm_password: "super"
use_https: true
validate_certs: false
interface: "eth0"
protocol: 0
port: 514
transport: 0
secure: 0
clear: 1
index:
- 1
- 2
block:
- "192.168.50.4"
- "72.76.4.56"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The output JSON returned from the commands sent Returned: always |
|
Current k/v pairs of interface info for the WTI device after module execution. Returned: always Sample: {“syslogserver”: {“eth0”: [{“ietf-ipv4”: {“block”: [{“address”: “”, “index”: “1”}, {“address”: “”, “index”: “2”}, {“address”: “”, “index”: “3”}, {“address”: “”, “index”: “4”}], “enable”: 0, “port”: “514”, “secure”: “0”, “transport”: “0”}, “ietf-ipv6”: {“block”: [{“address”: “”, “index”: “1”}, {“address”: “”, “index”: “2”}, {“address”: “”, “index”: “3”}, {“address”: “”, “index”: “4”}], “enable”: 0, “port”: “514”, “secure”: “0”, “transport”: “0”}}]}} |
Authors
Western Telematic Inc. (@wtinetworkgear)