wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cumulus - consistent docs formatting

Browse source
This commit is contained in:
John Barker 2016-08-04 12:18:06 +01:00 committed by Matt Clay
parent 6857cea9e6
commit 6ad7d6b3cd
7 changed files with 119 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
lib/ansible/modules/network/cumulus/cl_bond.py
View file

@ -25,70 +25,79 @@ description:
- Configures a bond interface on Cumulus Linux To configure a bridge port - Configures a bond interface on Cumulus Linux To configure a bridge port
use the cl_bridge module. To configure any other type of interface use the use the cl_bridge module. To configure any other type of interface use the
cl_interface module. Follow the guidelines for bonding found in the cl_interface module. Follow the guidelines for bonding found in the
Cumulus User Guide at http://docs.cumulusnetworks.com Cumulus User Guide at U(http://docs.cumulusnetworks.com).
options: options:
name: name:
description: description:
- name of the interface - Name of the interface.
required: true required: true
alias_name: alias_name:
description: description:
- add a port description - Description of the port.
ipv4: ipv4:
description: description:
- list of IPv4 addresses to configure on the interface. - List of IPv4 addresses to configure on the interface.
use X.X.X.X/YY syntax. In the form I(X.X.X.X/YY).
ipv6: ipv6:
description: description:
- list of IPv6 addresses to configure on the interface. - List of IPv6 addresses to configure on the interface.
use X:X:X::X/YYY syntax In the form I(X:X:X::X/YYY).
addr_method: addr_method:
description: description:
- configures the port to use DHCP. - Configures the port to use DHCP.
To enable this feature use the option 'dhcp' To enable this feature use the option I(dhcp).
choices: ['dhcp'] choices: ['dhcp']
mtu: mtu:
description: description:
- set MTU. Configure Jumbo Frame by setting MTU to 9000. - Set MTU. Configure Jumbo Frame by setting MTU to I(9000).
virtual_ip: virtual_ip:
description: description:
- define IPv4 virtual IP used by the Cumulus Linux VRR feature - Define IPv4 virtual IP used by the Cumulus Linux VRR feature.
virtual_mac: virtual_mac:
description: description:
- define Ethernet mac associated with Cumulus Linux VRR feature - Define Ethernet mac associated with Cumulus Linux VRR feature.
vids: vids:
description: description:
- in vlan aware mode, lists vlans defined under the interface - In vlan-aware mode, lists VLANs defined under the interface.
mstpctl_bpduguard: mstpctl_bpduguard:
description: description:
- Enables BPDU Guard on a port in vlan-aware mode - Enables BPDU Guard on a port in vlan-aware mode.
choices:
- true
- false
mstpctl_portnetwork: mstpctl_portnetwork:
description: description:
- Enables bridge assurance in vlan-aware mode - Enables bridge assurance in vlan-aware mode.
choices:
- true
- false
mstpctl_portadminedge: mstpctl_portadminedge:
description: description:
- Enables admin edge port - Enables admin edge port.
choices:
- true
- false
clag_id: clag_id:
description: description:
- specify a unique clag_id for every dual connected bond on each - Specify a unique clag_id for every dual connected bond on each
peer switch. The value must be between 1 and 65535 and must be the peer switch. The value must be between 1 and 65535 and must be the
same on both peer switches in order for the bond to be considered same on both peer switches in order for the bond to be considered
dual-connected dual-connected.
pvid: pvid:
description: description:
- in vlan aware mode, defines vlan that is the untagged vlan - In vlan-aware mode, defines vlan that is the untagged vlan.
miimon: miimon:
description: description:
- mii link monitoring interval - The mii link monitoring interval.
default: 100 default: 100
mode: mode:
description: description:
- bond mode. as of Cumulus Linux 2.5 only LACP bond mode is - The bond mode, as of Cumulus Linux 2.5 only LACP bond mode is
supported supported.
default: '802.3ad' default: '802.3ad'
min_links: min_links:
description: description:
- minimum number of links - Minimum number of links.
default: 1 default: 1
lacp_bypass_allow: lacp_bypass_allow:
description: description:
@ -98,7 +107,7 @@ options:
- Period for enabling LACP bypass. Max value is 900. - Period for enabling LACP bypass. Max value is 900.
lacp_bypass_priority: lacp_bypass_priority:
description: description:
- List of ports and priorities. Example "swp1=10, swp2=20" - List of ports and priorities. Example I("swp1=10, swp2=20").
lacp_bypass_all_active: lacp_bypass_all_active:
description: description:
- Activate all interfaces for bypass. - Activate all interfaces for bypass.
@ -106,28 +115,28 @@ options:
of using bypass_priority. of using bypass_priority.
lacp_rate: lacp_rate:
description: description:
- lacp rate - The lacp rate.
default: 1 default: 1
slaves: slaves:
description: description:
- bond members - Bond members.
required: True required: True
xmit_hash_policy: xmit_hash_policy:
description: description:
- transmit load balancing algorithm. As of Cumulus Linux 2.5 only - Transmit load balancing algorithm. As of Cumulus Linux 2.5 only
layer3+4 policy is supported I(layer3+4) policy is supported.
default: layer3+4 default: layer3+4
location: location:
description: description:
- interface directory location - Interface directory location.
default: default:
- /etc/network/interfaces.d - '/etc/network/interfaces.d'
requirements: [ Alternate Debian network interface manager - \ requirements: [ Alternate Debian network interface manager - \
ifupdown2 @ github.com/CumulusNetworks/ifupdown2 ] ifupdown2 @ github.com/CumulusNetworks/ifupdown2 ]
notes: notes:
- because the module writes the interface directory location. Ensure that - As this module writes the interface directory location, ensure that
``/etc/network/interfaces`` has a 'source /etc/network/interfaces.d/*' or ``/etc/network/interfaces`` has a 'source /etc/network/interfaces.d/\*' or
whatever path is mentioned in the ``location`` attribute. whatever path is mentioned in the ``location`` attribute.
- For the config to be activated, i.e installed in the kernel, - For the config to be activated, i.e installed in the kernel,

