Last updated on: 2024-04-01 03:24:20.

bigip_snmp_trap – Manipulate SNMP trap information on a BIG-IP¶

New in version 1.0.0.

Synopsis
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Manipulate SNMP trap information on a BIG-IP system.

Parameters ¶

Parameter		Choices/Defaults	Comments
auth_password string added in 1.16.0			Specifies the Authentication protocol password to be used for snmp v3 traps Required for the `snmp_version` matches `v3` and for the `security_level`
auth_protocol string added in 1.16.0		Choices: sha md5	Specifies the Authentication protocol to be used for snmp v3 traps Required for the `security_level`
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		Choices: other management default	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 `default` was removed in BIG-IP version 13.1.0. Specifying this value when configuring a BIG-IP causes the module to stop and report an error. In this case, choose one of the other options, such as `management`.
partition string		Default: "Common"	Device partition to manage resources on.
port string			Specifies the port for the trap destination.
privacy_password string added in 1.16.0			Specifies the Privacy protocol password to be used for snmp v3 traps Required for the `security_level` matches c(auth-privacy)
privacy_protocol string added in 1.16.0		Choices: aes des	Specifies the Privacy protocol to be used for snmp v3 traps Required for the `security_level` matches c(auth-privacy)
provider dictionary added in 1.0.0			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	Choices: no ← yes	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing.
	password string / required		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 `F5_PASSWORD`. aliases: pass, pwd
	server string / required		The BIG-IP host or the BIG-IQ 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	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		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 `F5_USER`.
	validate_certs boolean	Choices: no yes ←	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`.
security_level string added in 1.16.0		Choices: auth-no-privacy auth-privacy	Specifies the port for the trap destination. Required for the `snmp_version` matches `v3`.
security_name string added in 1.16.0			Specifies the security name to used for v3 snmp trap Required for the `snmp_version` matches `v3`.
snmp_version string		Choices: 1 2c 3	Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies.
state string		Choices: present ← absent	When `present`, ensures the resource exists. When `absent`, ensures the resource does not exist.

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

- 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 ¶

The following are the fields unique to this module:

Key	Returned	Description
community list	changed and success	The new `community` name for the trap destination. 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 `port` of the trap destination. Sample: 900
snmp_version string	changed and success	The new `snmp_version` configured on the remote device. Sample: 2c

Status ¶

Authors¶

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

bigip_snmp_trap – Manipulate SNMP trap information on a BIG-IP¶

Synopsis¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶

Authors¶

Synopsis ¶

Parameters ¶

Notes ¶

Examples ¶

Return Values ¶

Status ¶