diff options
Diffstat (limited to 'docs/vyos.vyos.vyos_vlan_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_vlan_module.rst | 513 |
1 files changed, 258 insertions, 255 deletions
diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index 084649f..d00260e 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -31,386 +31,393 @@ Parameters <tr> <th colspan="2">Parameter</th> <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> + <th width="100%">Comments</th> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>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> + </div> + </td> + <td> + </td> + <td> + <div>Configure Virtual interface address.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <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 VLANs definitions.</div> - </td> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>List of VLANs definitions.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>address</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Configure Virtual interface address.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>Configure Virtual interface address.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>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> + / <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"> + <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> + </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"> + <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> + / <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"> + <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> + </div> + </td> + <td> + </td> + <td> + <div>Name of the VLAN.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>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> + </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"> + <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> + / <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"> + + <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> + / <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 colspan="2"> + <tr> + <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> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> - <td> - <div>Delay the play should wait to check for declarative intent params values.</div> - </td> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">10</div> + </td> + <td> + <div>Delay the play should wait to check for declarative intent params values.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <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> </div> - </td> - <td> - </td> - <td> - <div>List of interfaces that should be associated to the VLAN.</div> - </td> + / <span style="color: purple">elements=string</span> + </div> + </td> + <td> + </td> + <td> + <div>List of interfaces that should be associated to the VLAN.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <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> - </div> - </td> - <td> - </td> - <td> - <div>Name of the VLAN.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>Name of the VLAN.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <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="1"> + <tr> + <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>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="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <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="1"> + <tr> + <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">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="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <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="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <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="1"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> <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="2"> + + <tr> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>purge</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><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Purge VLANs not defined in the <em>aggregate</em> parameter.</div> - </td> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>no</b> ←</div></li> + <li>yes</li> + </ul> + </td> + <td> + <div>Purge VLANs not defined in the <em>aggregate</em> parameter.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>State of the VLAN configuration.</div> - </td> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>present</b> ←</div></li> + <li>absent</li> + </ul> + </td> + <td> + <div>State of the VLAN configuration.</div> + </td> </tr> - <tr> - <td colspan="2"> + <tr> + <td colspan="2"> <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> - </div> - </td> - <td> - </td> - <td> - <div>ID of the VLAN. Range 0-4094.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>ID of the VLAN. Range 0-4094.</div> + </td> </tr> - </table> + </table> <br/> @@ -429,7 +436,6 @@ Examples .. code-block:: yaml+jinja - - name: Create vlan vyos.vyos.vyos_vlan: vlan_id: 100 @@ -472,7 +478,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: @@ -485,24 +490,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</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;">['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']</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;">['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']</div> + </td> </tr> - </table> + </table> <br/><br/> @@ -514,5 +519,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - |