Class: Ansible::Ruby::Modules::Net_vlan

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

Overview

This module provides declarative management of VLANs on 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 ⇒ Object?

Returns List of VLANs definitions.

Returns:

  • (Object, nil) —

    List of VLANs definitions.



23
 
# File 'lib/ansible/ruby/modules/generated/network/layer2/net_vlan.rb', line 23

attribute :aggregate

#interfaces ⇒ Object?

Returns List of interfaces the VLAN should be configured on.

Returns:

  • (Object, nil) —

    List of interfaces the VLAN should be configured on.



20
 
# File 'lib/ansible/ruby/modules/generated/network/layer2/net_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/layer2/net_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.



26
 
# File 'lib/ansible/ruby/modules/generated/network/layer2/net_vlan.rb', line 26

attribute :purge

#state ⇒ :present, ...

Returns State of the VLAN configuration.

Returns:

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

    State of the VLAN configuration.



30
 
# File 'lib/ansible/ruby/modules/generated/network/layer2/net_vlan.rb', line 30

attribute :state

#vlan_id ⇒ Integer, ...

Returns ID of the VLAN.

Returns:

  • (Integer, NilClass, nil) —

    ID of the VLAN.



16
 
# File 'lib/ansible/ruby/modules/generated/network/layer2/net_vlan.rb', line 16

attribute :vlan_id