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

New in version 2.4.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Manipulate SNMP trap information on a BIG-IP.

Requirements ¶

The below requirements are needed on the host that executes this module.

f5-sdk >= 3.0.9

Parameters ¶

Parameter	Choices/Defaults	Comments
community		Specifies the community name for the trap destination.
destination		Specifies the address for the trap destination. This can be either an IP address or a hostname.
name required		Name of the SNMP configuration endpoint.
network	Choices: other management default	Specifies the name of the trap network. This option is not supported in versions of BIG-IP < 12.1.0. If used on versions < 12.1.0, it will simply be ignored.
partition (added in 2.5)	Default: Common	Device partition to manage resources on.
password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
port		Specifies the port for the trap destination.
provider (added in 2.5)		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. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
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 can omit this option if the environment variable `F5_SERVER` is set.
user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
validate_certs	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required		The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
snmp_version	Choices: yes 2c	Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies.
state	Choices: present ← absent	When `present`, ensures that the cloud connector exists. When `absent`, ensures that the cloud connector does not exist.
user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

Notes ¶

Note

This module only supports version v1 and v2c of SNMP.
The network option is not supported on versions of BIG-IP < 12.1.0 because the platform did not support that option until 12.1.0. If used on versions < 12.1.0, it will simply be ignored.
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

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

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.