46
lib/ansible/modules/network/cumulus/cl_bridge.py
View file

@ -25,71 +25,73 @@ description:
- Configures a bridge interface on Cumulus Linux To configure a bond port - Configures a bridge interface on Cumulus Linux To configure a bond port
use the cl_bond module. To configure any other type of interface use the use the cl_bond module. To configure any other type of interface use the
cl_interface module. Follow the guidelines for bridging found in the cl_interface module. Follow the guidelines for bridging found in the
Cumulus User Guide at http://docs.cumulusnetworks.com Cumulus User Guide at U(http://docs.cumulusnetworks.com)
options: options:
name: name:
description: description:
- name of the interface - Name of the interface.
required: true required: true
alias_name: alias_name:
description: description:
- add a port description - Description of the port.
ipv4: ipv4:
description: description:
- list of IPv4 addresses to configure on the interface. - List of IPv4 addresses to configure on the interface.
use X.X.X.X/YY syntax. In the form I(X.X.X.X/YY).
ipv6: ipv6:
description: description:
- list of IPv6 addresses to configure on the interface. - List of IPv6 addresses to configure on the interface.
use X:X:X::X/YYY syntax In the form I(X:X:X::X/YYY).
addr_method: addr_method:
description: description:
- configures the port to use DHCP. - Configures the port to use DHCP.
To enable this feature use the option 'dhcp' To enable this feature use the option I(dhcp).
choices: ['dhcp'] choices: ['dhcp']
mtu: mtu:
description: description:
- set MTU. Configure Jumbo Frame by setting MTU to 9000. - Set MTU. Configure Jumbo Frame by setting MTU to I(9000).
virtual_ip: virtual_ip:
description: description:
- define IPv4 virtual IP used by the Cumulus Linux VRR feature - Define IPv4 virtual IP used by the Cumulus Linux VRR feature.
virtual_mac: virtual_mac:
description: description:
- define Ethernet mac associated with Cumulus Linux VRR feature - Define Ethernet mac associated with Cumulus Linux VRR feature.
vids: vids:
description: description:
- in vlan aware mode, lists vlans defined under the interface - In vlan-aware mode, lists VLANs defined under the interface.
pvid: pvid:
description: description:
- in vlan aware mode, defines vlan that is the untagged vlan - In vlan-aware mode, defines vlan that is the untagged vlan.
stp: stp:
description: description:
- enables spanning tree. As of Cumulus Linux 2.5 the default - Enables spanning tree Protocol. As of Cumulus Linux 2.5 the default
bridging mode, only per vlan RSTP or 802.1d is supported. For the bridging mode, only per vlan RSTP or 802.1d is supported. For the
vlan aware mode, only common instance STP is supported vlan aware mode, only common instance STP is supported
default: 'yes' default: 'yes'
choices: ['yes', 'no']
ports: ports:
description: description:
- list of bridge members - List of bridge members.
required: True required: True
vlan_aware: vlan_aware:
description: description:
- enables vlan aware mode. - Enables vlan-aware mode.
choices: ['yes', 'no']
mstpctl_treeprio: mstpctl_treeprio:
description: description:
- set spanning tree root priority. Must be a multiple of 4096 - Set spanning tree root priority. Must be a multiple of 4096.
location: location:
description: description:
- interface directory location - Interface directory location.
default: default:
- /etc/network/interfaces.d - '/etc/network/interfaces.d'
requirements: [ Alternate Debian network interface manager requirements: [ Alternate Debian network interface manager
ifupdown2 @ github.com/CumulusNetworks/ifupdown2 ] ifupdown2 @ github.com/CumulusNetworks/ifupdown2 ]
notes: notes:
- because the module writes the interface directory location. Ensure that - As this module writes the interface directory location, ensure that
``/etc/network/interfaces`` has a 'source /etc/network/interfaces.d/*' or ``/etc/network/interfaces`` has a 'source /etc/network/interfaces.d/\*' or
whatever path is mentioned in the ``location`` attribute. whatever path is mentioned in the ``location`` attribute.
- For the config to be activated, i.e installed in the kernel, - For the config to be activated, i.e installed in the kernel,

