Parameter |
Choices/Defaults |
Comments |
description
|
|
The description of the log destination.
|
name
required |
|
Specifies the name of the log destination.
|
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
|
pool_settings
|
|
This parameter is only available when type is remote-high-speed-log .
|
|
pool
|
|
Specifies the existing pool of remote high-speed log servers where logs will be sent.
When creating a new destination (and type is remote-high-speed-log ), this parameter is required.
|
|
protocol
|
|
Specifies the protocol for the system to use to send logs to the pool of remote high-speed log servers, where the logs are stored.
When creating a new log destination (and type is remote-high-speed-log ), if this parameter is not specified, the default is tcp .
|
|
distribution
|
Choices:
- adaptive
- balanced
- replicated
|
Specifies the distribution method used by the Remote High Speed Log destination to send messages to pool members.
When adaptive , connections to pool members will be added as required to provide enough logging bandwidth. This can have the undesirable effect of logs accumulating on only one pool member when it provides sufficient logging bandwidth on its own.
When balanced , sends each successive log to a new pool member, balancing the logs among them according to the pool's load balancing method.
When replicated , replicates each log to all pool members, for redundancy.
When creating a new log destination (and type is remote-high-speed-log ), if this parameter is not specified, the default is adaptive .
|
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 resource exists.
When absent , ensures the resource is removed.
|
syslog_settings
|
|
This parameter is only available when type is remote-syslog .
|
|
syslog_format
|
Choices:
- bsd-syslog
- syslog
- legacy-bigip
- rfc5424
- rfc3164
|
Specifies the method to use to format the logs associated with the remote Syslog log destination.
When creating a new log destination (and type is remote-syslog ), if this parameter is not specified, the default is bsd-syslog .
The syslog and rfc5424 choices are two ways of saying the same thing.
The bsd-syslog and rfc3164 choices are two ways of saying the same thing.
|
|
forward_to
|
|
Specifies the management port log destination, which will be used to forward the logs to a single log server, or a remote high-speed log destination, which will be used to forward the logs to a pool of remote log servers.
When creating a new log destination (and type is remote-syslog ), this parameter is required.
|
type
required |
Choices:
- remote-high-speed-log
- remote-syslog
|
Specifies the type of log destination.
Once created, this parameter cannot be changed.
|
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 .
|