f5networks.f5_modules.bigip_snmp_community module – Manages SNMP communities 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_community
.
New in f5networks.f5_modules 1.0.0
Synopsis
Assists in managing Simple Network Management Protocol (SNMP) communities on a BIG-IP system. Different SNMP versions are supported by this module. Note the different parameters offered by this module, as different parameters work for different versions of SNMP. This is important if you are mixing versions
v2c
and3
.
Parameters
Parameter |
Comments |
---|---|
Specifies the user’s access level to the MIB. When creating a new community, if this parameter is not specified, the default is When When Choices:
|
|
Specifies the community string (password) for access to the MIB. This parameter is only relevant when |
|
Specifies whether the record applies to IPv4 or IPv6 addresses. When creating a new community, if this value is not specified, the default is This parameter is only relevant when Choices:
|
|
Name that identifies the SNMP community. When The name |
|
Specifies the object identifier (OID) for the record. When When |
|
Device partition to manage resources on. Default: |
|
Specifies the port for the trap destination. This parameter is only relevant when |
|
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 password for the user. When creating a new SNMP This value must be at least 8 characters long. |
|
Specifies the authentication method for the user. When When When When creating a new SNMP Choices:
|
|
Specifies the password for the user. When creating a new SNMP This value must be at least 8 characters long. |
|
Specifies the encryption protocol. When When When When creating a new SNMP Choices:
|
|
Specifies the name of the user for whom you want to grant access to the SNMP v3 MIB. This parameter is only relevant when When creating a new SNMP This parameter cannot be changed once it has been set. |
|
Specifies the source address for access to the MIB. This parameter can accept a value of If this parameter is not specified, the value is This parameter is only relevant when If You should provide this parameter when |
|
When When Choices:
|
|
Choices:
|
|
Specifies to which SNMP version the trap destination applies. 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: Create an SMNP v2c read-only community
bigip_snmp_community:
name: foo
version: v2c
source: all
oid: .1
access: ro
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create an SMNP v3 read-write community
bigip_snmp_community:
name: foo
version: v3
snmp_username: foo
snmp_auth_protocol: sha
snmp_auth_password: secret
snmp_privacy_protocol: aes
snmp_privacy_password: secret
oid: .1
access: rw
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove the default 'public' SNMP community
bigip_snmp_community:
name: public
source: default
state: absent
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 |
---|---|
The new access level for the MIB. Returned: changed Sample: |
|
The new community value. Returned: changed Sample: |
|
The new IP version value. Returned: changed Sample: |
|
The new OID value. Returned: changed Sample: |
|
The new password of the given snmp_username. Returned: changed Sample: |
|
The new SNMP auth protocol. Returned: changed Sample: |
|
The new password of the given snmp_username. Returned: changed Sample: |
|
The new SNMP privacy protocol. Returned: changed Sample: |
|
The new SNMP username. Returned: changed Sample: |
|
The new source address to access the MIB. Returned: changed Sample: |