eos_vlan

Synopsis

Added in version 1.0.0

The eos_vlan module manages VLAN configurations on Arista EOS nodes.

Options

parameter required default choices comments
enable no True
  • True
  • False
 Configures the administrative state for the VLAN. If enable is True then the VLAN is administratively enabled. If enable is False then the VLAN is administratively disabled.
(added in 1.0.0)
name no
    		An ASCII string identifer for this VLAN. The default value for the VLAN name is VLANxxxx where xxxx is the four digit VLAN ID.
    (added in 1.0.0)
    trunk_groups no
      		Configures the list of trunk groups associated with the VLAN in the node configuration. The list of trunk groups is a comma separated list. The default value for trunk_groups is an empty list.
      Note: The list of comma delimited values must not include spaces.
      (added in 1.0.0)
      vlanid yes
        		The unique VLAN identifier associated with this resource. The value for this identiifer must be in the range of 1 to 4094.
        (added in 1.0.0)

        Important

        Requires Arista EOS 4.13.7M or later with command API enabled

        Important

        Requires Python Client for eAPI 0.3.0 or later

        Examples


        - name: ensures vlan 100 is configured
  eos_vlan: vlanid=100 state=present

- name: ensures vlan 200 is not configured
  eos_vlan: vlanid=200 state=absent

- name: configures the vlan name
  eos_vlan: vlanid=1 name=TEST_VLAN_1

- name: configure trunk groups for vlan 10
  eos_vlan: vlanid=10 trunk_groups=tg1,tg2,tg3

        Note

        All configuration is idempotent unless otherwise specified

        Note

        Supports eos metaparameters for using the eAPI transport

        Note

        Supports stateful resource configuration.