blob: 726a4d5fe4091740ed7410891c462ac9c30b7352 (
plain)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
.. _cisco.nxos.nxos_snmp_traps_module:
**************************
cisco.nxos.nxos_snmp_traps
**************************
**(deprecated, removed after 2024-01-01) Manages SNMP traps.**
Version added: 1.0.0
.. contents::
:local:
:depth: 1
DEPRECATED
----------
:Removed in collection release after 2024-01-01
:Why: Updated modules released with more functionality
:Alternative: nxos_snmp_server
Synopsis
--------
- Manages SNMP traps configurations.
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>group</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>aaa</li>
<li>bfd</li>
<li>bgp</li>
<li>bridge</li>
<li>callhome</li>
<li>cfs</li>
<li>config</li>
<li>eigrp</li>
<li>entity</li>
<li>feature-control</li>
<li>generic</li>
<li>hsrp</li>
<li>license</li>
<li>link</li>
<li>lldp</li>
<li>mmode</li>
<li>ospf</li>
<li>pim</li>
<li>rf</li>
<li>rmon</li>
<li>snmp</li>
<li>storm-control</li>
<li>stpx</li>
<li>switchfabric</li>
<li>syslog</li>
<li>sysmgr</li>
<li>system</li>
<li>upgrade</li>
<li>vtp</li>
<li>all</li>
</ul>
</td>
<td>
<div>Case sensitive group.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>enabled</b> ←</div></li>
<li>disabled</li>
</ul>
</td>
<td>
<div>Manage the state of the resource.</div>
</td>
</tr>
</table>
<br/>
Notes
-----
.. note::
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
- Limited Support for Cisco MDS
- This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command <cisco.nxos.nxos_command_module>` module.
- Be aware that you can set a trap only for an enabled feature.
- For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
--------
.. code-block:: yaml
# ensure lldp trap configured
- cisco.nxos.nxos_snmp_traps:
group: lldp
state: enabled
# ensure lldp trap is not configured
- cisco.nxos.nxos_snmp_traps:
group: lldp
state: disabled
Return Values
-------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div>
<b>commands</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
</div>
</td>
<td>always</td>
<td>
<div>command sent to the device</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">snmp-server enable traps lldp ;</div>
</td>
</tr>
</table>
<br/><br/>
Status
------
- This module will be removed in a release after 2024-01-01. *[deprecated]*
- For more information see `DEPRECATED`_.
Authors
~~~~~~~
- Jason Edelman (@jedelman8)
|
