bigip_log_destination - Manages log destinations on a BIG-IP.¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Manages log destinations on a BIG-IP.

Requirements ¶

The below requirements are needed on the host that executes this module.

f5-sdk >= 3.0.9

Parameters ¶

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 can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
pool_settings			This parameter is only available when `type` is `remote-high-speed-log`.
	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`.
	protocol	Choices: tcp udp	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)			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. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
	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 can omit this option if the environment variable `F5_SERVER` is set.
	user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
	server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
	password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
	validate_certs	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
	transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required			The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)		Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
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 can omit this option if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)		Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

Notes ¶

Note

For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Examples ¶

- 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

Return Values ¶

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

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.