Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-174040133.9 KB
SnmpConfig

Get details snmp alert source information configured on behalf of backend devices

get/v1/storages/{storage_id}/snmp-config

Path parameters

storage_idstring required

Database ID created for a storage backend.

Response

OK

idstring
created_atstring date-time
updated_atstring date-time
version'SNMPV2C' | 'SNMPV3'

SNMP version. Should be mandatorily set by user

community_stringstring

Community string. This should be filled ig version is V2C

usernamestring

SNMP V3 usm username. This should be filled ig version is V3

engine_idstring

Engind ID of the device which will be sending the traps

security_level'noAuthnoPriv' | 'authNoPriv' | 'authPriv'

Security level for the user

auth_protocol'MD5' | 'SHA'

Authentication protocol to be selected. This should be filled if authNoPriv or authPriv is set as security_level

auth_keystring

Authentication key. This should be filled if authNoPriv or authPriv is set

privacy_protocol'3DES' | 'DES' | 'AES'

Privacy or encryption protocol to be selected. This should be filled if authPriv is set as security_level

privacy_keystring

Privacy or encryption password. This should be filled if authPriv is set as security_level

hoststring

All alert source ips of the device

context_namestring

Context name of the alert source

retry_numinteger

Maximum number of retries while connecting to alert source By default, set to 1

expirationinteger

Expiration time (in sec) for one alert source connect request By default, set to 2

portinteger

Port for connecting to alert source By default, set to 161

Example response

{
  "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
  "created_at": "2017-07-10T14:36:58.014Z",
  "updated_at": "2017-07-10T14:36:58.014Z",
  "version": "SNMPV2C",
  "security_level": "noAuthnoPriv",
  "auth_protocol": "MD5",
  "privacy_protocol": "DES",
  "host": "10.0.0.1,127.0.0.1",
  "context_name": "New Context",
  "retry_num": 2,
  "expiration": 60,
  "port": 20162
}