10
lib/ansible/modules/network/cumulus/cl_img_install.py
View file

@ -23,19 +23,19 @@ author: "Cumulus Networks (@CumulusLinux)"
short_description: Install a different Cumulus Linux version. short_description: Install a different Cumulus Linux version.
description: description:
- install a different version of Cumulus Linux in the inactive slot. For - install a different version of Cumulus Linux in the inactive slot. For
more details go the Image Management User Guide @ more details go the Image Management User Guide at
http://docs.cumulusnetworks.com/ U(http://docs.cumulusnetworks.com/).
options: options:
src: src:
description: description:
- full path to the Cumulus Linux binary image. Can be a local path, - The full path to the Cumulus Linux binary image. Can be a local path,
http or https URL. If the code version is in the name of the file, http or https URL. If the code version is in the name of the file,
the module will assume this is the version of code you wish to the module will assume this is the version of code you wish to
install. install.
required: true required: true
version: version:
description: description:
- inform the module of the exact version one is installing. This - Inform the module of the exact version one is installing. This
overrides the automatic check of version in the file name. For overrides the automatic check of version in the file name. For
example, if the binary file name is called CumulusLinux-2.2.3.bin, example, if the binary file name is called CumulusLinux-2.2.3.bin,
and version is set to '2.5.0', then the module will assume it is and version is set to '2.5.0', then the module will assume it is
@ -46,7 +46,7 @@ options:
switch_slot: switch_slot:
description: description:
- Switch slots after installing the image. - Switch slots after installing the image.
To run the installed code, reboot the switch To run the installed code, reboot the switch.
choices: ['yes', 'no'] choices: ['yes', 'no']
default: 'no' default: 'no'
required: false required: false

57
lib/ansible/modules/network/cumulus/cl_interface.py
View file

