cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fixed docs

Browse source
This commit is contained in:
Jason Edelman 2016-08-17 19:15:25 -04:00 committed by Matt Clay
parent 995083c0d9
commit 5640711166
1 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
lib/ansible/modules/network/nxos/nxos_switchport.py
View file

@ -18,7 +18,6 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: nxos_switchport module: nxos_switchport
version_added: "2.1" version_added: "2.1"
short_description: Manages Layer 2 switchport interfaces short_description: Manages Layer 2 switchport interfaces
@ -27,47 +26,40 @@ description:
- Manages Layer 2 interfaces - Manages Layer 2 interfaces
author: Jason Edelman (@jedelman8) author: Jason Edelman (@jedelman8)
notes: notes:
- When state=absent, vlans can be added/removed from trunk links and - When C(state=absent), VLANs can be added/removed from trunk links and
the existing access vlan can be 'unconfigured' to just having VLAN 1 the existing access VLAN can be 'unconfigured' to just having VLAN 1
on that interface on that interface
- When working with trunks VLANs the keywords add/remove are always sent - When working with trunks VLANs the keywords add/remove are always sent
in the `switchport trunk allowed vlan` command. Use verbose mode to see in the `switchport trunk allowed vlan` command. Use verbose mode to see
commands sent. commands sent.
- When state=unconfigured, the interface will result with having a default - When C(state=unconfigured), the interface will result with having a default
Layer 2 interface, i.e. vlan 1 in access mode Layer 2 interface, i.e. vlan 1 in access mode
options: options:
interface: interface:
description: description:
- Full name of the interface, i.e. Ethernet1/1 - Full name of the interface, i.e. Ethernet1/1.
required: true required: true
default: null default: null
mode: mode:
description: description:
- Mode for the Layer 2 port - Mode for the Layer 2 port.
required: false required: false
default: null default: null
choices: ['access','trunk'] choices: ['access','trunk']
access_vlan: access_vlan:
description: description:
- if mode=access, used as the access vlan id - If C(mode=access), used as the access VLAN ID.
required: false required: false
default: null default: null
native_vlan: native_vlan:
description: description:
- if mode=trunk, used as the trunk native vlan id - If C(mode=trunk), used as the trunk native VLAN ID.
required: false required: false
default: null default: null
trunk_vlans: trunk_vlans:
description: description:
- if mode=trunk, used as the vlan range to ADD or REMOVE - If C(mode=trunk), used as the VLAN range to ADD or REMOVE
from the trunk from the trunk.
required: false
aliases: trunk_add_vlans
default: null
trunk_allowed_vlans:
description:
- if mode=trunk, these are the only VLANs that should be
configured on the trunk
required: false required: false
default: null default: null
state: state:
@ -76,6 +68,12 @@ options:
required: false required: false
default: present default: present
choices: ['present','absent', 'unconfigured'] choices: ['present','absent', 'unconfigured']
trunk_allowed_vlans:
description:
- if mode=trunk, these are the only VLANs that should be
configured on the trunk
required: false
default: null
''' '''
EXAMPLES = ''' EXAMPLES = '''