blob: 5ccf0b4b3d950a45c29d27ae2a3d64b3bd59e2f1 (
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
|
.. _cisco.ios.ios_lldp_module:
******************
cisco.ios.ios_lldp
******************
**(deprecated, removed after 2024-06-01) Manage LLDP configuration on Cisco IOS network devices.**
Version added: 1.0.0
.. contents::
:local:
:depth: 1
DEPRECATED
----------
:Removed in collection release after 2024-06-01
:Why: Newer and updated modules released with more functionality.
:Alternative: ios_lldp_global
Synopsis
--------
- This module provides declarative management of LLDP service on Cisco IOS network devices.
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>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>present</b> ←</div></li>
<li>absent</li>
<li>enabled</li>
<li>disabled</li>
</ul>
</td>
<td>
<div>State of the LLDP configuration. If value is <em>present</em> lldp will be enabled else if it is <em>absent</em> it will be disabled.</div>
</td>
</tr>
</table>
<br/>
Notes
-----
.. note::
- Tested against IOS 15.2
- This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
- 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
- name: Enable LLDP service
cisco.ios.ios_lldp:
state: present
- name: Disable LLDP service
cisco.ios.ios_lldp:
state: absent
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, except for the platforms that use Netconf transport to manage the device.</td>
<td>
<div>The list of configuration mode commands to send 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;">['lldp run']</div>
</td>
</tr>
</table>
<br/><br/>
Status
------
- This module will be removed in a release after 2024-06-01. *[deprecated]*
- For more information see `DEPRECATED`_.
Authors
~~~~~~~
- Ganesh Nalawade (@ganeshrn)
|
