hitachivantara.vspone_block.vsp.hv_snmp_settings_facts module – Retrieves SNMP configuration from Hitachi VSP 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_facts.

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.

Attributes

Attribute

Support

Description

check_mode

Support: full

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: Enable SNMP agent and configure SNMPv2c with trap destinations
  hitachivantara.vspone_block.vsp.hv_snmp_settings_facts:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key

Description

snmp_settings

dictionary

SNMP configuration details.

Returned: success

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)