Getting SNMP settings

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request explains how to obtain the SNMP settings for a storage system.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/snmp-settings/instance

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query parameters
None.
Body

None.

Response message

Body

The following is an example of output when the SNMP version is SNMP v1:

{
  "isSNMPAgentEnabled": true,
  "snmpVersion": "v1",
  "sendingTrapSetting": {
    "snmpv1v2cSettings": [
      {
        "community": "MyRestSNMPCommunity1",
        "sendTrapTo": [
          "192.0.2.100",
          "192.0.2.200"
        ]
      }
    ]
  },
  "requestAuthenticationSetting": {
    "snmpv1v2cSettings": [
      {
        "community": "MyRestSNMPCommunity2",
        "requestsPermitted": [
          "192.0.3.100"
        ]
      }
    ]
  },
  "systemGroupInformation": {
    "storageSystemName": "VSP_G700",
    "contact": "confmanager.@example.com",
    "location": "Data Center 1F"
  },
  "snmpEngineID": "0x80000074046361336663353061"
}

The following is an example of output when the SNMP version is SNMP v3:

{
  "isSNMPAgentEnabled": true,
  "snmpVersion": "v3",
  "sendingTrapSetting": {
    "snmpv3Settings": [
      {
        "userName": "MyRestSNMPUser1",
        "sendTrapTo": "192.0.2.100",
        "authentication": {
          "protocol": "SHA",
          "password": "",
          "encryption": {
            "protocol": "AES",
            "key": ""
          }
        }
      },
      {
        "userName": "MyRestSNMPUser2",
        "sendTrapTo": "192.0.2.200"
      }
    ]
  },
  "requestAuthenticationSetting": {
    "snmpv3Settings": [
      {
        "userName": "MyRestSNMPUser3",
        "authentication": {
          "protocol": "MD5",
          "password": "",
          "encryption": {
            "protocol": "DES",
            "key": ""
          }
        }
      }
    ]
  },
  "systemGroupInformation": {
    "storageSystemName": "VSP_G700",
    "contact": "confmanager.@example.com",
    "location": "Data Center 1F"
  },
  "snmpEngineID": "0x80000074046361336663353061"
}

Attribute

Type

Description

isSNMPAgentEnabled

boolean

Whether the SNMP Agent is enabled

  • true: Enabled
  • false: Disabled

If this attribute is true, error information (SIM) is reported by SNMP traps. Also, SNMP operation requests (GET REQUEST, GETNEXT REQUEST, and GETBULK REQUEST) are received.

snmpVersion

string

SNMP version

Outputs the SNMP version that is being used.

  • v1 : SNMP v1
  • v2c : SNMP v2c
  • v3 : SNMP v3

If this attribute is not set, Unestablished is output.

sendingTrapSetting

object

SNMP trap destinations

  • snmpv1v2cSettings (object[])

    Array of settings for SNMP trap destinations

    This is output when there is a setting for which the SNMP version is SNMPv1 or SNMPv2c.

    • community (string)

      Community name used for SNMP trap reports

    • sendTrapTo (string[])

      Array of IP addresses to which SNMP traps are sent

      The addresses are output in IPv4 or IPv6 IP.

  • snmpv3Settings (object[])

    Array of the settings for SNMP trap destinations

    This is output when there is a setting for which the SNMP protocol version is SNMP v3.

    • userName (string)

      User name that is used for SNMP trap reports

    • sendTrapTo (string)

      The IP address to which an SNMP trap is sent

      This is output in IPv4 or IPv6 format.

    • authentication (object)

      Authentication information

      This is output when password-based authentication is enabled. For details on the output attributes, see the table of the attributes output to the authentication attribute.

requestAuthenticationSetting

object

Settings for permitted requests.

Settings for the permitted requests (GET REQUEST, GETNEXT REQUEST, and GETBULK REQUEST) of SNMP operations are output.

  • snmpv1v2cSettings (object[])

    Array of the settings for permitted requests

    This is output when there is a setting for which the SNMP protocol version is SNMPv1 or SNMPv2c.

    • community (string)

      Name of the community that receives requests

    • requestsPermitted (string[])

      Array of the IP addresses of the SNMP Managers that receive requests

      This is output in IPv4 or IPv6 format. If the array is empty, requests of all SNMP Managers are received.

  • snmpv3Settings (object[])

    Array of the settings for permitted requests

    This is output when there is a setting for which the SNMP version is SNMP v3.

    • userName (string)

      Name of the user who receives requests

    • authentication (object)

      Authentication information

      This is output when password-based authentication is enabled. For details on the output attributes, see the table of the attributes output to the authentication attribute.

systemGroupInformation

object

Information of the system group

  • storageSystemName (string)

    Name of the storage system

  • contact (string)

    Contact information or name of the administrator

  • location (string)

    Location of the storage system

snmpEngineID

string

ID identifying the SNMP engine

The following table shows the attributes output to the authentication attribute.

Attribute

Type

Description

protocol

string

Authentication method

The following values are output:

  • SHA
  • MD5

password

string

Password

An empty character string is output even if a password has been set.

encryption

object

Encryption information

This is output when encryption is enabled.

  • protocol (string)

    Encryption method

    The following values are output:

    • AES
    • DES
  • key (string)

    Encryption key

    An empty character string is output even if an encryption key has been set.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snmp-settings/instance