f5networks.f5_modules.bigip_snmp_trap module – Manipulate SNMP trap information on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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 f5networks.f5_modules 1.0.0
Synopsis
Manipulate SNMP trap information on a BIG-IP system.
Parameters
Parameter |
Comments |
|---|---|
Specifies the Authentication protocol password to be used for snmp v3 traps Required for the |
|
Specifies the Authentication protocol to be used for snmp v3 traps Required for the Choices:
|
|
Specifies the community name for the trap destination. |
|
Specifies the address for the trap destination. This can be either an IP address or a hostname. |
|
Name of the SNMP configuration endpoint. |
|
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 Choices:
|
|
Device partition to manage resources on. Default: |
|
Specifies the port for the trap destination. |
|
Specifies the Privacy protocol password to be used for snmp v3 traps Required for the |
|
Specifies the Privacy protocol to be used for snmp v3 traps Required for the Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the port for the trap destination. Required for the Choices:
|
|
Specifies the security name to used for v3 snmp trap Required for the |
|
Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies. Choices:
|
|
When When Choices:
|
Notes
Note
This module only supports version v1 and v2c of SNMP.
The
networkoption 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
- name: Create snmp v3 trap
bigip_snmp_trap:
community: general
destination: 5.6.7.9
name: my-trap3
network: management
port: 7001
snmp_version: 3
auth_protocol: 'sha'
auth_password: 'test12345'
security_name: "testsec2"
security_level: "auth-no-privacy"
provider:
server: lb.mydomain.com
user: admin
password: secret
state: absent
delegate_to: localhost
- name: Create snmp v3 trap-2
bigip_snmp_trap:
community: general
destination: 5.6.7.10
name: my-trap4
network: management
port: 7002
snmp_version: 3
auth_protocol: 'sha'
auth_password: 'test123456'
security_name: "testsec3"
security_level: "auth-privacy"
privacy_protocol: "des"
privacy_password: 'test@12345'
provider:
server: lb.mydomain.com
user: admin
password: secret
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The new Returned: changed and success Sample: |
|
The new address for the trap destination in either IP or hostname form. Returned: changed and success Sample: |
|
The new name of the network the SNMP trap is on. Returned: changed and success Sample: |
|
The new Returned: changed and success Sample: |
|
The new Returned: changed and success Sample: |