@ -28,83 +28,84 @@ description:
bond ports use the cl_bond module. When configuring bridge related bond ports use the cl_bond module. When configuring bridge related
features like the "vid" option, please follow the guidelines for features like the "vid" option, please follow the guidelines for
configuring "vlan aware" bridging. For more details review the Layer2 configuring "vlan aware" bridging. For more details review the Layer2
Interface Guide at http://docs.cumulusnetworks.com Interface Guide at U(http://docs.cumulusnetworks.com)
options: options:
name: name:
description: description:
- name of the interface - Name of the interface.
required: true required: true
alias_name: alias_name:
description: description:
- add a port description - Description of the port.
ipv4: ipv4:
description: description:
- list of IPv4 addresses to configure on the interface. - List of IPv4 addresses to configure on the interface.
use X.X.X.X/YY syntax. In the form I(X.X.X.X/YY).
ipv6: ipv6:
description: description:
- list of IPv6 addresses to configure on the interface. - List of IPv6 addresses to configure on the interface.
use X:X:X::X/YYY syntax In the form I(X:X:X::X/YYY).
addr_method: addr_method:
description: description:
- can be loopback for loopback interfaces or dhcp for dhcp - Address method.
interfaces. choices:
- loopback
- dhcp
speed: speed:
description: description:
- set speed of the swp(front panel) or management(eth0) interface. - Set speed of the swp(front panel) or management(eth0) interface.
speed is in MB speed is in MB.
mtu: mtu:
description: description:
- set MTU. Configure Jumbo Frame by setting MTU to 9000. - Set MTU. Configure Jumbo Frame by setting MTU to I(9000).
virtual_ip: virtual_ip:
description: description:
- define IPv4 virtual IP used by the Cumulus VRR feature - Define IPv4 virtual IP used by the Cumulus Linux VRR feature.
virtual_mac: virtual_mac:
description: description:
- define Ethernet mac associated with Cumulus VRR feature - Define Ethernet mac associated with Cumulus Linux VRR feature.
vids: vids:
description: description:
- in vlan aware mode, lists vlans defined under the interface - In vlan-aware mode, lists VLANs defined under the interface.
mstpctl_bpduguard: mstpctl_bpduguard:
description: description:
- Enables BPDU Guard on a port in vlan-aware mode - Enables BPDU Guard on a port in vlan-aware mode.
mstpctl_portnetwork: mstpctl_portnetwork:
description: description:
- Enables bridge assurance in vlan-aware mode - Enables bridge assurance in vlan-aware mode.
mstpctl_portadminedge: mstpctl_portadminedge:
description: description:
- Enables admin edge port - Enables admin edge port.
clagd_enable: clagd_enable:
description: description:
- Enables the clagd daemon. This command should only be applied to - Enables the clagd daemon. This command should only be applied to
the clag peerlink interface the clag peerlink interface.
clagd_priority: clagd_priority:
description: description:
- Integer that changes the role the switch has in the clag domain. - Integer that changes the role the switch has in the clag domain.
The lower priority switch will assume the primary role. The number The lower priority switch will assume the primary role. The number
can be between 0 and 65535 can be between 0 and 65535.
clagd_peer_ip: clagd_peer_ip:
description: description:
- IP address of the directly connected peer switch interface - IP address of the directly connected peer switch interface.
clagd_sys_mac: clagd_sys_mac:
description: description:
- Clagd system mac address. Recommended to use the range starting - Clagd system mac address. Recommended to use the range starting
with 44:38:39:ff. Needs to be the same between 2 Clag switches with 44:38:39:ff. Needs to be the same between 2 Clag switches.
pvid: pvid:
description: description:
- in vlan aware mode, defines vlan that is the untagged vlan - In vlan-aware mode, defines vlan that is the untagged vlan.
location: location:
description: description:
- interface directory location - Interface directory location
default: default:
- /etc/network/interfaces.d - '/etc/network/interfaces.d'
requirements: [ Alternate Debian network interface manager - \ requirements: [ Alternate Debian network interface manager - \
ifupdown2 @ github.com/CumulusNetworks/ifupdown2 ] ifupdown2 @ github.com/CumulusNetworks/ifupdown2 ]
notes: notes:
- because the module writes the interface directory location. Ensure that - As this module writes the interface directory location, ensure that
``/etc/network/interfaces`` has a 'source /etc/network/interfaces.d/*' or ``/etc/network/interfaces`` has a 'source /etc/network/interfaces.d/\*' or
whatever path is mentioned in the ``location`` attribute. whatever path is mentioned in the ``location`` attribute.
- For the config to be activated, i.e installed in the kernel, - For the config to be activated, i.e installed in the kernel,

7
lib/ansible/modules/network/cumulus/cl_interface_policy.py
View file

