Class: Ansible::Ruby::Modules::Bigip_vlan

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

Overview

Manage VLANs on a BIG-IP system

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

#cmp_hash ⇒ :default, ...

Returns Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. You can choose to disaggregate traffic based on C(source-address) (the source IP address), C(destination-address) (destination IP address), or C(default), which specifies that the default CMP hash uses L4 ports.,When creating a new VLAN, if this parameter is not specified, the default of C(default) is used.

Returns:

  • (:default, :"destination-address", :"source-address", :"dst-ip", :"src-ip", :dest, :destination, :source, :dst, :src, nil) —

    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. You can choose to disaggregate traffic based on C(source-address) (the source IP address), C(destination-address) (destination IP address), or C(default), which specifies that the default CMP hash uses L4 ports.,When creating a new VLAN, if this parameter is not specified, the default of C(default) is used.



37
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 37

attribute :cmp_hash

#dag_round_robin ⇒ Symbol?

Returns Specifies whether some of the stateless traffic on the VLAN should be disaggregated in a round-robin order instead of using a static hash. The stateless traffic includes non-IP L2 traffic, ICMP, some UDP protocols, and so on.,When creating a new VLAN, if this parameter is not specified, the default of (no) is used.

Returns:

  • (Symbol, nil) —

    Specifies whether some of the stateless traffic on the VLAN should be disaggregated in a round-robin order instead of using a static hash. The stateless traffic includes non-IP L2 traffic, ICMP, some UDP protocols, and so on.,When creating a new VLAN, if this parameter is not specified, the default of (no) is used.



45
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 45

attribute :dag_round_robin

#dag_tunnel ⇒ :inner, ...

Returns Specifies how the disaggregator (DAG) distributes received tunnel-encapsulated packets to TMM instances. Select C(inner) to distribute packets based on information in inner headers. Select C(outer) to distribute packets based on information in outer headers without inspecting inner headers.,When creating a new VLAN, if this parameter is not specified, the default of C(outer) is used.,This parameter is not supported on Virtual Editions of BIG-IP.

Returns:

  • (:inner, :outer, nil) —

    Specifies how the disaggregator (DAG) distributes received tunnel-encapsulated packets to TMM instances. Select C(inner) to distribute packets based on information in inner headers. Select C(outer) to distribute packets based on information in outer headers without inspecting inner headers.,When creating a new VLAN, if this parameter is not specified, the default of C(outer) is used.,This parameter is not supported on Virtual Editions of BIG-IP.



41
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 41

attribute :dag_tunnel

#description ⇒ Object?

Returns The description to give to the VLAN.

Returns:

  • (Object, nil) —

    The description to give to the VLAN.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 12

attribute :description

#mtu ⇒ Object?

Returns Specifies the maximum transmission unit (MTU) for traffic on this VLAN. When creating a new VLAN, if this parameter is not specified, the default value used will be C(1500).,This number must be between 576 to 9198.

Returns:

  • (Object, nil) —

    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. When creating a new VLAN, if this parameter is not specified, the default value used will be C(1500).,This number must be between 576 to 9198.



34
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 34

attribute :mtu

#name ⇒ String

Returns The VLAN to manage. If the special VLAN C(ALL) is specified with the C(state) value of C(absent) then all VLANs will be removed.

Returns:

  • (String) —

    The VLAN to manage. If the special VLAN C(ALL) is specified with the C(state) value of C(absent) then all VLANs will be removed.



22
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 22

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



49
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 49

attribute :partition

#state ⇒ :absent, ...

Returns The state of the VLAN on the system. When C(present), guarantees that the VLAN exists with the provided attributes. When C(absent), removes the VLAN from the system.

Returns:

  • (:absent, :present, nil) —

    The state of the VLAN on the system. When C(present), guarantees that the VLAN exists with the provided attributes. When C(absent), removes the VLAN from the system.



26
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 26

attribute :state

#tag ⇒ String?

Returns Tag number for the VLAN. The tag number can be any integer between 1 and 4094. The system automatically assigns a tag number if you do not specify a value.

Returns:

  • (String, nil) —

    Tag number for the VLAN. The tag number can be any integer between 1 and 4094. The system automatically assigns a tag number if you do not specify a value.



30
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 30

attribute :tag

#tagged_interfaces ⇒ Array<Float>, ...

Returns Specifies a list of tagged interfaces and trunks that you want to configure for the VLAN. Use tagged interfaces or trunks when you want to assign a single interface or trunk to multiple VLANs.

Returns:

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

    Specifies a list of tagged interfaces and trunks that you want to configure for the VLAN. Use tagged interfaces or trunks when you want to assign a single interface or trunk to multiple VLANs.



15
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 15

attribute :tagged_interfaces

#untagged_interfaces ⇒ Object?

Returns Specifies a list of untagged interfaces and trunks that you want to configure for the VLAN.

Returns:

  • (Object, nil) —

    Specifies a list of untagged interfaces and trunks that you want to configure for the VLAN.



19
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_vlan.rb', line 19

attribute :untagged_interfaces