Class: Ansible::Ruby::Modules::Bigip_tunnel

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

Overview

Manages tunnels on a BIG-IP. Tunnels are usually based upon a tunnel profile which defines both default arguments and constraints for the tunnel. Due to this, this module exposes a number of settings that may or may not be related to the type of tunnel you are working with. It is important that you take this into consideration when declaring your tunnel config. If a specific tunnel does not support the parameter you are considering, the documentation of the parameter will usually make mention of this. Otherwise, when configuring that parameter on the device, the device will notify you.

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

#auto_last_hop ⇒ :default, ...

Returns Allows you to configure auto last hop on a per-tunnel basis.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default is C(default).,When C(default), means that the system uses the global auto-lasthop setting to send back the request.,When C(enabled), allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route.

Returns:

  • (:default, :enabled, :disabled, nil) —

    Allows you to configure auto last hop on a per-tunnel basis.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default is C(default).,When C(default), means that the system uses the global auto-lasthop setting to send back the request.,When C(enabled), allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route.



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 51

attribute :auto_last_hop

#description ⇒ Object?

Returns Description of the tunnel.

Returns:

  • (Object, nil) —

    Description of the tunnel.



18
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 18

attribute :description

#key ⇒ Integer?

Returns When applied to a GRE tunnel, this value specifies an optional field in the GRE header, used to authenticate the source of the packet.,When applied to a VXLAN or Geneve tunnel, this value specifies the Virtual Network Identifier (VNI).,When applied to an NVGRE tunnel, this value specifies the Virtual Subnet Identifier (VSID).,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is C(0).

Returns:

  • (Integer, nil) —

    When applied to a GRE tunnel, this value specifies an optional field in the GRE header, used to authenticate the source of the packet.,When applied to a VXLAN or Geneve tunnel, this value specifies the Virtual Network Identifier (VNI).,When applied to an NVGRE tunnel, this value specifies the Virtual Subnet Identifier (VSID).,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is C(0).



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 24

attribute :key

#local_address ⇒ String?

Returns Specifies the IP address of the local endpoint of the tunnel.

Returns:

  • (String, nil) —

    Specifies the IP address of the local endpoint of the tunnel.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 28

attribute :local_address

#mode ⇒ :bidirectional, ...

Returns Specifies how the tunnel carries traffic.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default is C(bidirectional).,When C(bidirectional), specifies that the tunnel carries both inbound and outbound traffic.,When C(inbound), specifies that the tunnel carries only incoming traffic.,When C(outbound), specifies that the tunnel carries only outgoing traffic.

Returns:

  • (:bidirectional, :inbound, :outbound, nil) —

    Specifies how the tunnel carries traffic.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default is C(bidirectional).,When C(bidirectional), specifies that the tunnel carries both inbound and outbound traffic.,When C(inbound), specifies that the tunnel carries only incoming traffic.,When C(outbound), specifies that the tunnel carries only outgoing traffic.



59
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 59

attribute :mode

#mtu ⇒ Integer?

Returns Specifies the maximum transmission unit (MTU) of the tunnel.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is C(0).,The valid range is from C(0) to C(65515).

Returns:

  • (Integer, nil) —

    Specifies the maximum transmission unit (MTU) of the tunnel.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is C(0).,The valid range is from C(0) to C(65515).



39
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 39

attribute :mtu

#name ⇒ String

Returns Specifies the name of the tunnel.

Returns:

  • (String) —

    Specifies the name of the tunnel.



14
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 14

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



67
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 67

attribute :partition

#profile ⇒ Object?

Returns Specifies the profile to associate with the tunnel for handling traffic.,Depending on your selection, other settings become available or disappear.,This parameter may not be changed after it is set.

Returns:

  • (Object, nil) —

    Specifies the profile to associate with the tunnel for handling traffic.,Depending on your selection, other settings become available or disappear.,This parameter may not be changed after it is set.



21
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 21

attribute :profile

#remote_address ⇒ Object?

Returns Specifies the IP address of the remote endpoint of the tunnel.,For C(dslite), C(fec) (when configuring the FEC tunnel for receiving traffic only), C(v6rd) (configured as a border relay), or C(map), the tunnel must have an unspecified remote address (any).

Returns:

  • (Object, nil) —

    Specifies the IP address of the remote endpoint of the tunnel.,For C(dslite), C(fec) (when configuring the FEC tunnel for receiving traffic only), C(v6rd) (configured as a border relay), or C(map), the tunnel must have an unspecified remote address (any).



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 32

attribute :remote_address

#secondary_address ⇒ String?

Returns Specifies a non-floating IP address for the tunnel, to be used with host-initiated traffic.

Returns:

  • (String, nil) —

    Specifies a non-floating IP address for the tunnel, to be used with host-initiated traffic.



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 35

attribute :secondary_address

#state ⇒ :present, ...

Returns When C(present), ensures that the tunnel exists.,When C(absent), ensures the tunnel is removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the tunnel exists.,When C(absent), ensures the tunnel is removed.



71
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 71

attribute :state

#tos ⇒ String?

Returns Specifies the Type of Service (TOS) value to insert in the encapsulating header of transmitted packets.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is C(preserve).,When C(preserve), the system copies the TOS value from the inner header to the outer header.,You may also specify a numeric value. The possible values are from C(0) to C(255).

Returns:

  • (String, nil) —

    Specifies the Type of Service (TOS) value to insert in the encapsulating header of transmitted packets.,When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is C(preserve).,When C(preserve), the system copies the TOS value from the inner header to the outer header.,You may also specify a numeric value. The possible values are from C(0) to C(255).



47
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 47

attribute :tos

#traffic_group ⇒ String?

Returns Specifies the traffic group to associate with the tunnel.,This value cannot be changed after it is set. This is a limitation of BIG-IP.

Returns:

  • (String, nil) —

    Specifies the traffic group to associate with the tunnel.,This value cannot be changed after it is set. This is a limitation of BIG-IP.



55
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 55

attribute :traffic_group

#transparent ⇒ Symbol?

Returns Specifies that the tunnel operates in transparent mode.,When C(yes), you can inspect and manipulate the encapsulated traffic flowing through the BIG-IP system.,A transparent tunnel terminates a tunnel while presenting the illusion that the tunnel transits the device unmodified (that is, the BIG-IP system appears as if it were an intermediate router that simply routes IP traffic through the device).

Returns:

  • (Symbol, nil) —

    Specifies that the tunnel operates in transparent mode.,When C(yes), you can inspect and manipulate the encapsulated traffic flowing through the BIG-IP system.,A transparent tunnel terminates a tunnel while presenting the illusion that the tunnel transits the device unmodified (that is, the BIG-IP system appears as if it were an intermediate router that simply routes IP traffic through the device).



63
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 63

attribute :transparent

#use_pmtu ⇒ Symbol?

Returns Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages.,If C(yes) and the tunnel C(mtu) is set to C(0), the tunnel will use the PMTU information.,If C(yes) and the tunnel C(mtu) is fixed to a non-zero value, the tunnel will use the minimum of PMTU and MTU.,If C(no), the tunnel will use fixed MTU or calculate its MTU using tunnel encapsulation configurations.

Returns:

  • (Symbol, nil) —

    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages.,If C(yes) and the tunnel C(mtu) is set to C(0), the tunnel will use the PMTU information.,If C(yes) and the tunnel C(mtu) is fixed to a non-zero value, the tunnel will use the minimum of PMTU and MTU.,If C(no), the tunnel will use fixed MTU or calculate its MTU using tunnel encapsulation configurations.



43
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_tunnel.rb', line 43

attribute :use_pmtu