f5networks.f5_modules.bigip_ipsec_policy module – Manage IPSec policies on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.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_ipsec_policy
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage IPSec policies on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
Specifies the algorithm to use for IKE authentication. Choices:
|
|
Description of the policy |
|
Specifies the algorithm to use for IKE encryption. Choices:
|
|
Specifies whether to use IPComp encapsulation. When When Choices:
|
|
When This option takes effect only when Choices:
|
|
Specifies the length of time before the IKE security association, in kilobytes. expires. |
|
Specifies the length of time before the IKE security association expires, in minutes. |
|
Specifies the processing mode. When When When When Choices:
|
|
Specifies the name of the IPSec policy. |
|
Device partition to manage resources on. Default: |
|
Specifies the Diffie-Hellman group to use for IKE Phase 2 negotiation. Choices:
|
|
Specifies the IPsec protocol. Options include ESP (Encapsulating Security Protocol) or AH (Authentication Header). Choices:
|
|
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 route domain, when |
|
When When Choices:
|
|
Specifies the local endpoint IP address of the IPsec tunnel. This parameter is only valid when |
|
Specifies the remote endpoint IP address of the IPsec tunnel. This parameter is only valid when |
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 IPSec policy
bigip_ipsec_policy:
name: policy1
mode: tunnel
tunnel_local_address: 1.1.1.1
tunnel_remote_address: 2.2.2.
auth_algorithm: sha1
encrypt_algorithm: 3des
protocol: esp
perfect_forward_secrecy: modp1024
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 IKE Phase 2 Authentication Algorithm value. Returned: changed Sample: |
|
The new description value. Returned: changed Sample: |
|
The new IKE Phase 2 Encryption Algorithm value. Returned: changed Sample: |
|
The new IKE Phase 2 IPComp value. Returned: changed Sample: |
|
The new IKE Phase 2 KB Lifetime value. Returned: changed Sample: |
|
The new IKE Phase 2 Lifetime value. Returned: changed Sample: |
|
The new Mode value. Returned: changed Sample: |
|
The new IKE Phase 2 Perfect Forward Secrecy value. Returned: changed Sample: |
|
The new IPsec Protocol value. Returned: changed Sample: |
|
The new Route Domain value when in Tunnel mode. Returned: changed Sample: |
|
The new Tunnel Local Address value. Returned: changed Sample: |
|
The new Tunnel Remote Address value. Returned: changed Sample: |