eos_vxlan

Synopsis

Added in version 1.0.0

The eos_vxlan module manages the logical VxLAN interface configuration on Arista EOS nodes.

Options

parameter required default choices comments
description no
    		Configures a one lne ASCII description for the interface. The EOS default value for description is None
    (added in 1.0.0)
    enable no True
    • True
    • False
    		 Configures the administrative state for the interface. Setting the value to true will adminstrative enable the interface and setting the value to false will administratively disable the interface. The EOS default value for enable is true
    (added in 1.0.0)
    multicast_group no
      		Configures the vxlan multicast-group address used for flooding traffic between VTEPs. This value must be a valid multicast address in the range of 224/8. The EOS default value for vxlan multicast-group is None.
      (added in 1.0.0)
      name yes
        		The unique interface identifier name. The interface name must use the full interface name (no abbreviated names). For example, interfaces should be specified as Ethernet1 not Et1
        Note: The name parameter only accepts Vxlan1 as the identifier
        (added in 1.0.0)
        source_interface no
          		Configures the vxlan source-interface value which directs the interface to use the specified source interface address to source messages from. The configured value must be a Loopback interface. The EOS default value for source interface is None.
          (added in 1.0.0)
          udp_port no
            		Configures the vxlan udp-port value used to terminate mutlicast messages between VTEPs. This value must be an integer in the range of 1024 to 65535. The EOS default value for vxlan udp-port is 4789.
            (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 the vxlan interface is configured
  eos_vxlan: name=Vxlan1 state=present enable=yes

- name: ensures the vxlan interface is not configured
  eos_vxlan: name=Vxlan1 state=absent

- name: configures the vxlan source interface
  eos_vxlan: name=Vxlan1 source_interface=Loopback0

            Note

            All configuration is idempotent unless otherwise specified

            Note

            Supports eos metaparameters for using the eAPI transport

            Note

            Supports stateful resource configuration.