hitachivantara.vspone_block.vsp.hv_snmp_settings_facts module – Retrieves SNMP configuration from VSP block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.8.1).

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
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves SNMP settings (v1, v2c, v3) from VSP block storage systems.
For example usage, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snmp.yml

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
is_snmp_agent_enabled boolean	Whether SNMP agent is enabled on the storage system. Returned: success Sample: `true`
request_authentication_setting dictionary	SNMP request authentication settings. Returned: success
snmpv1v2c_settings list / elements=dictionary	SNMPv1/v2c authentication settings. Returned: success
community string	SNMP community string. Returned: success Sample: `"public"`
requests_permitted list / elements=string	List of permitted IP addresses for requests. Returned: success Sample: `["192.168.1.0/24", "10.0.0.0/8"]`
snmpv3_settings list / elements=dictionary	SNMPv3 authentication settings. Returned: success
authentication dictionary	Authentication configuration. Returned: success
encryption dictionary	Encryption settings. Returned: success
key string	Encryption key. Returned: success Sample: `"encryptionKey456"`
protocol string	Encryption protocol. Returned: success Sample: `"AES"`
password string	Authentication password. Returned: success Sample: `"CHANGE_ME_SET_YOUR_PASSWORD"`
protocol string	Authentication protocol. Returned: success Sample: `"SHA"`
send_trap_to string	IP address to send traps to. Returned: success Sample: `"192.168.1.100"`
user_name string	SNMPv3 username. Returned: success Sample: `"snmpv3user"`
sending_trap_setting dictionary	SNMP trap configuration settings. Returned: success
snmpv1v2c_settings list / elements=dictionary	SNMPv1/v2c trap settings. Returned: success
community string	SNMP community string. Returned: success Sample: `"public"`
send_trap_to list / elements=string	List of IP addresses to send traps to. Returned: success Sample: `["172.25.37.79", "203.0.113.21"]`
snmpv3_settings list / elements=dictionary	SNMPv3 trap settings. Returned: success
authentication dictionary	Authentication configuration. Returned: success
encryption dictionary	Encryption settings. Returned: success
key string	Encryption key. Returned: success Sample: `"trapEncKey321"`
protocol string	Encryption protocol. Returned: success Sample: `"AES"`
password string	Authentication password. Returned: success Sample: `"CHANGE_ME_SET_YOUR_PASSWORD"`
protocol string	Authentication protocol. Returned: success Sample: `"SHA"`
send_trap_to string	IP address to send traps to. Returned: success Sample: `"192.168.1.200"`
user_name string	SNMPv3 username. Returned: success Sample: `"trapuser"`
snmp_engine_id string	SNMP engine ID of the storage system. Returned: success Sample: `"0x80001f88043636326431396163"`
snmp_version string	SNMP version configured on the system. Returned: success Sample: `"v2c"`
system_group_information dictionary	System group information for SNMP. Returned: success
contact string	Contact information for the system. Returned: success Sample: `"admin@hitachivantara.com"`
location string	Physical location of the system. Returned: success Sample: `"SC Data Center 1"`
storage_system_name string	Name of the storage system. Returned: success Sample: `"VSP-Block-45-102"`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_snmp_settings_facts_module.html