Class: Ansible::Ruby::Modules::Eos_vlan

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

Overview

This module provides declarative management of VLANs 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, 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 VLANs definitions.

Returns:

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

    List of VLANs definitions.



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

attribute :aggregate

#associated_interfaces ⇒ Array<String>, ...

Returns This is a intent option and checks the operational state of the for given vlan C(name) for associated interfaces. The name of interface is case sensitive and should be in expanded format and not abbreviated. If the value in the C(associated_interfaces) does not match with the operational state of vlan interfaces on device it will result in failure.

Returns:

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

    This is a intent option and checks the operational state of the for given vlan C(name) for associated interfaces. The name of interface is case sensitive and should be in expanded format and not abbreviated. If the value in the C(associated_interfaces) does not match with the operational state of vlan interfaces on device it will result in failure.



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

attribute :associated_interfaces

#delay ⇒ Integer?

Returns Delay the play should wait to check for declarative intent params values.

Returns:

  • (Integer, nil) —

    Delay the play should wait to check for declarative intent params values.



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

attribute :delay

#interfaces ⇒ Array<String>, ...

Returns List of interfaces that should be associated to the VLAN. The name of interface is case sensitive and should be in expanded format and not abbreviated.

Returns:

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

    List of interfaces that should be associated to the VLAN. The name of interface is case sensitive and should be in expanded format and not abbreviated.



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

attribute :interfaces

#name ⇒ String?

Returns Name of the VLAN.

Returns:

  • (String, nil) —

    Name of the VLAN.



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

attribute :name

#purge ⇒ Boolean?

Returns Purge VLANs not defined in the I(aggregate) parameter.

Returns:

  • (Boolean, nil) —

    Purge VLANs not defined in the I(aggregate) parameter.



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

attribute :purge

#state ⇒ :present, ...

Returns State of the VLAN configuration.

Returns:

  • (:present, :absent, :active, :suspend, nil) —

    State of the VLAN configuration.



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

attribute :state

#vlan_id ⇒ Integer

Returns ID of the VLAN.

Returns:

  • (Integer) —

    ID of the VLAN.



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

attribute :vlan_id