Class: Ansible::Ruby::Modules::Eos_interface

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb

Overview

This module provides declarative management of Interfaces on Arista EOS network devices.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#aggregate ⇒ Array<Hash>, ...

Returns List of Interfaces definitions. Each of the entry in aggregate list should define name of interface C(name) and other options as required.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of Interfaces definitions. Each of the entry in aggregate list should define name of interface C(name) and other options as required.



44
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 44

attribute :aggregate

#delay ⇒ Integer?

Returns Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate).

Returns:

  • (Integer, nil) —

    Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate).



48
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 48

attribute :delay

#description ⇒ String?

Returns Description of Interface upto 240 characters.

Returns:

  • (String, nil) —

    Description of Interface upto 240 characters.



16
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 16

attribute :description

#enabled ⇒ Boolean?

Returns Interface link status. If the value is I(True) the interface state will be enabled, else if value is I(False) interface will be in disable (shutdown) state.

Returns:

  • (Boolean, nil) —

    Interface link status. If the value is I(True) the interface state will be enabled, else if value is I(False) interface will be in disable (shutdown) state.



20
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 20

attribute :enabled

#mtu ⇒ Integer?

Returns Set maximum transmission unit size in bytes of transmit packet for the interface given in C(name) option.

Returns:

  • (Integer, nil) —

    Set maximum transmission unit size in bytes of transmit packet for the interface given in C(name) option.



28
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 28

attribute :mtu

#name ⇒ String

Returns Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated.

Returns:

  • (String) —

    Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated.



12
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 12

attribute :name

#neighbors ⇒ Array<Hash>, ...

Returns Check the operational state of given interface C(name) for LLDP neighbor.,The following suboptions are available.

Returns:

  • (Array<Hash>, Hash, nil) —

    Check the operational state of given interface C(name) for LLDP neighbor.,The following suboptions are available.



40
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 40

attribute :neighbors

#rx_rate ⇒ String?

Returns Receiver rate in bits per second (bps) for the interface given in C(name) option.,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html).

Returns:

  • (String, nil) —

    Receiver rate in bits per second (bps) for the interface given in C(name) option.,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html)



36
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 36

attribute :rx_rate

#speed ⇒ String?

Returns This option configures autoneg and speed/duplex/flowcontrol for the interface given in C(name) option.

Returns:

  • (String, nil) —

    This option configures autoneg and speed/duplex/flowcontrol for the interface given in C(name) option.



24
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 24

attribute :speed

#state ⇒ :present, ...

Returns State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down).

Returns:

  • (:present, :absent, :up, :down, nil) —

    State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down)



52
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 52

attribute :state

#tx_rate ⇒ String?

Returns Transmit rate in bits per second (bps) for the interface given in C(name) option.,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html).

Returns:

  • (String, nil) —

    Transmit rate in bits per second (bps) for the interface given in C(name) option.,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html)



32
 
# File 'lib/ansible/ruby/modules/generated/network/eos/eos_interface.rb', line 32

attribute :tx_rate