ansible.builtin.purefa_snmp (v2.9.27) — module

Configure FlashArray SNMP Managers

| "added in version" 2.9 of ansible.builtin"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manage SNMP managers on a Pure Storage FlashArray.

Changing of a named SNMP managers version is not supported.

This module is not idempotent and will always modify an existing SNMP manager due to hidden parameters that cannot be compared to the play parameters.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete existing SNMP manager
  purefa_snmp:
    name: manager1
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create v2c SNMP manager
  purefa_snmp:
    name: manager1
    community: public
    host: 10.21.22.23
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create v3 SNMP manager
  purefa_snmp:
    name: manager2
    version: v3
    auth_protocol: MD5
    auth_passphrase: password
    host: 10.21.22.23
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update existing SNMP manager
  purefa_snmp:
    name: manager1
    community: private
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Inputs

    
host:
    description:
    - IPv4 or IPv6 address or FQDN to send trap messages to.
    type: str

name:
    description:
    - Name of SNMP Manager
    required: true
    type: str

user:
    description:
    - SNMP v3 only. User ID recognized by the specified SNMP manager. Must be between
      1 and 32 characters.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create or delete SNMP manager
    type: str

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

version:
    choices:
    - v2c
    - v3
    default: v2c
    description:
    - Version of SNMP protocol to use for the manager.
    type: str

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str

community:
    description:
    - SNMP v2c only. Manager community ID. Between 1 and 32 characters long.
    type: str

notification:
    choices:
    - inform
    - trap
    default: trap
    description:
    - Action to perform on event.
    type: str

auth_protocol:
    choices:
    - MD5
    - SHA
    description:
    - SNMP v3 only. Hash algorithm to use
    type: str

auth_passphrase:
    description:
    - SNMPv3 only. Passphrase of 8 - 32 characters.
    type: str

privacy_protocol:
    choices:
    - AES
    - DES
    description:
    - SNMP v3 only. Encryption protocol to use
    type: str

privacy_passphrase:
    description:
    - SNMPv3 only. Passphrase to encrypt SNMP messages. Must be between 8 and 63 non-space
      ASCII characters.
    type: str