W3cubDocs

/Ansible

purestorage.flashblade.purefb_snmp_agent module – Configure the FlashBlade SNMP Agent

Note

This module is part of the purestorage.flashblade collection (version 1.20.0).

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 purestorage.flashblade. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flashblade.purefb_snmp_agent.

New in purestorage.flashblade 1.0.0

Synopsis

  • Configure the management SNMP Agent on a Pure Storage FlashBlade.
  • This module is not idempotent and will always modify the existing management SNMP agent due to hidden parameters that cannot be compared to the play parameters.

Requirements

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

  • python >= 3.9
  • py-pure-client
  • purity_fb >= 1.12.2
  • netaddr
  • datetime
  • pytz
  • distro
  • pycountry
  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashBlade API token for admin privileged user.

auth_passphrase

string

SNMPv3 only. Passphrase of 8 - 32 characters.

auth_protocol

string

SNMP v3 only. Hash algorithm to use

Choices:

  • "MD5"
  • "SHA"

community

string

SNMP v2c only. Manager community ID. Between 1 and 32 characters long.

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)
  • true

fb_url

string

FlashBlade management IP address or Hostname.

privacy_passphrase

string

SNMPv3 only. Passphrase to encrypt SNMP messages. Must be between 8 and 63 non-space ASCII characters.

privacy_protocol

string

SNMP v3 only. Encryption protocol to use

Choices:

  • "AES"
  • "DES"

user

string

SNMP v3 only. User ID recognized by the specified SNMP agent. Must be between 1 and 32 characters.

version

string

Version of SNMP protocol to use for the agent.

Choices:

  • "v2c"
  • "v3"

Notes

Note

  • This module requires the purity_fb Python library
  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Update v2c SNMP agent
  purestorage.flashblade.purefb_snmp_agent:
    community: public
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Update v3 SNMP agent
  purestorage.flashblade.purefb_snmp_agent:
    version: v3
    auth_protocol: MD5
    auth_passphrase: password
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

Authors

  • Pure Storage Ansible Team (@sdodsley)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flashblade/purefb_snmp_agent_module.html