diff options
| author | GomathiselviS <gomathiselvi@gmail.com> | 2020-07-31 17:53:09 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-31 21:53:09 +0000 |
| commit | 1b58f4b0195b866b5d322c314ce66dcf72f8a9af (patch) | |
| tree | dc36dad6a908abb339c831b891ebaebdd753436b /docs | |
| parent | 84e5bb7da5cbafdd64325d26d57abc9bcf79b2dc (diff) | |
| download | vyos.vyos-1b58f4b0195b866b5d322c314ce66dcf72f8a9af.tar.gz vyos.vyos-1b58f4b0195b866b5d322c314ce66dcf72f8a9af.zip | |
Update docs (#73)
vyos: Update docs
Reviewed-by: GomathiselviS
https://github.com/GomathiselviS
Diffstat (limited to 'docs')
21 files changed, 954 insertions, 198 deletions
diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index 61946399..dd26e377 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -39,7 +39,7 @@ Parameters <b>banner</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> <td> @@ -79,7 +79,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -114,8 +114,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -147,8 +146,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -176,7 +174,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -195,7 +193,7 @@ Parameters <b>text</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index dd7e2994..bd3d5e69 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -40,13 +40,14 @@ Parameters <b>commands</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - / <span style="color: red">required</span> </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=raw</span> / <span style="color: red">required</span> </div> </td> <td> </td> <td> <div>The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the <em>wait_for</em> argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded.</div> + <div>If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). Refer below examples.</div> </td> </tr> <tr> @@ -55,7 +56,7 @@ Parameters <b>interval</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> @@ -71,7 +72,7 @@ Parameters <b>match</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -111,7 +112,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -146,8 +147,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -179,8 +179,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -208,7 +207,7 @@ Parameters <b>retries</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> @@ -224,8 +223,8 @@ Parameters <b>wait_for</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index 44946bc5..c3031f35 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -90,7 +90,7 @@ Parameters <b>filename</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -106,7 +106,7 @@ Parameters <b>comment</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -122,7 +122,7 @@ Parameters <b>config</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -137,8 +137,8 @@ Parameters <b>lines</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -152,7 +152,7 @@ Parameters <b>match</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -192,7 +192,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -227,8 +227,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -260,8 +259,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -308,7 +306,7 @@ Parameters <b>src</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">path</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index a0057373..f609b9e8 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -39,8 +39,8 @@ Parameters <b>gather_network_resources</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -54,8 +54,8 @@ Parameters <b>gather_subset</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> <b>Default:</b><br/><div style="color: blue">"!config"</div> @@ -91,7 +91,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -126,8 +126,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -159,8 +158,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index dda270d5..f7e64628 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -704,7 +704,7 @@ Parameters </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>stricu</li> + <li>strict</li> <li>loose</li> <li>disable</li> </ul> diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index b01595a1..c00b430f 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -36,18 +36,18 @@ Parameters <table border=0 cellpadding=0 class="documentation-table"> <tr> - <th colspan="2">Parameter</th> + <th colspan="3">Parameter</th> <th>Choices/<font color="blue">Defaults</font></th> <th width="100%">Comments</th> </tr> <tr> - <td colspan="2"> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>aggregate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -55,29 +55,30 @@ Parameters <div>List of Interfaces definitions.</div> </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>delay</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are <em>state</em> with values <code>up</code>/<code>down</code> and <em>neighbors</em>.</div> </td> </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>description</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -87,19 +88,20 @@ Parameters </td> </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>duplex</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>full</li> <li>half</li> - <li><div style="color: blue"><b>auto</b> ←</div></li> + <li>auto</li> </ul> </td> <td> @@ -107,7 +109,8 @@ Parameters </td> </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>enabled</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -126,12 +129,13 @@ Parameters </td> </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>mtu</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> @@ -141,12 +145,13 @@ Parameters </td> </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> <td> @@ -156,13 +161,14 @@ Parameters </td> </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>neighbors</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -173,12 +179,13 @@ Parameters </tr> <tr> <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>host</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -189,12 +196,13 @@ Parameters </tr> <tr> <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>port</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -205,7 +213,195 @@ Parameters </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>speed</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>Interface link speed.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + <li>up</li> + <li>down</li> + </ul> + </td> + <td> + <div>State of the Interface configuration, <code>up</code> means present and operationally up and <code>down</code> means present and operationally <code>down</code></div> + </td> + </tr> + + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>delay</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">10</div> + </td> + <td> + <div>Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are <em>state</em> with values <code>up</code>/<code>down</code> and <em>neighbors</em>.</div> + </td> + </tr> + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>description</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>Description of Interface.</div> + </td> + </tr> + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>duplex</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>full</li> + <li>half</li> + <li>auto</li> + </ul> + </td> + <td> + <div>Interface link status.</div> + </td> + </tr> + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>enabled</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><div style="color: blue"><b>yes</b> ←</div></li> + </ul> + </td> + <td> + <div>Interface link status.</div> + </td> + </tr> + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>mtu</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Maximum size of transmit packet.</div> + </td> + </tr> + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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>Name of the Interface.</div> + </td> + </tr> + <tr> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>neighbors</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=dictionary</span> </div> + </td> + <td> + </td> + <td> + <div>Check the operational state of given interface <code>name</code> for LLDP neighbor.</div> + <div>The following suboptions are available.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>host</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>LLDP neighbor host for given interface <code>name</code>.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>port</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>LLDP neighbor port to which given interface <code>name</code> is connected.</div> + </td> + </tr> + + <tr> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>provider</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -225,13 +421,13 @@ Parameters </tr> <tr> <td class="elbow-placeholder"></td> - <td colspan="1"> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>host</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> + </div> </td> <td> </td> @@ -241,7 +437,7 @@ Parameters </tr> <tr> <td class="elbow-placeholder"></td> - <td colspan="1"> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>password</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -257,7 +453,7 @@ Parameters </tr> <tr> <td class="elbow-placeholder"></td> - <td colspan="1"> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>port</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -266,15 +462,14 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> </tr> <tr> <td class="elbow-placeholder"></td> - <td colspan="1"> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>ssh_keyfile</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -290,7 +485,7 @@ Parameters </tr> <tr> <td class="elbow-placeholder"></td> - <td colspan="1"> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>timeout</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -299,15 +494,14 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> </tr> <tr> <td class="elbow-placeholder"></td> - <td colspan="1"> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>username</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> @@ -323,12 +517,12 @@ Parameters </tr> <tr> - <td colspan="2"> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>speed</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -338,12 +532,12 @@ Parameters </td> </tr> <tr> - <td colspan="2"> + <td colspan="3"> <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">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 4e35ea9b..67c71de7 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -41,7 +41,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -174,7 +174,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index dbf89a06..8745ffda 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -46,8 +46,8 @@ Parameters <b>aggregate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -55,13 +55,82 @@ Parameters <div>List of L3 interfaces definitions</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ipv4</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>IPv4 of the L3 interface.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ipv6</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>IPv6 of the L3 interface.</div> + </td> + </tr> <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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> + </td> + <td> + <div>Name of the L3 interface.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + </ul> + </td> + <td> + <div>State of the L3 interface configuration.</div> + </td> + </tr> + + <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>ipv4</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -76,7 +145,7 @@ Parameters <b>ipv6</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -91,7 +160,7 @@ Parameters <b>name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -127,7 +196,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -162,8 +231,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -195,8 +263,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -224,7 +291,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index 83a7094c..b09a846c 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -40,7 +40,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -90,7 +90,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -128,7 +128,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index a97a1c24..471de9b1 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -47,7 +47,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -55,14 +55,95 @@ Parameters <div>List of link aggregation definitions.</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>members</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> + </td> + <td> + <div>List of members of the link aggregation group.</div> + </td> + </tr> <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>mode</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>802.3ad</li> + <li>active-backup</li> + <li>broadcast</li> + <li>round-robin</li> + <li>transmit-load-balance</li> + <li>adaptive-load-balance</li> + <li>xor-hash</li> + <li>on</li> + </ul> + </td> + <td> + <div>Mode of the link aggregation group.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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> + </td> + <td> + <div>Name of the link aggregation group.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + <li>up</li> + <li>down</li> + </ul> + </td> + <td> + <div>State of the link aggregation group.</div> + </td> + </tr> + + <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>members</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -81,14 +162,14 @@ Parameters </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>802.3ad</li> + <li><div style="color: blue"><b>802.3ad</b> ←</div></li> <li>active-backup</li> <li>broadcast</li> <li>round-robin</li> <li>transmit-load-balance</li> <li>adaptive-load-balance</li> <li>xor-hash</li> - <li>yes</li> + <li>on</li> </ul> </td> <td> @@ -102,7 +183,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -137,7 +218,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -172,8 +253,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -205,8 +285,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index 1fc23bc0..bf803ff6 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -92,7 +92,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 187ad8fd..98d5c704 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -47,7 +47,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -55,7 +55,46 @@ Parameters <div>List of interfaces LLDP should be configured on.</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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> + </td> + <td> + <div>Name of the interface LLDP should be configured on.</div> + </td> + </tr> <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + <li>enabled</li> + <li>disabled</li> + </ul> + </td> + <td> + <div>State of the LLDP configuration.</div> + </td> + </tr> + + <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>name</b> @@ -97,7 +136,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -132,8 +171,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -165,8 +203,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index a52251a4..d64b20c7 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -40,7 +40,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -111,7 +111,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -130,7 +130,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - / <span style="color: red">required</span> </div> + </div> </td> <td> </td> @@ -149,7 +149,7 @@ Parameters <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> + </div> </td> <td> </td> diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index bcb1625e..30dae36f 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -47,7 +47,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -82,7 +82,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -117,8 +117,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -150,8 +149,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index 37d9a34e..c54f6361 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -39,8 +39,8 @@ Parameters <b>aggregate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -48,13 +48,105 @@ Parameters <div>List of logging definitions.</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>dest</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>console</li> + <li>file</li> + <li>global</li> + <li>host</li> + <li>user</li> + </ul> + </td> + <td> + <div>Destination of the logs.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>facility</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>Set logging facility.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>level</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>Set logging severity levels.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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>If value of <code>dest</code> is <em>file</em> it indicates file-name, for <em>user</em> it indicates username and for <em>host</em> indicates the host name to be notified.</div> + </td> + </tr> <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + </ul> + </td> + <td> + <div>State of the logging configuration.</div> + </td> + </tr> + + <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>dest</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -76,7 +168,7 @@ Parameters <b>facility</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -91,7 +183,7 @@ Parameters <b>level</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -106,7 +198,7 @@ Parameters <b>name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -142,7 +234,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -177,8 +269,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -210,8 +301,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -239,7 +329,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 796e421b..1d233051 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1302,7 +1302,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -1318,7 +1318,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -1426,7 +1426,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index 098a76d3..69bc4181 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -59,7 +59,7 @@ Parameters <b>dest</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> / <span style="color: red">required</span> </div> </td> <td> @@ -110,7 +110,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -145,8 +145,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -178,8 +177,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -222,7 +220,7 @@ Parameters <b>source</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -237,7 +235,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 854cc7f5..848d5a0d 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -62,7 +62,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -70,7 +70,92 @@ Parameters <div>List of static route definitions</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>admin_distance</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Admin distance of the static route.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>mask</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>Network prefix mask of the static route.</div> + </td> + </tr> <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>next_hop</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>Next hop IP of the static route.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>prefix</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> + </td> + <td> + <div>Network prefix of the static route. <code>mask</code> param should be ignored if <code>prefix</code> is provided with <code>mask</code> value <code>prefix/mask</code>.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + </ul> + </td> + <td> + <div>State of the static route configuration.</div> + </td> + </tr> + + <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>mask</b> @@ -142,7 +227,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -177,8 +262,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -210,8 +294,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index abe75657..acca3667 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -39,7 +39,7 @@ Parameters <b>domain_name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -54,8 +54,8 @@ Parameters <b>domain_search</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -69,7 +69,7 @@ Parameters <b>host_name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -81,17 +81,17 @@ Parameters <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>name_servers</b> + <b>name_server</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> <td> <div>A list of name servers to use with the device. Mutually exclusive with <em>domain_search</em></div> - <div style="font-size: small; color: darkgreen"><br/>aliases: name_server</div> + <div style="font-size: small; color: darkgreen"><br/>aliases: name_servers</div> </td> </tr> <tr> @@ -121,7 +121,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -156,8 +156,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -189,8 +188,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -218,7 +216,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 016208d1..30114480 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -39,8 +39,8 @@ Parameters <b>aggregate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -49,13 +49,119 @@ Parameters <div style="font-size: small; color: darkgreen"><br/>aliases: users, collection</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>configured_password</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>The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as <code>provider password</code>.</div> + </td> + </tr> <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>full_name</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>The <code>full_name</code> argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>level</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>The <code>level</code> argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.</div> + <div style="font-size: small; color: darkgreen"><br/>aliases: role</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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> + </td> + <td> + <div>The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the <code>aggregate</code> argument. Please note that this option is not same as <code>provider username</code>.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + </ul> + </td> + <td> + <div>Configures the state of the username definition as it relates to the device operational configuration. When set to <em>present</em>, the username(s) should be configured in the device active configuration and when set to <em>absent</em> the username(s) should not be in the device active configuration</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>update_password</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>on_create</li> + <li>always</li> + </ul> + </td> + <td> + <div>Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to <code>always</code>, the password will always be updated in the device and when set to <code>on_create</code> the password will be updated only if the username is created.</div> + </td> + </tr> + + <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>configured_password</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -70,7 +176,7 @@ Parameters <b>full_name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -85,7 +191,7 @@ Parameters <b>level</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -101,7 +207,7 @@ Parameters <b>name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -137,7 +243,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -172,8 +278,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -205,8 +310,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -253,7 +357,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -272,7 +376,7 @@ Parameters <b>update_password</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index 3ec9d114..084649fb 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -39,7 +39,7 @@ Parameters <b>address</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -54,8 +54,8 @@ Parameters <b>aggregate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> </div> </td> <td> </td> @@ -63,18 +63,135 @@ Parameters <div>List of VLANs definitions.</div> </td> </tr> + <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>Configure Virtual interface address.</div> + </td> + </tr> <tr> - <td colspan="2"> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>associated_interfaces</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>This is a intent option and checks the operational state of the for given vlan <code>name</code> for associated interfaces. If the value in the <code>associated_interfaces</code> does not match with the operational state of vlan on device it will result in failure.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>delay</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> </div> </td> <td> </td> <td> + <div>Delay the play should wait to check for declarative intent params values.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>interfaces</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> / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>List of interfaces that should be associated to the VLAN.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</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>Name of the VLAN.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <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>present</li> + <li>absent</li> + </ul> + </td> + <td> + <div>State of the VLAN configuration.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vlan_id</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>ID of the VLAN. Range 0-4094.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>associated_interfaces</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> + </td> + <td> <div>This is a intent option and checks the operational state of the for given vlan <code>name</code> for associated interfaces. If the value in the <code>associated_interfaces</code> does not match with the operational state of vlan on device it will result in failure.</div> </td> </tr> @@ -84,7 +201,7 @@ Parameters <b>delay</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> @@ -100,8 +217,8 @@ Parameters <b>interfaces</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - / <span style="color: red">required</span> </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> @@ -115,7 +232,7 @@ Parameters <b>name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -151,7 +268,7 @@ Parameters <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> + </div> </td> <td> </td> @@ -186,8 +303,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -219,8 +335,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -267,7 +382,7 @@ Parameters <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -286,8 +401,8 @@ Parameters <b>vlan_id</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - / <span style="color: red">required</span> </div> + <span style="color: purple">integer</span> + </div> </td> <td> </td> |