Parameter |
Choices/Defaults |
Comments |
actions
|
|
The actions that you want the policy rule to perform.
The available attributes vary by the action, however, each action requires that a type be specified.
These conditions can be specified in any order. Despite them being a list, the BIG-IP does not treat their order as anything special.
|
|
type
required |
Choices:
- forward
- enable
- ignore
|
The action type. This value controls what below options are required.
When type is forward , will associate a given pool , or virtual with this rule.
When type is enable , will associate a given asm_policy with this rule.
When type is ignore , will remove all existing actions from this rule.
|
|
pool
|
|
Pool that you want to forward traffic to.
This parameter is only valid with the forward type.
|
|
virtual
|
|
Virtual Server that you want to forward traffic to.
This parameter is only valid with the forward type.
|
|
asm_policy
|
|
ASM policy to enable.
This parameter is only valid with the enable type.
|
conditions
|
|
A list of attributes that describe the condition.
See suboptions for details on how to construct each list entry.
The ordering of this list is important, the module will ensure the order is kept when modifying the task.
The suboption options listed below are not required for all condition types, read the description for more details.
These conditions can be specified in any order. Despite them being a list, the BIG-IP does not treat their order as anything special.
|
|
type
required |
Choices:
- http_uri
- all_traffic
|
The condition type. This value controls what below options are required.
When type is http_uri , will associate a given path_begins_with_any list of strings with which the HTTP URI should begin with. Any item in the list will provide a match.
When type is all_traffic , will remove all existing conditions from this rule.
|
|
path_begins_with_any
|
|
A list of strings of characters that the HTTP URI should start with.
This parameter is only valid with the http_uri type.
|
description
|
|
Description of the policy rule.
|
name
required |
|
The name of the rule.
|
partition
|
Default:
Common
|
Device partition to manage resources on.
|
password
required |
|
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD .
aliases: pass, pwd
|
policy
required |
|
The name of the policy that you want to associate this rule with.
|
provider
(added in 2.5) |
Default:
None
|
A dict object containing connection details.
|
|
password
required |
|
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD .
aliases: pass, pwd
|
|
server
required |
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
user
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 F5_USER .
|
|
validate_certs
bool |
|
If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS .
|
|
timeout
|
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.
|
|
ssh_keyfile
|
|
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 ANSIBLE_NET_SSH_KEYFILE .
|
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
server
required |
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
server_port
(added in 2.2) |
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
state
|
Choices:
present ←
- absent
|
When present , ensures that the key is uploaded to the device. When absent , ensures that the key is removed from the device. If the key is currently in use, the module will not be able to remove the key.
|
user
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 F5_USER .
|
validate_certs
bool
(added in 2.0) |
|
If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS .
|