everpure.flasharray.purefa_snmp_agent module – Configure the FlashArray SNMP Agent

Note

This module is part of the everpure.flasharray collection (version 1.46.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 everpure.flasharray. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: everpure.flasharray.purefa_snmp_agent.

New in everpure.flasharray 1.16.0

Synopsis

  • Manage the localhost SNMP Agent on a Everpure FlashArray.

  • Only the readable agent settings are compared, which are the version, the v3 user, the v3 auth and privacy protocols and whether a v2c community string is set. The array returns the community string and the passphrases masked, so a change to only the value of community, auth_passphrase or privacy_passphrase cannot be detected and is not applied. Clear the setting with state=absent first to replace it.

Requirements

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.88.0

  • netaddr

  • requests

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashArray API token for admin privileged user.

auth_passphrase

string

SNMP v3 only. Passphrade used by Purity//FA to authenticate the array with the specified managers.

Must be between 8 and 63 non-space ASCII characters.

auth_protocol

string

SNMP v3 only. Encryption protocol to use

To remove the privacy and auth protocols set state to absent with version set to v3

Choices:

  • "MD5"

  • "SHA"

client_id

string

added in everpure.flasharray 1.43.0

ID of the API Client that issues the identity token.

Used with private_key_file.

community

string

SNMP v2c only. Manager community ID under which Purity//FA is to communicate with the specified managers.

To remove the string set state to absent with version set to v2c

disable_warnings

boolean

added in everpure.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)

  • true

fa_url

string

FlashArray management IPv4 address or Hostname.

id_token

string

added in everpure.flasharray 1.43.0

A pre-signed JWT to authenticate with, as an alternative to api_token.

The token is exchanged by the array for a short-lived access token.

Requires a matching API Client to be registered on the array (see everpure.flasharray.purefa_apiclient).

issuer

string

added in everpure.flasharray 1.43.0

The API Client’s trusted identity issuer registered on the array.

Used with private_key_file.

key_id

string

added in everpure.flasharray 1.43.0

Key ID of the API Client that issues the identity token.

Used with private_key_file.

privacy_passphrase

string

SNMP v3 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

To remove the privacy and auth protocols set state to absent with version set to v3

Choices:

  • "AES"

  • "DES"

private_key_file

string

added in everpure.flasharray 1.43.0

Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token.

Requires client_id, key_id, issuer and username.

private_key_password

string

added in everpure.flasharray 1.43.0

Password protecting private_key_file, if encrypted.

state

string

Used to set or clear the SNMP v2c community string or the SNMP v3 auth and privacy protocols.

Choices:

  • "absent"

  • "present" ← (default)

user

string

SNMP v3 only. User ID which must be between 1 and 32 characters.

username

string

added in everpure.flasharray 1.43.0

Username the issued token should be granted to.

Must be a valid user on the array. Used with private_key_file.

version

string

Version of SNMP protocol to use for the manager.

Choices:

  • "v2c" ← (default)

  • "v3"

Notes

Note

  • This module requires the py-pure-client Python library.

  • Additional Python libraries may be required for specific modules.

  • You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly.

  • Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via everpure.flasharray.purefa_apiclient.

Examples

- name: Clear SNMP agent v2c community string
  everpure.flasharray.purefa_snmp_agent:
    version: v2c
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Clear SNMP agent v3 auth and privacy protocols
  everpure.flasharray.purefa_snmp_agent:
    version: v3
    user: admin
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Update v2c SNMP agent
  everpure.flasharray.purefa_snmp_agent:
    version: v2c
    community: public
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Update v3 SNMP manager
  everpure.flasharray.purefa_snmp_agent:
    version: v3
    user: admin
    auth_protocol: MD5
    auth_passphrase: password
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Everpure Ansible Team (@sdodsley)