hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings module – Manages SNMP settings on VSP One SDS Block and Cloud systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.5.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.

New in hitachivantara.vspone_block 4.4.0

Synopsis

• This module manages SNMP settings including agent enablement, version configuration, trap settings, authentication settings, and system group information on 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.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.
spec dictionary / required	Specification for the SNMP settings.
is_snmp_agent_enabled boolean	Enable or disable the SNMP agent. Choices: false true
request_authentication_setting dictionary	Configuration for SNMP request authentication.
snmpv2c_settings list / elements=dictionary	SNMPv2c authentication settings list.
community string	SNMP community string for requests.
requests_permitted list / elements=string	List of IP addresses or host names permitted to make requests.
sending_trap_setting dictionary	Configuration for sending SNMP traps.
snmpv2c_settings list / elements=dictionary	SNMPv2c trap settings list.
community string	SNMP community string for traps.
send_trap_to list / elements=string	List of IP addresses or host names to send traps to.
snmp_version string	The SNMP version to use. Choices: "v2c" ← (default)
system_group_information dictionary	System group information settings.
contact string	Contact information for the system administrator.
location string	Physical location of the storage system.
storage_system_name string	Name of the storage system.

Attributes

Attribute	Support	Description
check_mode	Support: none	Determines if the module should run in check mode.

Examples

- name: Enable SNMP agent with basic configuration
  hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_snmp_agent_enabled: true
      snmp_version: "v2c"

- name: Configure SNMP with trap settings
  hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_snmp_agent_enabled: true
      snmp_version: "v2c"
      sending_trap_setting:
        snmpv2c_settings:
          - community: "public"
            send_trap_to:
              - "192.168.1.100"
              - "monitoring.company.com"
          - community: "private"
            send_trap_to:
              - "192.168.1.101"

- name: Configure SNMP with authentication settings
  hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_snmp_agent_enabled: true
      request_authentication_setting:
        snmpv2c_settings:
          - community: "readonly"
            requests_permitted:
              - "192.168.1.50"
              - "nms.company.com"
          - community: "readwrite"
            requests_permitted:
              - "192.168.1.51"

- name: Configure complete SNMP settings with system information
  hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_snmp_agent_enabled: true
      snmp_version: "v2c"
      sending_trap_setting:
        snmpv2c_settings:
          - community: "public"
            send_trap_to:
              - "192.168.1.100"
      request_authentication_setting:
        snmpv2c_settings:
          - community: "readonly"
            requests_permitted:
              - "192.168.1.50"
      system_group_information:
        storage_system_name: "Production-SDS-Block-01"
        contact: "admin@company.com"
        location: "Data Center Room A1"

- name: Disable SNMP agent
  hitachivantara.vspone_block.sds_block.hv_sds_block_snmp_settings:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_snmp_agent_enabled: false

Return Values

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

Key	Description
snmp_settings dictionary	The SNMP settings configuration. Returned: always
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

• Issue Tracker
• Repository (Sources)