f5networks.f5_modules.bigip_snmp_trap – Manipulate SNMP trap information on a BIG-IP
f5networks.f5_modules.bigip_snmp_trap – Manipulate SNMP trap information on a BIG-IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_snmp_trap
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Manipulate SNMP trap information on a BIG-IP system.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
community string |
Specifies the community name for the trap destination. | ||
destination string |
Specifies the address for the trap destination. This can be either an IP address or a hostname. | ||
name string / required |
Name of the SNMP configuration endpoint. | ||
network string |
|
Specifies the name of the trap network. This option is not supported in versions of BIG-IP prior to 12.1.0, and is simply ignored on those versions. The value | |
partition string |
Default: "Common" |
Device partition to manage resources on. | |
port string |
Specifies the port for the trap destination. | ||
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 You may omit this option by setting the environment variable | |
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
snmp_version string |
|
Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies. | |
state string |
|
When When |
Notes
Note
- This module only supports version v1 and v2c of SNMP.
- The
network
option is not supported on versions of BIG-IP prior to 12.1.0 because the platform did not support that option until 12.1.0. If used on versions prior to 12.1.0, it is simply be ignored. - For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires BIG-IP software version >= 12.
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create snmp v1 trap
bigip_snmp_trap:
community: general
destination: 1.2.3.4
name: my-trap1
network: management
port: 9000
snmp_version: 1
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create snmp v2 trap
bigip_snmp_trap:
community: general
destination: 5.6.7.8
name: my-trap2
network: default
port: 7000
snmp_version: 2c
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
community list / elements=string |
changed and success |
The new
Sample: secret |
destination string |
changed and success |
The new address for the trap destination in either IP or hostname form.
Sample: 1.2.3.4 |
network string |
changed and success |
The new name of the network the SNMP trap is on.
Sample: management |
port string |
changed and success |
The new
Sample: 900 |
snmp_version string |
changed and success |
The new
Sample: 2c |
Authors
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 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_snmp_trap_module.html