CRM
Critical Resource Monitoring.
| URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
| /rest/v1/running/crm | Y | N | Y | N | N |
| /rest/v1/running/crm/crm-threshold/{resource} | Y | N | Y | N | N |
| /rest/v1/rpc/show-crm-resource | N | Y | N | N | N |
Examples
Section titled “Examples”Show CRM resource
Section titled “Show CRM resource”POST HTTPS://{switch IP}/rest/v1/rpc/show-crm-resourceGET Critical Resource Monitoring configurations.
Section titled “GET Critical Resource Monitoring configurations.”GET HTTPS://{switch IP}/rest/v1/running/crmUpdate a Critical Resource Monitoring threshold.
Section titled “Update a Critical Resource Monitoring threshold.”PATCH HTTPS://{switch IP}/rest/v1/running/crm/crm-threshold{ "resource": "nexthop-group-object", "type": "used-percentage", "high": "59", "low": "12"}Properties Descriptions
Section titled “Properties Descriptions”CRM thresholds
Section titled “CRM thresholds”Tree Diagrams
+--rw crm +--rw crm-threshold* [resource] | +--rw resource | +--rw type? | +--rw low? | +--rw high? +--rw polling-interval?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| crm | M | Path-only node, has no configurable value. | |
| Critical Resource Monitoring for devices. | |||
| crm-threshold | M | (sub-property of crm) | |
| Path-only node, has no configurable value. | |||
| resource | M | ”ipv4-route" | |
| "ipv4-neighbor" | |||
| "ipv4-nexthop" | |||
| "ipv6-route" | |||
| "ipv6-neighbor" | |||
| "ipv6-nexthop" | |||
| "mpls-inseg" | |||
| "mpls-nexthop" | |||
| "nexthop-group-object" | |||
| "nexthop-group-member" | |||
| "acl-table" | |||
| "acl-group" | |||
| "acl-group-entry" | |||
| "acl-group-counter" | |||
| "fdb" | |||
| "ipmc" | |||
| "snat" | |||
| "dnat" | |||
| "srv6-nexthop" | |||
| "srv6-my-sid-entry” | (sub-property of crm-threshold) | ||
| Resource select. | |||
| type | O | ”used-percentage" | |
| "used-count" | |||
| "free-count” | (sub-property of crm-threshold) | ||
| Type of crm threshold. | |||
| Default value: “used-percentage” | |||
| low | O | 1..65535 | (sub-property of crm-threshold) |
| Lowest warning of crm threshold. If type is used-percentage or used-counts, when device counters lower than low threshold, crm will stop to warning. If type is free-counts, when device counters lower than low threshold, crm will start to warning. If type is used-percentage, this value range is 1..100 | |||
| Default value: 70 | |||
| high | O | 1..65535 | (sub-property of crm-threshold) |
| Highest warning of crm threshold. If type is used-percentage or used-counts, when device counters higher than low threshold, crm will start to warning. If type is free-counts, when device counters higher than low threshold, crm will stop to warning. If type is used-percentage, this value range is 1..100 | |||
| Default value: 85 | |||
| polling-interval | O | 1..9999 | (sub-property of crm) |
| crm polling interval. | |||
| Default value: 300 |
show-crm-resource
Section titled “show-crm-resource”Tree Diagrams
+---x show-crm-resource +---w input | +---w resource? +--ro output +--ro crm-stats* [resource] | +--ro resource | +--ro used? | +--ro available? +--ro acl-table-stats* [table-id resource] | +--ro table-id | +--ro resource | +--ro used? | +--ro available? +--ro acl-stats* [stage bind-point resource] +--ro stage +--ro bind-point +--ro resource +--ro used? +--ro available?Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-crm-resource | M | Path-only node, has no configurable value. | |
| Display statistics about CRM resource(s) | |||
| resource | O | ”ipv4-route" | |
| "ipv4-neighbor" | |||
| "ipv4-nexthop" | |||
| "ipv6-route" | |||
| "ipv6-neighbor" | |||
| "ipv6-nexthop" | |||
| "mpls-inseg" | |||
| "mpls-nexthop" | |||
| "nexthop-group-object" | |||
| "nexthop-group-member" | |||
| "acl-table" | |||
| "acl-group" | |||
| "acl-group-entry" | |||
| "acl-group-counter" | |||
| "fdb" | |||
| "ipmc" | |||
| "snat" | |||
| "dnat" | |||
| "srv6-nexthop" | |||
| "srv6-my-sid-entry” | (sub-property of input) | ||
| Specify which crm resource to display. If not given, display information about all resources. | |||
| crm-stats | RO | (sub-property of output) | |
| Path-only node, has no configurable value. | |||
| This list exists when resource is not specified or not acl related. | |||
| resource | RO | ”ipv4-route" | |
| "ipv4-neighbor" | |||
| "ipv4-nexthop" | |||
| "ipv6-route" | |||
| "ipv6-neighbor" | |||
| "ipv6-nexthop" | |||
| "mpls-inseg" | |||
| "mpls-nexthop" | |||
| "nexthop-group-object" | |||
| "nexthop-group-member" | |||
| "acl-table" | |||
| "acl-group" | |||
| "acl-group-entry" | |||
| "acl-group-counter" | |||
| "fdb" | |||
| "ipmc" | |||
| "snat" | |||
| "dnat" | |||
| "srv6-nexthop" | |||
| "srv6-my-sid-entry” | (sub-property of crm-stats) | ||
| Resource select. | |||
| used | RO | uint64 | (sub-property of crm-stats) |
| Resource used count. | |||
| available | RO | uint64 | (sub-property of crm-stats) |
| Resource available count. | |||
| acl-table-stats | RO | (sub-property of output) | |
| Path-only node, has no configurable value. | |||
| This list exists when resource is not specified or one of acl table, acl entry and acl counter | |||
| table-id | RO | string | (sub-property of acl-table-stats) |
| resource | RO | ”ipv4-route" | |
| "ipv4-neighbor" | |||
| "ipv4-nexthop" | |||
| "ipv6-route" | |||
| "ipv6-neighbor" | |||
| "ipv6-nexthop" | |||
| "mpls-inseg" | |||
| "mpls-nexthop" | |||
| "nexthop-group-object" | |||
| "nexthop-group-member" | |||
| "acl-table" | |||
| "acl-group" | |||
| "acl-group-entry" | |||
| "acl-group-counter" | |||
| "fdb" | |||
| "ipmc" | |||
| "snat" | |||
| "dnat" | |||
| "srv6-nexthop" | |||
| "srv6-my-sid-entry” | (sub-property of acl-table-stats) | ||
| Resource select. | |||
| used | RO | uint64 | (sub-property of acl-table-stats) |
| Resource used count. | |||
| available | RO | uint64 | (sub-property of acl-table-stats) |
| Resource available count. | |||
| acl-stats | RO | (sub-property of output) | |
| Path-only node, has no configurable value. | |||
| This list exists when resource is not specified or acl group | |||
| stage | RO | ”INGRESS" | |
| "EGRESS” | (sub-property of acl-stats) |
|| bind-point | RO | “PORT” “LAG” “VLAN” “RIF” “SWITCH” | (sub-property of acl-stats) | | resource | RO | “ipv4-route” “ipv4-neighbor” “ipv4-nexthop” “ipv6-route” “ipv6-neighbor” “ipv6-nexthop” “mpls-inseg” “mpls-nexthop” “nexthop-group-object” “nexthop-group-member” “acl-table” “acl-group” “acl-group-entry” “acl-group-counter” “fdb” “ipmc” “snat” “dnat” “srv6-nexthop” “srv6-my-sid-entry” | (sub-property of acl-stats) Resource select. | | used | RO | uint64 | (sub-property of acl-stats) Resource used count. | | available | RO | uint64 | (sub-property of acl-stats) Resource available count. |