gslb template snmp

Specify SNMP template

snmp Specification

Parameter Value
Type Collection
Object Key(s) snmp-name
Collection Name snmp-list
Collection URI /axapi/v3/gslb/template/snmp
Element Name snmp
Element URI /axapi/v3/gslb/template/snmp/{snmp-name}
Element Attributes snmp_attributes
Partition Visibility shared
Schema snmp schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/gslb/template/snmp

snmp attributes

Create List

POST

/axapi/v3/gslb/template/snmp

snmp attributes

Get Object

GET

/axapi/v3/gslb/template/snmp/{snmp-name}

snmp attributes

Get List

GET

/axapi/v3/gslb/template/snmp

snmp-list

Modify Object

POST

/axapi/v3/gslb/template/snmp/{snmp-name}

snmp attributes

Replace Object

PUT

/axapi/v3/gslb/template/snmp/{snmp-name}

snmp attributes

Replace List

PUT

/axapi/v3/gslb/template/snmp

snmp-list

Delete Object

DELETE

/axapi/v3/gslb/template/snmp/{snmp-name}

snmp attributes

snmp-list

snmp-list is JSON List of snmp attributes

snmp-list : [

snmp attributes

auth-key

Description Specify authentication key (Specify key)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

auth-proto

Description ‘sha’: SHA; ‘md5’: MD5;

Type: string

Supported Values: sha, md5

Default: md5

community

Description Specify community for version 2c (Community name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

context-engine-id

Description Specify context engine ID

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

context-name

Description Specify context name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

host

Description Specify host (Host name or ip address)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

interface

Description Specify Interface ID

Type: number

Range: 0-2147483647

interval

Description Specify interval, default is 3 (Interval, unit: second, default is 3)

Type: number

Range: 1-999

Default: 3

oid

Description Specify OID

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

port

Description Specify port, default is 161 (Port Number, default is 161)

Type: number

Range: 1-65535

Default: 161

priv-key

Description Specify privacy key (Specify key)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

priv-proto

Description ‘aes’: AES; ‘des’: DES;

Type: string

Supported Values: aes, des

Default: des

security-engine-id

Description Specify security engine ID

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

security-level

Description ‘no-auth’: No authentication; ‘auth-no-priv’: Authentication, but no privacy; ‘auth-priv’: Authentication and privacy;

Type: string

Supported Values: no-auth, auth-no-priv, auth-priv

Default: no-auth

snmp-name

Description Specify name of snmp template

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

username

Description Specify username (User name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

version

Description ‘v1’: Version 1; ‘v2c’: Version 2c; ‘v3’: Version 3;

Type: string

Supported Values: v1, v2c, v3

Default: v3