f5networks.f5_modules.bigip_asm_policy_signature_set module – Manages Signature Sets on an ASM policy
Note
This module is part of the f5networks.f5_modules collection (version 1.27.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_asm_policy_signature_set
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages Signature Sets on an ASM policy.
Parameters
Parameter |
Comments |
---|---|
Specifies if the security policy logs the request data in the Statistics screen when a request matches a signature that is included in the signature set. Choices:
|
|
Effective when the security policy enforcement mode is Blocking. Determines how the system treats requests that match a signature included in the signature set. When When Choices:
|
|
Specifies if the security policy learns all requests that match a signature that is included in the signature set. Choices:
|
|
Specifies the name of the signature sets to apply to, or remove from, the ASM policy. Apart from built-in signature sets that ship with the device, you can create and use custom signature sets. When When When When When When When When When When When When When When When When When When When When When When When When When When When |
|
This parameter is only used when identifying an ASM policy. Default: |
|
Specifies the name of an existing ASM policy to add or remove signature sets to. |
|
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:
|
|
When When Choices:
|
Notes
Note
This module is primarily used as a component of configuring an ASM policy in the Ansible Galaxy ASM Policy Role.
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: Add Signature Set to ASM Policy
bigip_asm_policy_signature_set:
name: IIS and Windows Signatures
policy_name: FooPolicy
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove Signature Set to ASM Policy
bigip_asm_policy_signature_set:
name: IIS and Windows Signatures
policy_name: FooPolicy
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 |
---|---|
Specifies whether the security policy logs the request data in the Statistics screen. Returned: changed Sample: |
|
Determines how the system treats requests that match a signature included in the signature set. Returned: changed Sample: |
|
Specifies if the policy learns all requests that match a signature that is included in the signature set. Returned: changed Sample: |
|
The name of the Signature Set added/removed on an ASM policy. Returned: changed Sample: |
|
The name of the ASM policy. Returned: changed Sample: |