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

Schema

telemetry schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/controller/telemetry

telemetry attributes

Get Object

GET

/axapi/v3/controller/telemetry

telemetry attributes

Modify Object

POST

/axapi/v3/controller/telemetry

telemetry attributes

Replace Object

PUT

/axapi/v3/controller/telemetry

telemetry attributes

Delete Object

DELETE

/axapi/v3/controller/telemetry

telemetry attributes

telemetry attributes

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