1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
.. _cpm_syslog_client_info_module:
cpm_syslog_client_info -- Get network SYSLOG Client parameters from WTI OOB and PDU devices
===========================================================================================
.. contents::
:local:
:depth: 1
Synopsis
--------
Get network SYSLOG Client parameters from WTI OOB and PDU devices
Parameters
----------
cpm_url (True, str, None)
This is the URL of the WTI device to send the module.
cpm_username (True, str, None)
This is the Username of the WTI device to send the module.
cpm_password (True, str, None)
This is the Password of the WTI device to send the module.
interface (False, list, None)
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.
use_https (False, bool, True)
Designates to use an https connection or http connection.
validate_certs (False, bool, True)
If false, SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
use_proxy (False, bool, False)
Flag to control if the lookup will observe HTTP proxy environment variables when present.
Notes
-----
.. note::
- Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
Examples
--------
.. code-block:: yaml+jinja
- 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
-------------
data (always, complex, )
The output JSON returned from the commands sent
syslogclient (always, dict, {'syslogclient': {'ietf-ipv4': {'clients': [{'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '1'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '2'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '3'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '4'}]}, 'ietf-ipv6': {'clients': [{'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '1'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '2'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '3'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '4'}]}}})
Current k/v pairs of SYSLOG Client info for the WTI device after module execution.
Status
------
- This module is not guaranteed to have a backwards compatible interface. *[preview]*
- This module is maintained by community.
Authors
~~~~~~~
- Western Telematic Inc. (@wtinetworkgear)
|
