Spec-Zone.ru › Ansible

hitachivantara.vspone_block.vsp.hv_snmp_settings module – Manage SNMP settings on 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.

New in hitachivantara.vspone_block 4.0.0

  • Synopsis
  • Requirements
  • Parameters
  • Attributes
  • Notes
  • Examples
  • Return Values

Synopsis

  • This module allows you to configure SNMP (Simple Network Management Protocol) settings on VSP block storage systems, including agent enablement, SNMP versions, trap destinations, authentication, and system group information.
  • For example usage, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snmp_settings.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.

spec

dictionary

SNMP settings specification.

is_snmp_agent_enabled

boolean / required

Whether SNMP agent is enabled. Required for the Specifying the SNMP error notification destinations with v2c version /Specifying the SNMP error notification destinations with v3 version /Disable the SNMP agent tasks.

Choices:

  • false
  • true

snmp_v1v2c_authentication_settings

list / elements=dictionary

SNMP v1/v2c authentication settings. Required for the Specifying the SNMP error notification destinations with v2c version task.

community

string / required

SNMP community string. Required for the Specifying the SNMP error notification destinations with v2c version task.

requests_permitted

list / elements=string / required

List of permitted requests. Required for the Specifying the SNMP error notification destinations with v2c version task.

snmp_v1v2c_trap_destination_settings

list / elements=dictionary

SNMP v1/v2c trap destination settings. Required for the Specifying the SNMP error notification destinations with v2c version task.

community

string / required

SNMP community string. Required for the Specifying the SNMP error notification destinations with v2c version task.

send_trap_to

list / elements=string / required

List of trap destination addresses. Required for the Specifying the SNMP error notification destinations with v2c version task.

snmp_v3_authentication_settings

list / elements=dictionary

SNMP v3 authentication settings. Required for the Specifying the SNMP error notification destinations with v3 version task.

authentication

dictionary

Authentication settings for SNMP v3. Optional for the Specifying the SNMP error notification destinations with v3 version task.

encryption

dictionary

Encryption settings. Optional for the Specifying the SNMP error notification destinations with v3 version task.

key

string

Encryption key. Optional for the Specifying the SNMP error notification destinations with v3 version task.

protocol

string

Encryption protocol. Optional for the Specifying the SNMP error notification destinations with v3 version task.

Choices:

  • "AES"
  • "DES"

password

string

Authentication password. Optional for the Specifying the SNMP error notification destinations with v3 version task.

protocol

string

Authentication protocol. Optional for the Specifying the SNMP error notification destinations with v3 version task.

Choices:

  • "MD5"
  • "SHA"

user_name

string / required

SNMP v3 user name. Required for the Specifying the SNMP error notification destinations with v3 version task.

snmp_v3_trap_destination_settings

list / elements=dictionary

SNMP v3 trap destination settings. Required for the Specifying the SNMP error notification destinations with v3 version task.

authentication

dictionary

Authentication settings for SNMP v3. Optional for the Specifying the SNMP error notification destinations with v3 version task.

encryption

dictionary

Encryption settings. Optional for the Specifying the SNMP error notification destinations with v3 version task.

key

string

Encryption key. Optional for the Specifying the SNMP error notification destinations with v3 version task.

protocol

string

Encryption protocol. Optional for the Specifying the SNMP error notification destinations with v3 version task.

Choices:

  • "AES"
  • "DES"

password

string

Authentication password. Optional for the Specifying the SNMP error notification destinations with v3 version task.

protocol

string

Authentication protocol. Optional for the Specifying the SNMP error notification destinations with v3 version task.

Choices:

  • "MD5"
  • "SHA"

send_trap_to

string / required

Trap destination address. Required for the Specifying the SNMP error notification destinations with v3 version task.

user_name

string / required

SNMP v3 user name. Required for the Specifying the SNMP error notification destinations with v3 version task.

snmp_version

string / required

SNMP version to use. Required for the Specifying the SNMP error notification destinations with v2c version /Specifying the SNMP error notification destinations with v3 version /Disable the SNMP agent tasks.

Choices:

  • "v1"
  • "v2c"
  • "v3"

system_group_information

dictionary / required

System group information. Required for the Specifying the SNMP error notification destinations with v2c version /Specifying the SNMP error notification destinations with v3 version /Disable the SNMP agent tasks.

contact

string / required

Contact information. Required for the Specifying the SNMP error notification destinations with v2c version /Specifying the SNMP error notification destinations with v3 version /Disable the SNMP agent tasks.

location

string / required

Location information. Required for the Specifying the SNMP error notification destinations with v2c version /Specifying the SNMP error notification destinations with v3 version /Disable the SNMP agent tasks.

storage_system_name

string / required

Name of the storage system. Required for the Specifying the SNMP error notification destinations with v2c version /Specifying the SNMP error notification destinations with v3 version /Disable the SNMP agent tasks.

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.
  • For Sending a test SNMP trap
    1. Sends a test SNMP trap to verify that the SIM error reporting settings are correctly configured for the SNMP manager. If any resources on the target storage system are locked via the REST API, this task cannot run. Unlock those resources before proceeding.

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: "admin@datacenter.com"
        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.

Returned: always

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

  • Issue Tracker
  • Repository (Sources)

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API