f5networks.f5_modules.bigip_apm_network_access module – Manage APM Network Access resource
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_apm_network_access
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage APM Network Access resource.
Parameters
Parameter |
Comments |
---|---|
Enables local access to DNS servers configured on the client prior to establishing a network access connection. Choices:
|
|
Enables local subnet access and local access to any host or subnet in routes specified in the client routing table. When Choices:
|
|
User created network access description. |
|
Specifies a list of domain names describing the target LAN DNS addresses. |
|
When Choices:
|
|
Specifies the port number the network access resource uses for secure UDP traffic with DTLS. |
|
Specifies the DNS address spaces for which traffic is not forced through the tunnel. |
|
Specifies IPV4 address spaces for which traffic is not forced through the tunnel. |
|
The address of subnet in CIDR format, e.g. Host addresses can be specified without the CIDR mask notation. |
|
Specifies IPV6 address spaces for which traffic is not forced through the tunnel. |
|
The address of a subnet in CIDR format, e.g. Host addresses can be specified without the CIDR mask notation. |
|
Supported IP version on the network access resource. Choices:
|
|
Specifies a list of IPv4 hosts or networks describing the target LAN. This option is mandatory when creating a new resource and |
|
The address of subnet in CIDR format, e.g. Host addresses can be specified without the CIDR mask notation. |
|
Specifies the IPV4 lease pool resource to use with network access. Referencing a lease pool can be done in the full path format, for example When a lease pool is referenced in full path format, the |
|
Specifies a list of IPv6 hosts or networks describing the target LAN. This option is mandatory when creating a new resource and |
|
The address of subnet in CIDR format, e.g. Host addresses can be specified without the CIDR mask notation. |
|
Specifies the IPV6 lease pool resource to use with network access. Referencing a lease pool can be done in the full path format, for example When a lease pool is referenced in full path format, the |
|
Specifies the name of the APM network access to manage/create. |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the name of a SNAT pool used for implementing selective and intelligent SNATs. When When |
|
Specifies that only the traffic targeted to a specified address space is sent over the network access tunnel. Choices:
|
|
When When Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create a split tunnel IPV4 Network Access
bigip_apm_network_access:
name: foobar
ip_version: ipv4
split_tunnel: true
snat_pool: "none"
ipv4_lease_pool: leasefoo
ipv4_address_space:
- subnet: 10.10.1.1
- subnet: 10.10.2.0/24
excluded_ipv4_adresses:
- subnet: 192.168.1.0/24
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify a split tunnel IPV4 Network Access
bigip_apm_network_access:
name: foobar
snat_pool: /Common/poolsnat
ipv4_address_space:
- subnet: 172.16.23.0/24
excluded_ipv4_adresses:
- subnet: 10.10.2.0/24
allow_local_subnet: true
allow_local_dns: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove Network Access
bigip_apm_network_access:
name: foobar
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Enables local access to DNS servers configured on the client. Returned: changed Sample: |
|
Enables local subnet access. Returned: changed Sample: |
|
The new description of Network Access. Returned: changed Sample: |
|
Specifies a list of domain names describing the target LAN DNS addresses. Returned: changed Sample: |
|
Enables use of DTLS by network access. Returned: changed Sample: |
|
Specifies the port number the network access resource uses for DTLS. Returned: changed Sample: |
|
Specifies the DNS address spaces for which traffic is not forced through the tunnel. Returned: changed Sample: |
|
Specifies IPV4 address spaces for which traffic is not forced through the tunnel. Returned: changed Sample: |
|
The host or network address. Returned: changed Sample: |
|
Specifies IPV6 address spaces for which traffic is not forced through the tunnel. Returned: changed Sample: |
|
The host or network address. Returned: changed Sample: |
|
Supported IP version on the network access resource. Returned: changed Sample: |
|
Specifies a list of IPv4 hosts or networks describing the target LAN. Returned: changed Sample: |
|
The host or network address. Returned: changed Sample: |
|
Specifies a IPV4 lease pool resource to use with network access. Returned: changed Sample: |
|
Specifies a list of IPv6 hosts or networks describing the target LAN. Returned: changed Sample: |
|
The host or network address. Returned: changed Sample: |
|
Specifies a IPV6 lease pool resource to use with network access. Returned: changed Sample: |
|
The name of a SNAT pool used by the network access resource. Returned: changed Sample: |
|
Enables split tunnel on the network access resource. Returned: changed Sample: |