hitachivantara.vspone_block.vsp.hv_snmp_settings module – Manage SNMP settings on Hitachi Vantara storage systems.

Note

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

To use it in a playbook, specify: hitachivantara.vspone_block.vsp.hv_snmp_settings.

New in hitachivantara.vspone_block 4.0.0

Synopsis

Requirements

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

  • python >= 3.8

Parameters

Parameter

Comments

connection_info

dictionary / required

Information required to establish a connection to the storage system.

address

string / required

IP address or hostname of the storage system.

api_token

string

Token used to operate on locked resources.

password

string

Password for authentication. This is a required field.

username

string

Username for authentication. This is a required field.

spec

dictionary

SNMP settings specification.

is_snmp_agent_enabled

boolean / required

Whether SNMP agent is enabled.

Choices:

  • false

  • true

snmp_v1v2c_authentication_settings

list / elements=dictionary

SNMP v1/v2c authentication settings.

community

string / required

SNMP community string.

requests_permitted

list / elements=string / required

List of permitted requests.

snmp_v1v2c_trap_destination_settings

list / elements=dictionary

SNMP v1/v2c trap destination settings.

community

string / required

SNMP community string.

send_trap_to

list / elements=string / required

List of trap destination addresses.

snmp_v3_authentication_settings

list / elements=dictionary

SNMP v3 authentication settings.

authentication

dictionary

Authentication settings for SNMP v3.

encryption

dictionary

Encryption settings.

key

string

Encryption key.

protocol

string

Encryption protocol.

Choices:

  • "AES"

  • "DES"

password

string

Authentication password.

protocol

string

Authentication protocol.

Choices:

  • "MD5"

  • "SHA"

user_name

string / required

SNMP v3 user name.

snmp_v3_trap_destination_settings

list / elements=dictionary

SNMP v3 trap destination settings.

authentication

dictionary

Authentication settings for SNMP v3.

encryption

dictionary

Encryption settings.

key

string

Encryption key.

protocol

string

Encryption protocol.

Choices:

  • "AES"

  • "DES"

password

string

Authentication password.

protocol

string

Authentication protocol.

Choices:

  • "MD5"

  • "SHA"

send_trap_to

string / required

Trap destination address.

user_name

string / required

SNMP v3 user name.

snmp_version

string / required

SNMP version to use.

Choices:

  • "v1"

  • "v2c"

  • "v3"

system_group_information

dictionary / required

System group information.

contact

string / required

Contact information.

location

string / required

Location information.

storage_system_name

string / required

Name of the storage system.

state

string

Desired state of the SNMP settings.

Choices:

  • "present" ← (default)

  • "test"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Notes

Note

  • Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Configure SNMP settings on Hitachi Vantara storage system
  hitachivantara.vspone_block.vsp.hv_snmp_settings:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret
    spec:
      is_snmp_agent_enabled: true
      snmp_version: "v2c"
      snmp_v1v2c_trap_destination_settings:
        - community: "public"
          send_trap_to:
            - "203.0.113.1"
            - "203.0.113.2"
      snmp_v1v2c_authentication_settings:
        - community: "public"
          requests_permitted:
            - "get"
            - "set"
      system_group_information:
        storage_system_name: "VSP-Block-01"
        contact: "[email protected]"
        location: "Data Center 1"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

snmp_settings

dictionary

SNMP configuration details retrieved from the storage system.

Returned: always

Sample: {"isSNMPAgentEnabled": true, "requestAuthenticationSetting": {"snmpv3Settings": [{"authentication": {"encryption": {"key": "", "protocol": "DES"}, "password": "", "protocol": "MD5"}, "userName": "MyRestSNMPUser3"}]}, "sendingTrapSetting": {"snmpv3Settings": [{"authentication": {"encryption": {"key": "", "protocol": "AES"}, "password": "", "protocol": "SHA"}, "sendTrapTo": "192.0.2.100", "userName": "MyRestSNMPUser1"}, {"sendTrapTo": "192.0.2.200", "userName": "MyRestSNMPUser2"}]}, "snmpEngineID": "0x80000074046361336663353061", "snmpVersion": "v3", "systemGroupInformation": {"contact": "confmanager.@example.com", "location": "Data Center 1F", "storageSystemName": "VSP_G700"}}

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)