Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

SNMP general setting (/snmpgeneral/)

URL : https://[server_name]/api/v1/snmpgeneral/

This end-point is used to set the general SNMP settings and trap thresholds.

Supported fields

Field

Display name

Type

Required

Other restrictions

contact

SNMP contact

String

No

 

description

SNMP description

String

No

 

location

SNMP location

String

No

 

users

Provisioned users nearly full threshold

Integer

No

Percentage (0-100)

groups

Provisioned usergroups nearly full threshold

Integer

No

Percentage (0-100)

radius_clients

Provisioned RADIUS clients nearly full threshold

Integer

No

Percentage (0-100)

tacplus_clients

Provisioned TACACS+ clients nearly full threshold

Integer

No

Percentage (0-100)

auth_events

High authentication events rate threshold

Integer

No

 

auth_failures

High authentication failure rate threshold

Integer

No

 

cpu

High CPU utilization threshold

Integer

No

Percentage (0-100)

memory

High memory utilization threshold

Integer

No

Percentage (0-100)

disk

High disk utilization threshold

Integer

No

Percentage (0-100)

Allowed methods

HTTP method Resource URI Action
GET /api/v1/snmpgeneral/ Retrieve SNMP general settings.

PATCH

/api/v1/snmpgeneral/

Update SNMP general settings.

SNMP general setting (/snmpgeneral/)

URL : https://[server_name]/api/v1/snmpgeneral/

This end-point is used to set the general SNMP settings and trap thresholds.

Supported fields

Field

Display name

Type

Required

Other restrictions

contact

SNMP contact

String

No

 

description

SNMP description

String

No

 

location

SNMP location

String

No

 

users

Provisioned users nearly full threshold

Integer

No

Percentage (0-100)

groups

Provisioned usergroups nearly full threshold

Integer

No

Percentage (0-100)

radius_clients

Provisioned RADIUS clients nearly full threshold

Integer

No

Percentage (0-100)

tacplus_clients

Provisioned TACACS+ clients nearly full threshold

Integer

No

Percentage (0-100)

auth_events

High authentication events rate threshold

Integer

No

 

auth_failures

High authentication failure rate threshold

Integer

No

 

cpu

High CPU utilization threshold

Integer

No

Percentage (0-100)

memory

High memory utilization threshold

Integer

No

Percentage (0-100)

disk

High disk utilization threshold

Integer

No

Percentage (0-100)

Allowed methods

HTTP method Resource URI Action
GET /api/v1/snmpgeneral/ Retrieve SNMP general settings.

PATCH

/api/v1/snmpgeneral/

Update SNMP general settings.