* adding OS9 ansible collections * adding OS9 collections * adding licensing, documentation changes * fix for bugs reported by ansible sanity test * fix for bugs reported by ansible sanity test * adding documentation review changes and sanity folder Co-authored-by: Patil <Komal_uttamrao_Patil@Dell.com> |
||
---|---|---|
.. | ||
defaults | ||
handlers | ||
meta | ||
tasks | ||
templates | ||
tests | ||
vars | ||
LICENSE | ||
README.md |
LAG role
This role facilitates the configuration of link aggregation group (LAG) attributes, and supports the creation and deletion of a LAG and its member ports. It also supports the configuration of an interface type as a static or dynamic LAG and minimum required link. This role is abstracted for Dell EMC PowerSwitch platforms running Dell EMC OS9.
The LAG role requires an SSH connection for connectivity to a Dell EMC OS9 device. You can use any of the built-in OS connection variables.
Role variables
- Role is abstracted using the
ansible_network_os
variable that can takedellemc.os9.os9
as the value - Object drives the tasks in this role
os9_lag
(dictionary) contains the hostname (dictionary)- Hostname is the value of the hostname variable that corresponds to the name of the OS device
- Any role variable with a corresponding state variable setting to absent negates the configuration of that variable
- Setting an empty value to any variable negates the corresponding configuration
os9_lag
(dictionary) holds a dictionary with the port-channel ID key inPo <ID>
format (1 to 4096)- Variables and values are case-sensitive
port-channel ID keys
Key | Type | Description | Support |
---|---|---|---|
type |
string: static,dynamic | Configures the interface either as a static or dynamic LAG | os9 |
min_links |
integer | Configures the minimum number of links in the LAG that must be in operup status (1 to 64 for os9) | os9 |
lacp |
dictionary | Specifies LACP fast-switchover or long timeout options | os9 |
lacp.fast_switchover |
boolean | Configures the fast-switchover option if set to true | os9 |
lacp.long_timeout |
boolean | Configures the long-timeout option if set to true | os9 |
lacp_system_priority |
integer | Configures the LACP system-priority value (1 to 65535) | os9 |
lacp_ungroup_vlt |
boolean | Configures all VLT LACP members to be switchports if set to true | os9 |
lacp_ungroup |
list | Specifies the list of port-channels to become switchports (see lacp_ungroup.* ) |
os9 |
lacp_ungroup.port_channel |
integer (required) | Specifies valid port-channel numbers | os9 |
lacp_ungroup.state |
string: present,absent* | Deletes the ungroup association if set to absent | os9 |
channel_members |
list | Specifies the list of port members to be associated to the port-channel (see channel_members.* ) |
os9 |
channel_members.port |
string | Specifies valid os9 | os9 |
channel_members.state |
string: absent,present | Deletes the port member association if set to absent | os9 |
state |
string: absent,present* | Deletes the LAG corresponding to the port-channel ID if set to absent | os9 |
NOTE: Asterisk (*) denotes the default value if none is specified.
Connection variables
Ansible Dell EMC network roles require connection information to establish communication with the nodes in your inventory. This information can exist in the Ansible group_vars or host_vars directories or inventory, or in the playbook itself.
Key | Required | Choices | Description |
---|---|---|---|
ansible_host |
yes | Specifies the hostname or address for connecting to the remote device over the specified transport | |
ansible_port |
no | Specifies the port used to build the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_PORT option is used; it defaults to 22 |
|
ansible_ssh_user |
no | Specifies the username that authenticates the CLI login for the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_USER environment variable value is used |
|
ansible_ssh_pass |
no | Specifies the password that authenticates the connection to the remote device. | |
ansible_become |
no | yes, no* | Instructs the module to enter privileged mode on the remote device before sending any commands; if value is unspecified, the ANSIBLE_BECOME environment variable value is used, and the device attempts to execute all commands in non-privileged mode |
ansible_become_method |
no | enable, sudo* | Instructs the module to allow the become method to be specified for handling privilege escalation; if value is unspecified, the ANSIBLE_BECOME_METHOD environment variable value is used |
ansible_become_pass |
no | Specifies the password to use if required to enter privileged mode on the remote device; if ansible_become is set to no this key is not applicable |
|
ansible_network_os |
yes | os9, null* | Loads the correct terminal and cliconf plugins to communicate with the remote device |
NOTE: Asterisk (*) denotes the default value if none is specified.
Example playbook
This example uses the os9_lag role to setup port channel ID and description, and configures hash algorithm and minimum links for the LAG. Channel members can be configured for the port-channel either in static or dynamic mode. You can also delete the LAG with the port-channel ID or delete the members associated to it. This example creates a hosts file with the switch details and corresponding variables. The hosts file should define the ansible_network_os
variable with corresponding Dell EMC OS9 name.
When os9_cfg_generate
is set to true, the variable generates the configuration commands as a .part file in build_dir path. By default, the variable is set to false. It writes a simple playbook that only references the os9_lag role.
Sample hosts file
leaf1 ansible_host= <ip_address>
Sample host_vars/leaf1
hostname: leaf1
ansible_become: yes
ansible_become_method: xxxxx
ansible_become_pass: xxxxx
ansible_ssh_user: xxxxx
ansible_ssh_pass: xxxxx
ansible_network_os: dellemc.os9.os9
build_dir: ../temp/os9
os9_lag:
Po 127:
type: static
min_links: 3
lacp:
long_timeout: true
fast_switchover: true
lacp_system_priority: 1
lacp_ungroup_vlt: true
lacp_ungroup:
- port-channel:1
state: present
channel_members:
- port: fortyGigE 1/4
state: present
- port: fortyGigE 1/5
state: present
state: present
Simple playbook to setup system — leaf.yaml
- hosts: leaf1
roles:
- dellemc.os9.os9_lag
Run
ansible-playbook -i hosts leaf.yaml
(c) 2017-2020 Dell Inc. or its subsidiaries. All rights reserved.