New in version 2.6.
The below requirements are needed on the host that executes this module.
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 . | ||
distribution |
| 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 . | |
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 . | |
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. | ||
provider (added in 2.5) | Default: None | A dict object containing connection details. | |
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 . | ||
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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 | ||
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 . | |
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 |
| 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 |
| 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 |
| 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 . |
Note
pip install f5-sdk
.- name: Create a high-speed logging destination bigip_log_destination: name: foo type: remote-high-speed-log pool_settings: pool: my-ltm-pool password: secret server: lb.mydomain.com state: present user: admin delegate_to: localhost - name: Create a remote-syslog logging destination bigip_log_destination: name: foo type: remote-syslog syslog_settings: syslog_format: rfc5424 forward_to: my-destination password: secret server: lb.mydomain.com state: present user: admin delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
param1 bool | changed | The new param1 value of the resource. Sample: True |
param2 string | changed | The new param2 value of the resource. Sample: Foo is bar |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_log_destination_module.html