dellemc.powerscale.snmp_settings (3.0.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0

Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 3.0.0

Description

Manage SNMP settings on PowerScale storage systems includes retrieving, and updating SNMP settings.

Requirements

• A Dell PowerScale Storage system.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get SNMP settings
  dellemc.powerscale.snmp_settings:
    onefs_host: "{{ onefs_host }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update SNMP settings
  dellemc.powerscale.snmp_settings:
    onefs_host: "{{ onefs_host }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    read_only_community: "community-name"
    snmp_v3:
      access: true
      auth_protocol: "SHA"
      privacy_password: "password"
      password: "auth_password"
      privacy_protocol: "AES"
      security_level: "noAuthNoPriv"
      read_only_user: "user"
    system_contact: "contact@domain.com"
    system_location: "Enabled SNMP"

Inputs

    
port_no:
    default: '8080'
    description:
    - Port number of the PowerScale cluster.It defaults to 8080 if not specified.
    required: false
    type: str

service:
    description:
    - Whether the SNMP service is enabled.
    type: bool

snmp_v3:
    description:
    - Specify the access, privacy, and security level for SNMP v3.
    suboptions:
      access:
        description:
        - Whether SNMP v3 is enabled.
        type: bool
      auth_protocol:
        choices:
        - SHA
        - MD5
        description:
        - SNMP v3 authentication protocol.
        type: str
      password:
        description:
        - SNMP v3 authentication password.
        type: str
      privacy_password:
        description:
        - SNMP v3 privacy password.
        type: str
      privacy_protocol:
        choices:
        - AES
        - DES
        description:
        - SNMP v3 privacy protocol.
        type: str
      read_only_user:
        description:
        - The read-only user for SNMP v3 requests.
        - The system default value of read-only user is C(general).
        type: str
      security_level:
        choices:
        - noAuthNoPriv
        - authNoPriv
        - authPriv
        description:
        - SNMP v3 security level.
        type: str
    type: dict

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    type: str

onefs_host:
    description:
    - IP address or FQDN of the PowerScale cluster.
    required: true
    type: str

verify_ssl:
    choices:
    - true
    - false
    description:
    - boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified.
    - C(false) - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

api_password:
    description:
    - the password of the PowerScale cluster.
    required: true
    type: str

system_contact:
    description:
    - SNMP system owner contact information.
    - This must be a valid email address.
    - The contact information is set for the reporting purpose.
    type: str

snmp_v2c_access:
    description:
    - Whether the SNMP v2c is enabled.
    - OneFS support SNMP v2c and later.
    type: bool

system_location:
    description:
    - The cluster description for SNMP system.
    - The cluster description is set for the reporting purpose.
    type: str

read_only_community:
    description:
    - SNMP read-only community name.
    - The system default value of the read-only community name is C(I$ilonpublic).
    - Update the read-only community name while enabling SNMP v2c.
    type: str

Outputs

changed:
  description: A Boolean value indicating if task had to make changes.
  returned: always
  sample: 'true'
  type: bool
snmp_settings:
  contains:
    read_only_community:
      description: SNMP read-only community name.
      type: str
    service:
      description: Whether the SNMP service is enabled.
      type: bool
    smnmp_v3_read_only_user:
      description: SNMP v3 read-only user.
      type: str
    snmp_v1_v2c_access:
      description: Whether the SNMP v2c access is enabled.
      type: bool
    snmp_v3_access:
      description: Whether the SNMP v3 is enabled.
      type: bool
    snmp_v3_auth_protocol:
      description: SNMP v3 authentication protocol.
      type: str
    snmp_v3_priv_protocol:
      description: SNMP v3 privacy protocol.
      type: str
    snmp_v3_security_level:
      description: SNMP v3 security level.
      type: str
    system_contact:
      description: SNMP system owner contact information.
      type: str
    system_location:
      description: The cluster description for SNMP system.
      type: str
  description: The details of SNMP settings.
  returned: always
  sample:
    read_only_community: community-name
    service: true
    snmp_v1_v2c_access: true
    snmp_v3_access: true
    snmp_v3_auth_protocol: SHA
    snmp_v3_priv_protocol: AES
    snmp_v3_read_only_user: user
    snmp_v3_security_level: noAuthNoPriv
    system_contact: contact@domain.com
    system_location: Enabled SNMP
  type: dict