wti.remote.cpm_syslog_client_info – Get network SYSLOG Client parameters from 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_client_info.

New in version 2.11: of wti.remote

Synopsis

  • Get network SYSLOG Client parameters from WTI OOB and PDU devices

Parameters

Parameter

Comments

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.

interface

string

This is the ethernet port name that is getting retrieved. It can include a single ethernet

port name, multiple ethernet port names separated by commas or not defined for all ports.

Choices:

  • eth0

  • eth1

  • ppp0

  • qmimux0

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

- name: Get the network SYSLOG Client Parameters for all interfaces of a WTI device.
  cpm_interface_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false


- name: Get the network SYSLOG Client Parameters for eth0 of a WTI device.
  cpm_interface_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: false
    validate_certs: false
    interface: "eth0"

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 SYSLOG Client 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)