Docs4dev
Docs
ansible / 2.4 / bigip_snmp_module.html

bigip_snmp - Manipulate general SNMP settings on a BIG-IP.

New in version 2.4.

Synopsis

  • Manipulate general SNMP settings on a BIG-IP.

Requirements (on host that executes module)

  • f5-sdk >= 2.2.0

Options

parameter required default choices comments
agent_authentication_traps
 no
  • enabled
  • disabled
When enabled, ensures that the system sends authentication warning traps to the trap destinations. This is usually disabled by default on a BIG-IP.
agent_status_traps
 no
  • enabled
  • disabled
When enabled, ensures that the system sends a trap whenever the SNMP agent starts running or stops running. This is usually enabled by default on a BIG-IP.
contact
 no
Specifies the name of the person who administers the SNMP service for this system.
device_warning_traps
 no
  • enabled
  • disabled
When enabled, ensures that the system sends device warning traps to the trap destinations. This is usually enabled by default on a BIG-IP.
location
 no
Specifies the description of this system's physical location.
password
 yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
server
 yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.

Examples

- name: Set snmp contact
  bigip_snmp:
      contact: "Joe User"
      password: "secret"
      server: "lb.mydomain.com"
      user: "admin"
      validate_certs: "false"
  delegate_to: localhost

- name: Set snmp location
  bigip_snmp:
      location: "US West 1"
      password: "secret"
      server: "lb.mydomain.com"
      user: "admin"
      validate_certs: "false"
  delegate_to: localhost

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
agent_authentication_traps
Value that the authentication status traps was set to.
changed string enabled
agent_status_traps
Value that the agent status traps was set to.
changed string enabled
contact
The new value for the person who administers SNMP on the device.
changed string Joe User
device_warning_traps
Value that the warning status traps was set to.
changed string enabled
location
The new value for the system's physical location.
changed string US West 1a

Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigip_snmp_module.html