f5networks.f5_modules.bigip_service_policy module – Manages service policies on a BIG-IP.
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_service_policy
.
New in f5networks.f5_modules 1.0.0
Synopsis
Service policies allow you to configure timers and port misuse rules (if enabled) on a per rule or per context basis.
Parameters
Parameter |
Comments |
---|---|
Description of the service policy. |
|
Name of the service policy. |
|
Device partition to manage resources on. Default: |
|
The port misuse policy to attach to the service policy. Requires |
|
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:
|
|
Whether the resource should exist or not. Choices:
|
|
The timer policy to attach to the service policy. |
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 service policy
bigip_service_policy:
name: foo
timer_policy: timer1
port_misuse_policy: misuse1
timer_policy_enabled: true
port_misuse_policy_enabled: true
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
New description of the resource. Returned: changed Sample: |
|
The new port misuse policy attached to the resource. Returned: changed Sample: |
|
The new timer policy attached to the resource. Returned: changed Sample: |