health monitor method snmp¶
SNMP type
snmp Specification¶
Type Configuration Resource Element Name snmp Element URI /axapi/v3/health/monitor/{name}/method/snmp Element Attributes snmp_attributes Schema snmp schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/health/monitor/{name}/method/snmp | ||
Get Object | GET | /axapi/v3/health/monitor/{name}/method/snmp | ||
Modify Object | POST | /axapi/v3/health/monitor/{name}/method/snmp | ||
Replace Object | PUT | /axapi/v3/health/monitor/{name}/method/snmp | ||
Delete Object | DELETE | /axapi/v3/health/monitor/{name}/method/snmp |
snmp attributes¶
community
Description Specify SNMP community, default is “public” (Community String)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
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 SNMP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
snmp-port
Description Specify SNMP port, default is 161 (Port Number)
Type: number
Range: 1-65534
Default: 161
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
oid¶
Specification Type object asn
Description Specify the format in ASN.1 style
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: asn and mib are mutually exclusive
mib
Description ‘sysDescr’: The MIB-2 OID of system description, 1.1.0; ‘sysUpTime’: The MIB-2 OID of system up time, 1.3.0; ‘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