bigip_ipsec_policy – Manage IPSec policies on a BIG-IP
bigip_ipsec_policy – Manage IPSec policies on a BIG-IP
New in version 2.8.
Synopsis
- Manage IPSec policies on a BIG-IP.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_algorithm string |
|
Specifies the algorithm to use for IKE authentication. | |
description string |
Description of the policy | ||
encrypt_algorithm string |
|
Specifies the algorithm to use for IKE encryption. | |
ipcomp string |
|
Specifies whether to use IPComp encapsulation. When When | |
kb_lifetime integer |
Specifies the length of time, in kilobytes, before the IKE security association expires. | ||
lifetime integer |
Specifies the length of time, in minutes, before the IKE security association expires. | ||
mode string |
|
Specifies the processing mode. When When When When | |
name string / required |
Specifies the name of the IPSec policy. | ||
partition string |
Default: "Common" |
Device partition to manage resources on. | |
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
perfect_forward_secrecy string |
|
Specifies the Diffie-Hellman group to use for IKE Phase 2 negotiation. | |
protocol string |
|
Specifies the IPsec protocol Options include ESP (Encapsulating Security Protocol) or AH (Authentication Header). | |
provider dictionary added in 2.5 |
A dict object containing connection details. | ||
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile path |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
timeout integer |
Default: 10 |
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. | |
transport string |
|
Configures the transport connection to use when connecting to the remote device. | |
user string / required |
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
route_domain integer |
Specifies the route domain, when | ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state string |
|
When When | |
tunnel_local_address string |
Specifies the local endpoint IP address of the IPsec tunnel. This parameter is only valid when | ||
tunnel_remote_address string |
Specifies the remote endpoint IP address of the IPsec tunnel. This parameter is only valid when | ||
user string / required |
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 | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
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 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 | Returned | Description |
---|---|---|
auth_algorithm string |
changed |
The new IKE Phase 2 Authentication Algorithm value.
Sample: sha512 |
description string |
changed |
The new description value.
Sample: My policy |
encrypt_algorithm string |
changed |
The new IKE Phase 2 Encryption Algorithm value.
Sample: aes256 |
ipcomp string |
changed |
The new IKE Phase 2 IPComp value.
Sample: deflate |
kb_lifetime integer |
changed |
The new IKE Phase 2 KB Lifetime value.
|
lifetime integer |
changed |
The new IKE Phase 2 Lifetime value.
Sample: 1440 |
mode string |
changed |
The new Mode value.
Sample: tunnel |
perfect_forward_secrecy string |
changed |
The new IKE Phase 2 Perfect Forward Secrecy value.
Sample: modp2048 |
protocol string |
changed |
The new IPsec Protocol value.
Sample: ah |
route_domain integer |
changed |
The new Route Domain value when in Tunnel mode.
Sample: 2 |
tunnel_local_address string |
changed |
The new Tunnel Local Address value.
Sample: 1.2.2.1 |
tunnel_remote_address string |
changed |
The new Tunnel Remote Address value.
Sample: 2.1.1.2 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_ipsec_policy_module.html