controller telemetry¶
Controller telemetry config
telemetry Specification¶
Parameter
Value
Type
Configuration Resource
Element Name
telemetry
Element URI
/axapi/v3/controller/telemetry
Element Attributes
telemetry_attributes
Partition Visibility
shared,private
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/controller/telemetry | ||
Get Object | GET | /axapi/v3/controller/telemetry | ||
Modify Object | POST | /axapi/v3/controller/telemetry | ||
Replace Object | PUT | /axapi/v3/controller/telemetry | ||
Delete Object | DELETE | /axapi/v3/controller/telemetry |
telemetry attributes¶
export
Description: export is a JSON Block. Please see below for export
Type: Object
Reference Object: /axapi/v3/controller/telemetry/export
log-rate
Description Max number of session logs sent by the partition per second
Type: number
Range: 0-10000
Default: 10
probe
Description: probe is a JSON Block. Please see below for probe
Type: Object
Reference Object: /axapi/v3/controller/telemetry/probe
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
probe¶
Specification
Value
Type
object
action
Description ‘enable’: Enable the probe functionality; ‘disable’: Disable the probe functionality;
Type: string
Supported Values: enable, disable
Default: disable
export-policy
Description ‘snapshots-all’: Export historical/missed snapshots.; ‘snapshots-new’: Export only new snapshots(default).;
Type: string
Supported Values: snapshots-all, snapshots-new
Default: snapshots-new
interval
Description snapshot export interval in minute,default is 15.
Type: number
Range: 15-60
Default: 15
log-level
Description ‘ERROR’: show errors only(default).; ‘WARNING’: show warnings; ‘INFO’: show info messages; ‘DEBUG’: show debug logs;
Type: string
Supported Values: ERROR, WARNING, INFO, DEBUG
Default: ERROR
target
Description ‘remote’: Export data to remote. This is the default value.; ‘local’: Export data local.;
Type: string
Supported Values: remote, local
Default: remote
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
export¶
Specification
Value
Type
object
match
Description: match is a JSON Block. Please see below for export_match
Type: Object
template-id
Description Template ID
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uri-list
Type: List
Reference Object: /axapi/v3/controller/telemetry/export/uri/{uri}
version
Description Version
Type: number
Range: 0-65535
export_match¶
Specification
Value
Type
object
device-type
Description Device Type
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
export_uri-list¶
Specification
Value
Type
list
Block object keys
counter-list
Type: List
uri
Description configure uri
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
export_uri-list_counter-list¶
Specification
Value
Type
list
Block object keys
name
Description configure counter name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters