SNMP communities (/snmp/)
URL : https://[server_name]/api/v1/snmp/
This endpoint is used to configure SNMP v1/v2 communities.
Supported fields
|
Field |
Display name |
Type |
Required |
Other restrictions |
|---|---|---|---|---|
|
name |
SNMP community name |
String |
Yes |
|
|
cpu |
Enable high CPU usage trap |
Boolean |
No |
Default is disabled |
|
memory |
Enable high memory usage trap |
Boolean |
No |
Default is disabled |
|
disk |
Enable high disk usage trap |
Boolean |
No |
Default is disabled |
|
interface_ip |
Enable interface IP change trap |
Boolean |
No |
Default is disabled |
|
users |
Enable provisioned users exceed threshold trap |
Boolean |
No |
Default is disabled |
|
groups |
Enable provisioned usergroups exceed threshold trap |
Boolean |
No |
Default is disabled |
|
radius_clients |
Enable provisioned RADIUS clients exceed threshold trap |
Boolean |
No |
Default is disabled |
|
tacplus_clients |
Enable provisioned TACACS+ clients exceed threshold trap |
Boolean |
No |
Default is disabled |
|
auth_events |
Enable high authentication events rate trap |
Boolean |
No |
Default is disabled |
|
auth_failures |
Enable high authentication failures rate trap |
Boolean |
No |
Default is disabled |
|
user_lockout |
Enable user lockout trap |
Boolean |
No |
Default is disabled |
|
ha_status |
Enable HA status change trap |
Boolean |
No |
Default is disabled |
|
ha_sync |
Enable low HA synchronization activity trap |
Boolean |
No |
Default is disabled |
|
raid |
Enable RAID status change trap |
Boolean |
No |
Default is disabled |
Allowed methods
|
HTTP method |
Resource URI |
Action |
|---|---|---|
|
GET |
/api/v1/snmp/ |
Retrieve all SNMP communities. |
|
GET |
/api/v1/snmp/[id]/ |
Retrieve SNMP community with ID id. |
|
POST |
/api/v1/snmp/ |
Create new SNMP community. |
|
PATCH |
/api/v1/snmp/[id]/ |
Update SNMP community with ID id. |
|
DELETE |
/api/v1/snmp/[id]/ |
Delete SNMP community with ID id. |