Note
This plugin is part of the f5networks.f5_modules collection.
To install it use: ansible-galaxy collection install f5networks.f5_modules.
To use it in a playbook, specify: f5networks.f5_modules.bigip_remote_syslog.
New in version 1.0.0: of f5networks.f5_modules
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| local_ip string | Specifies the local IP address of the system that is logging. To provide no local IP, specify the value none.When creating a remote syslog, if this parameter is not specified, the default value is none. | ||
| name string | Specifies the name of the syslog object. This option is required when multiple remote_hosts with the same IP or hostname are present on the device.If name is not provided, remote_host is used by default. | ||
| provider dictionary added in 1.0.0 of f5networks.f5_modules | A dict object containing connection details. | ||
| auth_provider string | Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
| no_f5_teem boolean |
| If yes, TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable F5_TEEM. | |
| password string / 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 string / required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER. | ||
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT. | |
| timeout integer | 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. | ||
| transport string |
| Configures the transport connection to use when connecting to the remote device. | |
| user string / 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 boolean |
| 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. | |
| remote_host string / required | Specifies the IP address or hostname for the remote system, to which the system sends log messages. | ||
| remote_port string | Specifies the port the system uses to send messages to the remote logging server. When creating a remote syslog, if this parameter is not specified, the default value is 514. | ||
| state string |
| When present, guarantees the remote syslog exists with the provided attributes.When absent, removes the remote syslog from the system. | |
Note
- name: Add a remote syslog server to log to
bigip_remote_syslog:
remote_host: 10.10.10.10
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add a remote syslog server on a non-standard port to log to
bigip_remote_syslog:
remote_host: 10.10.10.10
remote_port: 1234
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| local_ip string | changed | The new local IP of the remote syslog server. Sample: 10.10.10.10 |
| remote_port integer | changed | New remote port of the remote syslog server. Sample: 514 |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_remote_syslog_module.html