Try SpotterManage tunnels on a BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manages 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.
- name: Create a VXLAN tunnel
bigip_tunnel:
name: openshift-tunnel
local_address: 192.1681.240
key: 0
secondary_address: 192.168.1.100
mtu: 0
use_pmtu: true
tos: preserve
auto_last_hop: default
traffic_group: traffic-group-1
state: present
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
key:
description:
- 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).
type: int
mtu:
description:
- 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).
type: int
tos:
description:
- 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).
type: str
mode:
choices:
- bidirectional
- inbound
- outbound
description:
- 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.
type: str
name:
description:
- Specifies the name of the tunnel.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures that the tunnel exists.
- When C(absent), ensures the tunnel is removed.
type: str
profile:
description:
- 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.
type: str
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device for
either connecting or sending commands. If the timeout is exceeded before the
operation is completed, the module will error.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates are not validated. Use this only on personally controlled
sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
use_pmtu:
description:
- Enables or disables the tunnel to use the PMTU (Path MTU) information provided by
ICMP NeedFrag error messages.
- If C(true) and the tunnel C(mtu) is set to C(0), the tunnel will use the PMTU information.
- If C(true) and the tunnel C(mtu) is fixed to a non-zero value, the tunnel will use
the minimum of PMTU and MTU.
- If C(false), the tunnel will use fixed MTU or calculate its MTU using tunnel encapsulation
configurations.
type: bool
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
description:
description:
- Description of the tunnel.
type: str
transparent:
description:
- Specifies that the tunnel operates in transparent mode.
- When C(true), 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).
type: bool
auto_last_hop:
choices:
- default
- enabled
- disabled
description:
- 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.
type: str
local_address:
description:
- Specifies the IP address of the local endpoint of the tunnel.
type: str
traffic_group:
description:
- 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.
type: str
remote_address:
description:
- 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).
type: str
secondary_address:
description:
- Specifies a non-floating IP address for the tunnel, to be used with host-initiated
traffic.
type: str
param1: description: The new param1 value of the resource. returned: changed sample: true type: bool param2: description: The new param2 value of the resource. returned: changed sample: Foo is bar type: str