f5networks.f5_modules.bigip_traffic_selector module – Manage IPSec Traffic Selectors on BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.25.0).
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_traffic_selector.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage IPSec Traffic Selectors on BIG-IP.
Parameters
Parameter |
Comments |
|---|---|
Description of the traffic selector. |
|
Specifies the host or network IP address to which the application traffic is destined. When creating a new traffic selector, this parameter is required. |
|
Specifies the IPsec policy that tells the BIG-IP system how to handle the packets. When creating a new traffic selector, if this parameter is not specified, the default is |
|
Specifies the name of the traffic selector. |
|
Specifies the order in which traffic is matched, if traffic can be matched to multiple traffic selectors. Traffic is matched to the traffic selector with the highest priority (lowest order number). When creating a new traffic selector, if this parameter is not specified, the default is |
|
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. You may omit this option by setting the environment variable |
|
The BIG-IP 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 with. 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 host or network IP address from which the application traffic originates. When creating a new traffic selector, this parameter is required. |
|
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 traffic selector
bigip_traffic_selector:
name: selector1
destination_address: 1.1.1.1
ipsec_policy: policy1
order: 1
source_address: 2.2.2.2
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 |
|---|---|
The new Destination IP Address. Returned: changed Sample: |
|
The new IPSec policy. Returned: changed Sample: |
|
The new sort order. Returned: changed Sample: |
|
The new Source IP address. Returned: changed Sample: |