bigip_snmp_community – Manages SNMP communities on a BIG-IP.
bigip_snmp_community – Manages SNMP communities on a BIG-IP.
New in version 2.6.
Synopsis
- Assists in managing SNMP communities on a BIG-IP. Different SNMP versions are supported by this module. Take note of the different parameters offered by this module, as different parameters work for different versions of SNMP. Typically this becomes an interest if you are mixing versions
v2c
and3
.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access - |
|
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 | |
community - |
Specifies the community string (password) for access to the MIB. This parameter is only relevant when | ||
ip_version - |
|
Specifies whether the record applies to IPv4 or IPv6 addresses. When creating a new community, if this value is not specified, the default of This parameter is only relevant when | |
name - |
Name that identifies the SNMP community. When The name | ||
oid - |
Specifies the object identifier (OID) for the record. When When | ||
partition - |
Default: "Common" |
Device partition to manage resources on. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
port - |
Specifies the port for the trap destination. This parameter is only relevant when | ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
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. | |
transport - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
snmp_auth_password - |
Specifies the password for the user. When creating a new SNMP This value must be at least 8 characters long. | ||
snmp_auth_protocol - |
|
Specifies the authentication method for the user. When When When When creating a new SNMP | |
snmp_privacy_password - |
Specifies the password for the user. When creating a new SNMP This value must be at least 8 characters long. | ||
snmp_privacy_protocol - |
|
Specifies the encryption protocol. When When When When creating a new SNMP | |
snmp_username - |
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. | ||
source - |
Specifies the source address for access to the MIB. This parameter can accept a value of If this parameter is not specified, the value This parameter is only relevant when If This parameter should be provided when | ||
state - |
|
When When | |
update_password - |
|
| |
user - / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable | |
version - |
|
Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies. |
Notes
Note
- 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
. - 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 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
password: secret
server: lb.mydomain.com
state: present
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
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove the default 'public' SNMP community
bigip_snmp_community:
name: public
source: default
password: secret
server: lb.mydomain.com
state: absent
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
param1 boolean |
changed |
The new param1 value of the resource.
Sample: True |
param2 string |
changed |
The new param2 value of the resource.
Sample: Foo is bar |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_snmp_community_module.html