Configure Cisco NX-OS Vlan doc #49
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sumit Jaiswal <[email protected]>
Signed-off-by: Sumit Jaiswal <[email protected]>
|
Build succeeded.
|
samccann
reviewed
Dec 3, 2018
There was a problem hiding this comment.
I made an attempt to clarify a few things here. Not sure if I did actually clarify or not since I got confused part way through on the VLAN state, status, etc and what the final default values would be on the nxos device if the user didn't set anything here besides the VLAN ID.
| # Configure VLANs on the device | ||
|
|
||
| The `configure_vlans` function can be used to set VLANs on Cisco NX-OS devices. | ||
| This function is only supported over `network_cli` connection type and |
There was a problem hiding this comment.
Suggested change
| This function is only supported over `network_cli` connection type and | |
| This function is only supported over the `network_cli` connection type and |
| status: active | ||
| ``` | ||
|
|
||
| The above playbook will set the VLANs with ID, description, and address to particular |
There was a problem hiding this comment.
Suggested change
| The above playbook will set the VLANs with ID, description, and address to particular | |
| The above playbook will set the VLANs with ID, description, and address to a particular |
| using either the `roles` directive or the `tasks` directive. If no other | ||
| options are provided, then all of the available facts will be collected for | ||
| the device. | ||
|
|
There was a problem hiding this comment.
Suggested change
| ## How to set VLANs using roles |
| This function is only supported over `network_cli` connection type and | ||
| requires the `ansible_network_os` value set to `nxos`. | ||
|
|
||
| ## How to set VLANs on the device |
There was a problem hiding this comment.
Suggested change
| ## How to set VLANs on the device |
| The above playbook will set the VLANs with ID, description, and address to particular | ||
| interface under the `nxos` top level key. | ||
|
|
||
| ### Implement using tasks |
There was a problem hiding this comment.
Suggested change
| ### Implement using tasks | |
| ### How to set VLANs using tasks |
|
|
||
| ### status | ||
|
|
||
| This sets the status for the VLAN Id for the Cisco NX-OS device. |
There was a problem hiding this comment.
Suggested change
| This sets the status for the VLAN Id for the Cisco NX-OS device. | |
| This is an optional parameter that sets the status for the VLAN ID for the Cisco NX-OS device. The valid values are `active` or `suspend`. |
|
|
||
| This sets the status for the VLAN Id for the Cisco NX-OS device. | ||
|
|
||
| The default value is `omit` which means even if the user doesn't pass the respective |
There was a problem hiding this comment.
Suggested change
| The default value is `omit` which means even if the user doesn't pass the respective | |
| The default value is `omit` which means the role will continue to run, with the default status of `active`. |
There was a problem hiding this comment.
making another guess here based on reading the nxos_vlan module docs...
| This sets the status for the VLAN Id for the Cisco NX-OS device. | ||
|
|
||
| The default value is `omit` which means even if the user doesn't pass the respective | ||
| value the role will continue to run without any failure. |
There was a problem hiding this comment.
Suggested change
| value the role will continue to run without any failure. |
|
|
||
| ### state | ||
|
|
||
| This sets the VLANs value to the Cisco NX-OS device and if the value of the state is changed |
There was a problem hiding this comment.
Suggested change
| This sets the VLANs value to the Cisco NX-OS device and if the value of the state is changed | |
| This is an optional parameter that sets the VLAN state to the Cisco NX-OS device. The options are `present` or `absent`. If the value of the state is changed |
| This sets the VLANs value to the Cisco NX-OS device and if the value of the state is changed | ||
| to `absent`, the role will go ahead and try to delete the VLANs via the arguments passed. | ||
|
|
||
| The default value is `present` which means even if the user doesn't pass the respective |
There was a problem hiding this comment.
Suggested change
| The default value is `present` which means even if the user doesn't pass the respective | |
| The default value is `present` which means even if the user doesn't pass the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Sumit Jaiswal [email protected]