gslb template snmp

Configure an SNMP template to query data for use by the BW-Cost metric.

snmp Specification

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
Schema snmp schema

Operations Allowed:

Operation Method URI Payload

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: Specifies the authentication key. This is applicable if the security level is auth-no-priv or authpriv .

Type: string

Format: string-rlx

auth-proto

Description: Specifies the authentication protocol. This command is applicable if the security level is auth-no-priv or auth-priv . You can specify sha or md5 .

Type: string

Supported Values: sha, md5

Default: md5

community

Description: For SNMPv1 or v2c, specifies the community string required for authentication.

Type: string

Format: string-rlx

context-engine-id

Description: Specifies the ID of the SNMPv3 protocol engine running on the site ACOS device.

Type: string

Format: string-rlx

context-name

Description: Specifies an SNMPv3 collection of management information objects accessible by an SNMP entity.

Type: string

Format: string-rlx

host

Description: Specifies the IP address or hostname of the site ACOS device.

Type: string

Format: string-rlx

interface

Description: Specifies the SNMP interface ID.

Type: number

Range: 0-2147483647

interval

Description: Specifies the protocol port on which the site ACOS devices listen for the SNMP requests from the GSLB ACOS device.

Type: number

Range: 1-999

Default: 3

oid

Description: Specifies the interface MIB object to query on the site ACOS device.

Type: string

port

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

Type: number

Range: 1-65535

Default: 161

priv-key

Description: Specifies the encryption key. This is applicable only if the security level is auth-priv .

Type: string

Format: string-rlx

priv-proto

Description: Specifies the privacy protocol used for encryption. This command is applicable only if the security level is auth-priv . You can specify aes or des .

Type: string

Supported Values: aes, des

Default: des

security-engine-id

Description: Specifies the ID of the SNMPv3 security engine running on the site ACOS device.

Type: string

Format: string-rlx

security-level

Description: Specifies the SNMPv3 security level.

  • no-auth : Authentication is not used and encryption (privacy) is not used.
  • auth-no-priv : Authentication is used but encryption is not used.
  • auth-priv : Both authentication and encryption are used.

Type: string

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

Default: no-auth

snmp-name

Description: Specify the name of the SNMP template.

Type: string

Required: Yes

user-tag

Description: Customized tag

Type: string

Format: string-rlx

username

Description: Specifies the SNMPv3 username required for access to the SNMP agent on the site ACOS device.

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

version

Description: Specifies the SNMP version running on the site ACOS device.

  • v1 : Version 1
  • v2c : Version 2c
  • v3 : Version 3

Type: string

Supported Values: v1, v2c, v3

Default: v3