Class: Ansible::Ruby::Modules::Vyos_interface

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

Overview

This module provides declarative management of Interfaces on VyOS 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, fix_inclusion, #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.

Returns:

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

    List of Interfaces definitions.



44
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_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) and I(neighbors).

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) and I(neighbors).



36
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_interface.rb', line 36

attribute :delay

#description ⇒ String?

Returns Description of Interface.

Returns:

  • (String, nil) —

    Description of Interface.



16
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_interface.rb', line 16

attribute :description

#duplex ⇒ :full, ...

Returns Interface link status.

Returns:

  • (:full, :half, :auto, nil) —

    Interface link status.



32
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_interface.rb', line 32

attribute :duplex

#enabled ⇒ FalseClass, ...

Returns Interface link status.

Returns:

  • (FalseClass, TrueClass, nil) —

    Interface link status.



20
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_interface.rb', line 20

attribute :enabled

#mtu ⇒ Integer?

Returns Maximum size of transmit packet.

Returns:

  • (Integer, nil) —

    Maximum size of transmit packet.



28
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_interface.rb', line 28

attribute :mtu

#name ⇒ String

Returns Name of the Interface.

Returns:

  • (String) —

    Name of the Interface.



12
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_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/vyos/vyos_interface.rb', line 40

attribute :neighbors

#speed ⇒ Integer?

Returns Interface link speed.

Returns:

  • (Integer, nil) —

    Interface link speed.



24
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_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)



48
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_interface.rb', line 48

attribute :state