Specifying the SNMP error notification destinations

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 specifies settings related to reporting error information (SIM) of a storage system by using SNMP. Run this API function with https specified as the protocol to be used.

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

Notes on creating the request body

Before running this API function, obtain the current settings by using the API function that obtains SNMP information. The response body you have obtained is to be used as the request body for this API function. Values other than the SNMP-version value specified in the snmpVersion attribute might also be output in the obtained settings information. Change only the values of the attributes that you want to change.

For the VSP 5000 series, this API only updates the values of settings supported by the SNMP version that is specified by the snmpVersion attribute. For example, if v1 is set for the snmpVersion attribute, this API updates only the values of the items that are supported by version SNMP v1 and specified under the sendingTrapSetting attribute. For details, see the descriptions about the attributes of the request body.

For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, this API updates all settings by overwriting the existing values, including the settings of versions other than the version specified by the snmpVersion attribute. When you delete the information of the acquired response body, those setting contents are deleted.

Note:
  • Null character values are output to the acquired response body for the password attribute and key attribute. Change the values only when you want to change the setting.
  • You cannot change the setting for the snmpEngineID attribute. The value is ignored even if it is specified.
  • If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Storage Administrator (Initial Configuration)

Request line

PATCH 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

The following is a coding example 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"
  }
}

The following is a coding example when the SNMP version is SNMP v3:

{
  "isSNMPAgentEnabled": true,
  "snmpVersion": "v3",
  "sendingTrapSetting": {
    "snmpv3Settings": [
      {
        "userName": "MyRestSNMPUser1",
        "sendTrapTo": "192.0.2.100",
        "authentication": {
          "protocol": "SHA",
          "password": "TopSecretForMySNMP1",
          "encryption": {
            "protocol": "AES",
            "key": "KeyForMySNMP1"
          }
        }
      },
      {
        "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"
  }
}

Attribute

Type

Description

isSNMPAgentEnabled

boolean

(Required) Whether SNMP Agent is enabled

  • true: Enabled
  • false: Disabled

If this attribute is true, error information (SIM) is sent by using SNMP traps. Also, SNMP operation requests (GET REQUEST, GET NEXT REQUEST, and GET BULK REQUEST) are received.

snmpVersion

string

(Required) SNMP version

Specify the SNMP version that is used. The specifiable values are as follows:

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

sendingTrapSetting

object

(Optional) SNMP trap destinations

Specifiable attributes vary depending on the SNMP version.

  • snmpv1v2cSettings (object[])

    (Optional) Array of the settings for SNMP trap destinations (for SNMP v1 or SNMP v2c)

    You can specify up to 32 destinations. If you specify more than one destination, you must specify a unique community attribute. If you specify snmpv1v2cSettings attribute, you must also specify both the community attribute and the sendTrapTo attribute.

    • community (string)

      Community name used to report an SNMP trap#

      Specify a character string that consists of 1 to 180 characters.

    • sendTrapTo (string[])

      Array of the IP addresses to which SNMP traps are sent.

      Specify these in IPv4 or IPv6 format. You can specify up to 32 IP addresses.

  • snmpv3Settings (object[])

    (Optional) Array of the settings for SNMP trap destinations (for SNMP v3)

    You can specify up to 8 destinations. If you specify more than one destination, you must specify a unique sendTrapTo attribute. If you specify snmpv3Settings attribute, you must also specify both the userName attribute and the sendTrapTo attribute.

    • userName (string)

      User name that is used for SNMP trap reports#

      Specify a character string that consists of 1 to 32 characters.

    • sendTrapTo (string)

      Specify the IP address to which SNMP traps are sent.

      Specify these in IPv4 or IPv6 format.

    • authentication (object)

      (Optional) Authentication information

      Specify this attribute when password-based authentication is enabled. For details on the specifiable attributes, see the table of the attributes that can be specified for the authentication attribute.

requestAuthenticationSetting

object

(Optional) Settings for the permitted requests

Specify the settings for the permitted requests (GET REQUEST, GETNEXT REQUEST, and GETBULK REQUEST) of SNMP operations. Specifiable attributes vary depending on the SNMP version.

  • snmpv1v2cSettings (object[])

    (Optional) Array of the settings for permitted requests (for SNMP v1 or SNMP v2c)

    You can specify up to 32 requests. If you specify more than one request, you must specify a unique community attribute. If you specify snmpv1v2cSettings attribute, you must also specify both the community attribute and the requestsPermitted attribute.

    • community (string)

      Name of the community that receives requests#

      Specify a character string that consists of 1 to 180 characters.

    • requestsPermitted (string[])

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

      Specify this in IPv4 or IPv6 format. You can specify up to 32 IP addresses. If you specify an empty array, requests of all SNMP Managers are received.

  • snmpv3Settings (object[])

    (Optional) Array of the settings for permitted requests (for SNMP v3)

    You can specify up to 8 requests. If you specify more than one request, you must specify a unique userName attribute. If you specify snmpv3Settings attribute, you must also specify the userName attribute.

    • userName (string)

      Name of the user who receives requests#

      Specify a character string that consists of 1 to 32 characters. This attribute is case sensitive.

    • authentication (object)

      (Optional) Authentication information

      Specify this attribute when password-based authentication is enabled. For details on the specifiable attributes, see the table of the attributes that can be specified for the authentication attribute.

systemGroupInformation

object

(Required) Information of the system group

  • storageSystemName (string)

    (Required) Name of the storage system#

    This is output as the sysName of the MIB of SNMP Agent. Specify a character string that consists of 1 to 180 characters.

  • contact (string)

    (Required) Contact information or name of the administrator#

    This is output as the sysContact of the MIB of SNMP Agent. Specify a character string that consists of 0 to 180 characters.

  • location (string)

    (Required) Location of the storage system#

    This is output as the sysLocation of the MIB of SNMP Agent. Specify a character string that consists of 0 to 180 characters.

The following table shows the attributes that can be specified for the authentication attribute. If you specify authentication attribute, you must also specify both the protocol attribute and the password attribute.

Attribute

Type

Description

protocol

string

Authentication method

You can specify the following values:

  • SHA
  • MD5

password

string

Password#

For a VSP 5000 series storage system, specify a character string consisting of no fewer than 8 and no more than 180 characters.

For a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system, specify a character string consisting of no fewer than 8 and no more than 64 characters.

If you do not want to change the password, specify an empty character string.

encryption

object

(Optional) Encryption information

Specify this item to enable encryption. If you specify this attribute, you must also specify both the protocol attribute and the key attribute.

  • protocol (string)

    Encryption method

    You can specify the following values:

    • AES
    • DES
  • key (string)

    Encryption key#

    For a VSP 5000 series storage system, specify a character string consisting of no fewer than 8 and no more than 180 characters.

    For a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system, specify a character string consisting of no fewer than 8 and no more than 64 characters.

    If you do not want to change the encryption key, specify an empty character string.

#: You can use the following characters:
  • Alphanumeric characters
  • The following symbols:

    ! # $ ' ( ) + - . = @ [ ] _ ` { } ~

    For a VSP 5000 series storage system, the following symbols can be used for the community attribute.

    ! # $ ( ) + - . = @ [ ] _ ` { } ~

  • Spaces (except at the beginning or end of a character string)

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the SNMP settings

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 PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/snmp-settings/instance