wti.remote.cpm_syslog_client_config module – Set network SYSLOG Client parameters in WTI OOB and PDU devices

Note

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

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_client_config.

New in version 2.11.0: of wti.remote

Synopsis

  • Set network SYSLOG Client parameters in WTI OOB and PDU devices

Parameters

Parameter

Comments

address

list / elements=string

Sets the IP Address of the SYSLOG server to contact.

clear

integer

Removes all the IP block entries for the protocol being defined before setting the newly defined entries.

Choices:

  • 0

  • 1

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.

index

list / elements=integer

Index of the IP block being modified.

port

list / elements=integer

Defines the port number used by the SYSLOG Client (1 - 65535).

protocol

integer

The protocol that the SYSLOG entry should be applied. 0 = ipv4, 1 = ipv6.

Choices:

  • 0

  • 1

secure

list / elements=integer

Defines if a secure connection is used by the SYSLOG Client (TCP Transport required).

transport

list / elements=integer

Defines the transfer protocol type used by the SYSLOG Client. 0=UDP, 1=TCP;

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

# Sets the device SYSLOG Client Parameters
- name: Set the an SYSLOG Client 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
    protocol: 0
    index:
        - 1
    address:
        - "11.22.33.44"
    port:
        - 555
    transport:
        - 1
    secure:
        - 0

# Sets the device SYSLOG Client Parameters
- name: Set the SYSLOG Client Parameters a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    protocol: 0
    index:
        - 1
        - 2
    address:
        - "11.22.33.44"
        - "55.66.77.88"
    port:
        - 555
        - 557
    transport:
        - 1
        - 0
    secure:
        - 0
        - 1

Return Values

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

Key

Description

data

complex

The output JSON returned from the commands sent

Returned: always

syslogclient

dictionary

Current k/v pairs of interface info for the WTI device after module execution.

Returned: always

Sample: {“syslogclient”: {“ietf-ipv4”: {“clients”: [{“address”: “”, “index”: “1”, “port”: “514”, “secure”: “0”, “transport”: “0”}, {“address”: “”, “index”: “2”, “port”: “514”, “secure”: “0”, “transport”: “0”}, {“address”: “”, “index”: “3”, “port”: “514”, “secure”: “0”, “transport”: “0”}, {“address”: “”, “index”: “4”, “port”: “514”, “secure”: “0”, “transport”: “0”}]}, “ietf-ipv6”: {“clients”: [{“address”: “”, “index”: “1”, “port”: “514”, “secure”: “0”, “transport”: “0”}, {“address”: “”, “index”: “2”, “port”: “514”, “secure”: “0”, “transport”: “0”}, {“address”: “”, “index”: “3”, “port”: “514”, “secure”: “0”, “transport”: “0”}, {“address”: “”, “index”: “4”, “port”: “514”, “secure”: “0”, “transport”: “0”}]}}}

Authors

  • Western Telematic Inc. (@wtinetworkgear)