eos_interface

Synopsis

Added in version 1.0.0

The eos_interface module manages the interface configuration for any valid interface on 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)
    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
      (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 interface is configured
  eos_interface: name=Loopback0 state=present enable=yes

- name: ensures the interface is not configured
  eos_interface: name=Loopback1 state=absent

      Note

      All configuration is idempotent unless otherwise specified

      Note

      Supports eos metaparameters for using the eAPI transport

      Note

      Supports stateful resource configuration. This method also supports the ‘default’ state. This will default the specified interface. Note however that the default state operation is NOT idempotent.