17.9　SNMPの設定情報を取得する

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/snmp-settings/instance

リクエストメッセージ

オブジェクトID

instanceを指定します。

instanceは、単一のインスタンスしか持たないオブジェクトの場合に、オブジェクトIDとして指定する固定の値です。

クエリパラメータ

なし。

ボディ

なし。

レスポンスメッセージ

ボディ

SNMPのバージョンが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_G600",
    "contact": "confmanager.@example.com",
    "location": "Data Center 1F"
  },
  "snmpEngineID": "0x80000074046361336663353061"
}

SNMPのバージョンが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_G600",
    "contact": "confmanager.@example.com",
    "location": "Data Center 1F"
  },
  "snmpEngineID": "0x80000074046361336663353061"
}

属性	型	説明
isSNMPAgentEnabled	boolean	SNMPエージェントが有効かどうか true：有効 false：無効 この属性がtrueの場合、障害情報（SIM）をSNMPトラップで通知します。また、SNMPオペレーションのリクエスト（GET REQUEST、GETNEXT REQUEST、およびGETBULK REQUEST）を受け付けます。
snmpVersion	string	SNMPのバージョン 使用しているSNMPのバージョンが出力されます。 v1：SNMP v1 v2c：SNMP v2c v3：SNMP v3 設定されていない場合はUnestablishedが出力されます。
sendingTrapSetting	object	SNMPトラップの送信先 snmpv1v2cSettings（object[]） SNMPトラップの送信先の設定の配列 SNMP v1またはSNMP v2cの場合の設定がされているときに出力されます。 community（string） SNMPトラップの報告に使用するコミュニティ名 sendTrapTo（string[]） SNMPトラップの送信先のIPアドレスの配列 IPv4またはIPv6形式で出力されます。 snmpv3Settings（object[]） SNMPトラップの送信先の設定の配列 SNMP v3の場合の設定がされているときに出力されます。 userName（string） SNMPトラップの報告に使用するユーザ名 sendTrapTo（string） SNMPトラップの送信先のIPアドレス IPv4またはIPv6形式で出力されます。 authentication（object） 認証情報 パスワードによる認証が有効な場合に出力されます。出力される属性については、authentication属性に出力される属性の表を参照してください。
requestAuthenticationSetting	object	リクエスト許可の設定 SNMPオペレーションのリクエスト（GET REQUEST、GETNEXT REQUEST、およびGETBULK REQUEST）許可の設定が出力されます。 snmpv1v2cSettings（object[]） リクエスト許可の設定の配列 SNMP v1またはSNMP v2cの場合の設定がされているときに出力されます。 community（string） リクエストを受け付けるコミュニティ名 requestsPermitted（string[]） リクエストを受け付けるSNMPマネージャのIPアドレスの配列 IPv4またはIPv6形式で出力されます。空の配列の場合は、すべてのSNMPマネージャのリクエストを受け付けます。 snmpv3Settings（object[]） リクエスト許可の設定の配列 SNMP v3の場合の設定がされているときに出力されます。 userName（string） リクエストを受け付けるユーザ名 authentication（object） 認証情報 パスワードによる認証が有効な場合に出力されます。出力される属性については、authentication属性に出力される属性の表を参照してください。
systemGroupInformation	object	システムグループ情報 storageSystemName（string） ストレージシステム名 contact（string） 管理者名または連絡先 location（string） ストレージシステムの設置場所
snmpEngineID	string	SNMPエンジンを識別するID

authentication属性に出力される属性を次の表に示します。

属性	型	説明
protocol	string	認証方式 次に示す値が出力されます。 SHA MD5
password	string	パスワード 設定の有無に関係なく、空文字が出力されます。
encryption	object	暗号化情報 暗号化が有効の場合に出力されます。 protocol（string） 暗号化方式 次に示す値が出力されます。 AES DES key（string） 暗号鍵 設定の有無に関係なく、空文字が出力されます。

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/snmp-settings/instance