purestorage.flashblade.purefb_snmp_agent – Configure the FlashBlade SNMP Agent

Note

This plugin is part of the purestorage.flashblade collection (version 1.6.0).

To install it use: ansible-galaxy collection install purestorage.flashblade.

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

New in version 1.0.0: of purestorage.flashblade

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 >= 2.7

  • purity_fb >= 1.9

  • netaddr

  • pytz

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashBlade API token for admin privileged user.
auth_passphrase
string
SNMPv3 only. Passphrase of 8 - 32 characters.
auth_protocol
string
    Choices:
  • MD5
  • SHA
SNMP v3 only. Hash algorithm to use
community
string
SNMP v2c only. Manager community ID. Between 1 and 32 characters long.
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
    Choices:
  • AES
  • DES
SNMP v3 only. Encryption protocol to use
user
string
SNMP v3 only. User ID recognized by the specified SNMP agent. Must be between 1 and 32 characters.
version
string
    Choices:
  • v2c
  • v3
Version of SNMP protocol to use for the agent.

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
  purefb_snmp_agent:
    community: public
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Update v3 SNMP agent
  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