diff options
Diffstat (limited to 'docs/vyos.vyos.vyos_lldp_global_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_lldp_global_module.rst | 243 |
1 files changed, 119 insertions, 124 deletions
diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index bf803ff6..92244211 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -31,139 +31,140 @@ Parameters <tr> <th colspan="2">Parameter</th> <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> + <th width="100%">Comments</th> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>config</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>The provided link layer discovery protocol (LLDP) configuration.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>The provided link layer discovery protocol (LLDP) configuration.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>address</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> - </td> - <td> - <div>This argument defines management-address.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>This argument defines management-address.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>enable</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>This argument is a boolean value to enable or disable LLDP.</div> - </td> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>This argument is a boolean value to enable or disable LLDP.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>legacy_protocols</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>cdp</li> - <li>edp</li> - <li>fdp</li> - <li>sonmp</li> - </ul> - </td> - <td> - <div>List of the supported legacy protocols.</div> - </td> + / <span style="color: purple">elements=string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>cdp</li> + <li>edp</li> + <li>fdp</li> + <li>sonmp</li> + </ul> + </td> + <td> + <div>List of the supported legacy protocols.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>snmp</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> - </td> - <td> - <div>This argument enable the SNMP queries to LLDP database.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>This argument enable the SNMP queries to LLDP database.</div> + </td> </tr> - - <tr> - <td colspan="2"> + + <tr> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>running_config</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> - </td> - <td> - <div>This option is used only with state <em>parsed</em>.</div> - <div>The value of this option should be the output received from the VyOS device by executing the command <b>show configuration commands | grep lldp</b>.</div> - <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>This option is used only with state <em>parsed</em>.</div> + <div>The value of this option should be the output received from the VyOS device by executing the command <b>show configuration commands | grep lldp</b>.</div> + <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <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>merged</b> ←</div></li> - <li>replaced</li> - <li>deleted</li> - <li>gathered</li> - <li>rendered</li> - <li>parsed</li> - </ul> - </td> - <td> - <div>The state of the configuration after module completion.</div> - </td> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>merged</b> ←</div></li> + <li>replaced</li> + <li>deleted</li> + <li>gathered</li> + <li>rendered</li> + <li>parsed</li> + </ul> + </td> + <td> + <div>The state of the configuration after module completion.</div> + </td> </tr> - </table> + </table> <br/> @@ -181,7 +182,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -530,9 +530,6 @@ Examples - - - 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: @@ -545,60 +542,60 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <th>Returned</th> <th width="100%">Description</th> </tr> - <tr> - <td colspan="1"> + <tr> + <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> <b>after</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> + </div> + </td> <td>when changed</td> <td> - <div>The configuration as structured data after module completion.</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;">The configuration returned will always be in the same format + <div>The configuration as structured data after module completion.</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;">The configuration returned will always be in the same format of the parameters above.</div> - </td> + </td> </tr> - <tr> - <td colspan="1"> + <tr> + <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> <b>before</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> + </div> + </td> <td>always</td> <td> - <div>The configuration as structured data prior to module invocation.</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;">The configuration returned will always be in the same format + <div>The configuration as structured data prior to module invocation.</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;">The configuration returned will always be in the same format of the parameters above.</div> - </td> + </td> </tr> - <tr> - <td colspan="1"> + <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> + </div> + </td> <td>always</td> <td> - <div>The set of commands pushed to the remote 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;">['set service lldp legacy-protocols sonmp', "set service lldp management-address '192.0.2.14'"]</div> - </td> + <div>The set of commands pushed to the remote 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;">['set service lldp legacy-protocols sonmp', "set service lldp management-address '192.0.2.14'"]</div> + </td> </tr> - </table> + </table> <br/><br/> @@ -610,5 +607,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - |