health monitor method snmp

Configure an SNMP type health monitor.

snmp Specification

Type Configuration Resource
Element Name snmp
Element URI /axapi/v3/health/monitor/{name}/method/snmp
Element Attributes snmp_attributes
Schema snmp schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/health/monitor/{name}/method/snmp

snmp Attributes

Get Object

GET

/axapi/v3/health/monitor/{name}/method/snmp

snmp Attributes

Modify Object

POST

/axapi/v3/health/monitor/{name}/method/snmp

snmp Attributes

Replace Object

PUT

/axapi/v3/health/monitor/{name}/method/snmp

snmp Attributes

Delete Object

DELETE

/axapi/v3/health/monitor/{name}/method/snmp

snmp Attributes

snmp Attributes

community

Description: Specify the SNMP community.

Type: string

Format: string-rlx

Default: public

oid

Description: oid is a JSON Block . Please see below for oid

Type: Object

operation

Description: operation is a JSON Block . Please see below for operation

Type: Object

snmp

Description: Enable SNMP.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

snmp-port

Description: Specify the SNMP port.

Type: number

Range: 1-65534

Default: 161

uuid

Description: uuid of the object

Type: string

oid

Specification
Type object

asn

Description: Specify the format in ASN.1 style.

Type: string

Format: string-rlx

Mutual Exclusion: asn and mib are mutually exclusive

mib

Description: Only MIB-2 OIDs are supported

  • sysDescr : The MIB-2 OID of system description, 1.1.8
  • sysUpTime : The MIB-2 OID of system up time
  • sysName : The MIB-2 OID of system nume, 1.5.0

Type: string

Supported Values: sysDescr, sysUpTime, sysName

Mutual Exclusion: mib and asn are mutually exclusive

operation

Specification
Type object

oper-type

Description: ‘getnext’: Get-Next-Request command; ‘get’: Get-Request command;

Type: string

Supported Values: getnext, get