diff options
Diffstat (limited to 'docs/vyos.vyos.vyos_interface_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_interface_module.rst | 274 |
1 files changed, 234 insertions, 40 deletions
diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index b01595a..c00b430 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> |