f5networks.f5_modules.bigip_snmp module – Manipulate general SNMP settings 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
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manipulate general SNMP settings on a BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
When Choices:
|
|
When Choices:
|
|
Configures the IP addresses of the SNMP clients from which the snmpd daemon accepts requests. This value can be hostnames, IP addresses, or IP networks. You may specify a single list item of You can remove all allowed addresses by either providing the word |
|
Specifies the name of the person who administers the SNMP service for this system. |
|
When Choices:
|
|
Specifies the description of this system’s physical location. |
|
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:
|
Notes
Note
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: Set snmp contact
bigip_snmp:
contact: Joe User
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Set snmp location
bigip_snmp:
location: US West 1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Value of the authentication status traps. Returned: changed Sample: |
|
Value of the agent status traps. Returned: changed Sample: |
|
The new allowed addresses for SNMP client connections. Returned: changed Sample: |
|
The new value for the person who administers SNMP on the device. Returned: changed Sample: |
|
Value of the warning status traps. Returned: changed Sample: |
|
The new value for the system’s physical location. Returned: changed Sample: |