summaryrefslogtreecommitdiff
path: root/docs/vyos.vyos.vyos_interface_module.rst
diff options
context:
space:
mode:
authorGomathiselviS <gomathiselvi@gmail.com>2020-08-27 14:58:25 -0400
committerGitHub <noreply@github.com>2020-08-27 18:58:25 +0000
commita45e2988263f5109a56b6dcb2c46ecbc6738cb3a (patch)
tree1296e669b99a12a18ac5ce37bf72cdbb19c1a4d5 /docs/vyos.vyos.vyos_interface_module.rst
parent1ae2bbffe70e5217536a05250365a4f44292c8ec (diff)
downloadvyos.vyos-a45e2988263f5109a56b6dcb2c46ecbc6738cb3a.tar.gz
vyos.vyos-a45e2988263f5109a56b6dcb2c46ecbc6738cb3a.zip
Release 1.0.4 (#81)1.0.4
Release 1.0.4 Reviewed-by: https://github.com/apps/ansible-zuul
Diffstat (limited to 'docs/vyos.vyos.vyos_interface_module.rst')
-rw-r--r--docs/vyos.vyos.vyos_interface_module.rst696
1 files changed, 348 insertions, 348 deletions
diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst
index c00b430f..111ff311 100644
--- a/docs/vyos.vyos.vyos_interface_module.rst
+++ b/docs/vyos.vyos.vyos_interface_module.rst
@@ -38,521 +38,525 @@ Parameters
<tr>
<th colspan="3">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
- <th width="100%">Comments</th>
+ <th width="100%">Comments</th>
</tr>
- <tr>
- <td colspan="3">
+ <tr>
+ <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">list</span>
- / <span style="color: purple">elements=dictionary</span> </div>
- </td>
- <td>
- </td>
- <td>
- <div>List of Interfaces definitions.</div>
- </td>
+ / <span style="color: purple">elements=dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>List of Interfaces definitions.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <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">integer</span>
- </div>
- </td>
- <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>
+ </div>
+ </td>
+ <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 class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <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">string</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>Description of Interface.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Description of Interface.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <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">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>
+ </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 class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <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>
<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>Interface link status.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>no</li>
+ <li>yes</li>
+ </ul>
+ </td>
+ <td>
+ <div>Interface link status.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <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">integer</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>Maximum size of transmit packet.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Maximum size of transmit packet.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <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">string</span>
- / <span style="color: red">required</span> </div>
- </td>
- <td>
- </td>
- <td>
- <div>Name of the Interface.</div>
- </td>
+ / <span style="color: red">required</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Name of the Interface.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <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">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>
+ / <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 class="elbow-placeholder"></td>
- <td colspan="1">
+ <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">string</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>LLDP neighbor host for given interface <code>name</code>.</div>
- </td>
+ </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 class="elbow-placeholder"></td>
- <td colspan="1">
+ <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">string</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>LLDP neighbor port to which given interface <code>name</code> is connected.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>LLDP neighbor port to which given interface <code>name</code> is connected.</div>
+ </td>
</tr>
-
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+
+ <tr>
+ <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>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Interface link speed.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <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>
+ </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">
+
+ <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>
+ </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">
+ <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>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Description of Interface.</div>
+ </td>
</tr>
- <tr>
- <td colspan="3">
+ <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>
+ </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">
+ <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>&nbsp;&larr;</div></li>
- </ul>
- </td>
- <td>
- <div>Interface link status.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>no</li>
+ <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
+ </ul>
+ </td>
+ <td>
+ <div>Interface link status.</div>
+ </td>
</tr>
- <tr>
- <td colspan="3">
+ <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>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Maximum size of transmit packet.</div>
+ </td>
</tr>
- <tr>
- <td colspan="3">
+ <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>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Name of the Interface.</div>
+ </td>
</tr>
- <tr>
- <td colspan="3">
+ <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>
+ / <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">
+ <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>
+ </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">
+ <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>
+ </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">
+
+ <tr>
+ <td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>provider</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><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
- <div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
- <div><hr/></div>
- <div>A dict object containing connection details.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div><b>Deprecated</b></div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
+ <div><hr/></div>
+ <div>A dict object containing connection details.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <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>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>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>Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <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">integer</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>Specifies the port to use when building the connection to the remote device.</div>
- </td>
+ </div>
+ </td>
+ <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="2">
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>ssh_keyfile</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">path</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_SSH_KEYFILE</code> will be used instead.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_SSH_KEYFILE</code> will be used instead.</div>
+ </td>
</tr>
- <tr>
- <td class="elbow-placeholder"></td>
- <td colspan="2">
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>timeout</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>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>
+ </div>
+ </td>
+ <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="2">
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>username</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>Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
</tr>
-
- <tr>
- <td colspan="3">
+
+ <tr>
+ <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">string</span>
- </div>
- </td>
- <td>
- </td>
- <td>
- <div>Interface link speed.</div>
- </td>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Interface link speed.</div>
+ </td>
</tr>
- <tr>
- <td colspan="3">
+ <tr>
+ <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">string</span>
- </div>
- </td>
- <td>
- <ul style="margin: 0; padding: 0"><b>Choices:</b>
- <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></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>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></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>
- </table>
+ </table>
<br/>
@@ -570,7 +574,6 @@ Examples
.. code-block:: yaml+jinja
-
- name: configure interface
vyos.vyos.vyos_interface:
name: eth0
@@ -634,7 +637,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:
@@ -647,24 +649,24 @@ 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>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, except for the platforms that use Netconf transport to manage the device.</td>
<td>
- <div>The list of configuration mode commands to send to the device</div>
- <br/>
- <div style="font-size: smaller"><b>Sample:</b></div>
- <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[&#x27;set interfaces ethernet eth0 description &quot;test-interface&quot;&#x27;, &#x27;set interfaces ethernet eth0 speed 100&#x27;, &#x27;set interfaces ethernet eth0 mtu 256&#x27;, &#x27;set interfaces ethernet eth0 duplex full&#x27;]</div>
- </td>
+ <div>The list of configuration mode commands to send to the device</div>
+ <br/>
+ <div style="font-size: smaller"><b>Sample:</b></div>
+ <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[&#x27;set interfaces ethernet eth0 description &quot;test-interface&quot;&#x27;, &#x27;set interfaces ethernet eth0 speed 100&#x27;, &#x27;set interfaces ethernet eth0 mtu 256&#x27;, &#x27;set interfaces ethernet eth0 duplex full&#x27;]</div>
+ </td>
</tr>
- </table>
+ </table>
<br/><br/>
@@ -680,5 +682,3 @@ Authors
~~~~~~~
- Ganesh Nalawade (@ganeshrn)
-
-