Switches config

Description

The switches config role performs the following tasks:

  • VLAN configuration access/trunk on the switch port.

  • MTU configuration on the switch port.

  • LACP configuration on interface and members attach.

  • IGMP Snooping configuration

Supported switch platforms:

  • Cisco

  • Juniper

  • Mellanox MLNX-OS (ONYX with JSON API is not supported due to not having access to a compatible switch)

For Juniper switches, Ansible modules use the netconf capability lock, which is equivalent to the CLI command configure exclusive, which means parallel execution is impossible.. We are doing a check to avoid this if the configuration database is open. It will automatically retry 3 times every 15 minutes if it is not open (by default). This hack might not be stable.

Inventory

The play requires an inventory file that will describe switches that the playbook should run on. Note - Switches are static resources that not changing frequently. As a result the inventory could be static and not generated dynamically. The inventory for this playbook should be created by the user.

[ios]
cisco_switch01 ansible_host=10.10.10.120

[junos]
juniper_switch01 ansible_host=10.10.10.100
juniper_switch02 ansible_host=10.10.10.101

[onyx]
mlx_switch01 ansible_host=10.10.10.131

[switches:children]
ios
junos
onyx

[switches:vars]
ansible_user=root

[ios:vars]
ansible_network_os=ios
ansible_connection=network_cli
ansible_become=yes
ansible_become_method=enable

[junos:vars]
ansible_network_os=junos
ansible_connection=netconf

[onyx:vars]
ansible_user=admin
ansible_password=admin
ansible_become_password=admin
ansible_connection=network_cli
ansible_network_os=onyx
ansible_become=yes
ansible_become_method=enable

Variables

The names of the switches in the variables should represent the name of the switch in the inventory.

juniper_switch01:
  switch_banner: |
    MOTD can
    span multiple lines
  vlans:
    - start: 10
      end: 20
    - start: 50
      end: 55
  interfaces:
    - { description: 'host1_port1', iface: 'xe-0/0/0', iface_mode: 'access', vlan: '10', mtu: '9000' }
    - { description: 'host2_port3', iface: 'xe-0/0/1', iface_mode: 'trunk', vlan: '15-20', mtu: '9000' }
    - { description: 'host3_port1', iface: 'xe-0/0/4', iface_mode: 'trunk', vlan: '50-53' }
    - { description: 'aggregation', iface: 'ae2', iface_mode: 'trunk', vlan: '53-55', mtu: '9192', aggr_members: ['xe-0/0/12', 'xe-0/0/13'] }
  igmp_snooping:
    - { vlan: '55', ip_address: '10.20.155.5', interfaces: ['ae2'] }

juniper_switch02:
  vlans:
    - start: 25
      end: 30
    - start: 70
      end: 75
  interfaces:
    - { description: 'host1_port1', iface: 'xe-0/0/0', iface_mode: 'trunk', vlan: '25-27', mtu: '9000' }
    - { description: 'host2_port3', iface: 'xe-0/0/1', iface_mode: 'access', vlan: '29', mtu: '9000' }
    - { description: 'host3_port1', iface: 'xe-0/0/4', iface_mode: 'trunk', vlan: '70-75' }
    - { description: 'host3_port1', iface: 'xe-0/0/5', iface_mode: 'trunk', vlan: '70' }
  # The play assumes that all layer3 interfaces are of type 'irb'
  # 'vlan_interface' name is <vlan><vlan_id>
  layer3_interfaces:
    - unit: '110'
      ipv4_address: '192.168.110.254/24'
      vlan_interface: 'vlan110'
    - unit: '199'
      ipv4_address: '192.168.199.254/24'
      vlan_interface: 'vlan999'

cisco_switch01:
  switch_banner: |
    MOTD can
    span multiple lines
  # Generates the following commands:
  # route-map Test-RouteMap permit 10
  #   match ip address Test-RouteMap-ACL
  #   set ip next-hop 192.168.20.1
  # interface vlan 21
  #   ip policy route-map Test-RouteMap
  route_maps:
    - route_map_name: Test-RouteMap
      match_ip_address: Test-RouteMap-ACL
      ip_next_hop: 192.168.20.1
      interface: vlan21
  vlans:
    - start: 100
      end: 105
  interfaces:
     - { description: 'tigon15', iface: 'GigabitEthernet5/0/6', iface_mode: 'access', vlan: '20' }
     - { description: 'tigon16', iface: 'GigabitEthernet5/0/7', iface_mode: 'access', vlan: '20' }
     - { description: 'tigon17', iface: 'GigabitEthernet5/0/8', iface_mode: 'access', vlan: '90' }
     - { description: 'uplink_port', iface: 'GigabitEthernet5/0/9', iface_mode: 'trunk', vlan: '', encapsulation: true }
  vlan_interfaces:
    - iface: vlan20
      ip_address: 192.168.20.200
      netmask: 255.255.255.0
    - iface: vlan21
      ip_address: 192.168.21.254
      netmask: 255.255.255.0
      ip_helper_address:
        - 192.168.20.1
        - 192.168.20.5

mlx_switch01:
  switch_banner: |
    "MOTD is in double quotes"
  vlans:
    - start: 110
      end: 119
  interfaces:
    - description: "{'host': 'tigon15', 'nic_biosdevname': 'p6p1', 'nic_kernel_predictable_name': 'enp7s0f0', 'description': 'Mellanox NIC1 port0'}"
      iface: 'ethernet 1/1'
      iface_mode: 'trunk'
      vlan: '110-115'
      mtu: 9192
    - description: "{'host': 'tigon16', 'nic_biosdevname': 'p6p2', 'nic_kernel_predictable_name': 'enp7s0f1', 'description': 'Mellanox NIC1 port1'}"
      iface: 'ethernet 1/2'
      iface_mode: 'trunk'
      vlan: '110-114, 116'
      mtu: 9192
    - description: "{'host': 'kodkod01', 'nic_biosdevname': 'p6p2', 'nic_kernel_predictable_name': 'enp7s0f1', 'description': 'Mellanox NIC1 port0'}"
      iface: 'ethernet 1/3'
      iface_mode: 'acess'
      vlan: 118
      mtu: 9192

  • cifmw_switch_config_task_retry_delay: (int) The delay time between retries when DB is locked, defaults to 900.

  • cifmw_switch_config_task_retries: (int) Number of retries when DB is locked, defaults to 3.

Example

Example on applying switch configuration

 ansible-playbook -i /path/to/inventory switch_config.yml -e @vars_file_config.yml