@ -29,17 +29,18 @@ description:
the switch, but not found in the "allowed" list, this interface will be the switch, but not found in the "allowed" list, this interface will be
unconfigured. By default this is `/etc/network/interface.d` unconfigured. By default this is `/etc/network/interface.d`
For more details go the Configuring Interfaces at For more details go the Configuring Interfaces at
http://docs.cumulusnetworks.com U(http://docs.cumulusnetworks.com).
notes: notes:
- lo must be included in the allowed list. - lo must be included in the allowed list.
- eth0 must be in allowed list if out of band management is done - eth0 must be in allowed list if out of band management is done
options: options:
allowed: allowed:
description: description:
- list of ports to run initial run at 10G - List of ports to run initial run at 10G.
required: true
location: location:
description: description:
- folder to store interface files. - Directory to store interface files.
default: '/etc/network/interfaces.d/' default: '/etc/network/interfaces.d/'
''' '''

18
lib/ansible/modules/network/cumulus/cl_license.py
View file

@ -24,14 +24,14 @@ short_description: Install Cumulus Linux license
description: description:
- Installs a Cumulus Linux license. The module reports no change of status - Installs a Cumulus Linux license. The module reports no change of status
when a license is installed. when a license is installed.
For more details go the Cumulus Linux License Documentation @ For more details go the Cumulus Linux License Documentation at
http://docs.cumulusnetwork.com and the Licensing KB Site @ U(http://docs.cumulusnetwork.com) and the Licensing KB Site at
https://support.cumulusnetworks.com/hc/en-us/sections/200507688 U(https://support.cumulusnetworks.com/hc/en-us/sections/200507688)
notes: notes:
- to activate a license for the FIRST time, the switchd service must be - To activate a license for the FIRST time, the switchd service must be
restarted. This action is disruptive. The license renewal process occurs restarted. This action is disruptive. The license renewal process occurs
via the Cumulus Networks Customer Portal - via the Cumulus Networks Customer Portal -
http://customers.cumulusnetworks.com. U(http://customers.cumulusnetworks.com).
- A non-EULA license is REQUIRED for automation. Manually install the - A non-EULA license is REQUIRED for automation. Manually install the
license on a test switch, using the command "cl-license -i <license_file>" license on a test switch, using the command "cl-license -i <license_file>"
to confirm the license is a Non-EULA license. to confirm the license is a Non-EULA license.
@ -39,15 +39,19 @@ notes:
options: options:
src: src:
description: description:
- full path to the license. Can be local path or http url - The full path to the license. Can be local path or HTTP URL.
required: true
force: force:
description: description:
- force installation of a license. Typically not needed. - Force installation of a license. Typically not needed.
It is recommended to manually run this command via the ansible It is recommended to manually run this command via the ansible
command. A reload of switchd is not required. Running the force command. A reload of switchd is not required. Running the force
option in a playbook will break the idempotent state machine of option in a playbook will break the idempotent state machine of
the module and cause the switchd notification to kick in all the the module and cause the switchd notification to kick in all the
time, causing a disruption. time, causing a disruption.
choices:
- yes
- no
''' '''
EXAMPLES = ''' EXAMPLES = '''

10
lib/ansible/modules/network/cumulus/cl_ports.py
View file

@ -27,20 +27,20 @@ description:
to not include ports that do not exist on the switch. Carefully read the to not include ports that do not exist on the switch. Carefully read the
original ports.conf file for any exceptions or limitations. original ports.conf file for any exceptions or limitations.
For more details go the Configure Switch Port Attribute Documentation at For more details go the Configure Switch Port Attribute Documentation at
http://docs.cumulusnetworks.com U(http://docs.cumulusnetworks.com).
options: options:
speed_10g: speed_10g:
description: description:
- list of ports to run initial run at 10G - List of ports to run initial run at 10G.
speed_40g: speed_40g:
description: description:
- list of ports to run initial run at 40G - List of ports to run initial run at 40G.
speed_4_by_10g: speed_4_by_10g:
description: description:
- list of 40G ports that will be unganged to run as 4 10G ports. - List of 40G ports that will be unganged to run as 4 10G ports.
speed_40g_div_4: speed_40g_div_4:
description: description:
- list of 10G ports that will be ganged to form a 40G port - List of 10G ports that will be ganged to form a 40G port.
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example playbook entries using the cl_ports module to manage the switch Example playbook entries using the cl_ports module to manage the switch