New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
local_ip | 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 none is used. | ||
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 | ||
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. | |
remote_host required | Specifies the IP address, or hostname, for the remote system to which the system sends log messages. | ||
remote_port | Specifies the port that 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 514 is used. | ||
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 , guarantees that the remote syslog exists with the provided attributes.When absent , removes the remote syslog from the system. | |
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: Add a remote syslog server to log to bigip_remote_syslog: remote_host: 10.10.10.10 password: secret server: lb.mydomain.com user: admin validate_certs: no 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 password: secret server: lb.mydomain.com user: admin validate_certs: no 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 int | changed | New remote port of the remote syslog server. Sample: 514 |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
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_remote_syslog_module.html