hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings_facts module – Get SNMP settings from VSP One SDS Block and Cloud 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.sds_block.hv_sds_block_snmp_settings_facts.

New in hitachivantara.vspone_block 4.4.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves SNMP settings including agent status, version configuration, trap settings, authentication settings, and system group information from Hitachi SDS Block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_snmp_settings_facts.yml

Requirements

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

python >= 3.9

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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	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.

Examples

- name: Retrieve all SNMP settings information
  hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

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 settings. Returned: success
is_snmp_agent_enabled boolean	Whether the SNMP agent is enabled. Returned: success Sample: `true`
request_authentication_setting dictionary	SNMP request authentication settings. Returned: success
snmpv2c_settings list / elements=dictionary	List of SNMPv2c authentication configurations. Returned: success
community string	SNMP community string for requests. Returned: success Sample: `"readonly"`
requests_permitted list / elements=string	List of hosts permitted to make SNMP requests. Returned: success Sample: `["192.168.1.50", "nms.company.com"]`
sending_trap_setting dictionary	SNMP trap configuration settings. Returned: success
snmpv2c_settings list / elements=dictionary	List of SNMPv2c trap configurations. Returned: success
community string	SNMP community string for traps. Returned: success Sample: `"public"`
send_trap_to list / elements=string	List of destinations for SNMP traps. Returned: success Sample: `["192.168.1.100", "monitoring.company.com"]`
snmp_version string	The SNMP version in use. Returned: success Sample: `"v2c"`
system_group_information dictionary	System group information. Returned: success
contact string	Contact information for the system administrator. Returned: success Sample: `"admin@company.com"`
location string	Physical location of the storage system. Returned: success Sample: `"Data Center Room A1"`
storage_system_name string	Name of the storage system. Returned: success Sample: `"Production-SDS-Block-01"`

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/sds_block.hv_sds_block_snmp_settings_facts_module.html