visibility reporting¶

Configure reporting framework

reporting Specification¶

Parameter Value

Type Configuration Resource

Element Name reporting

Element URI /axapi/v3/visibility/reporting

Element Attributes reporting_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/visibility/reporting/stats

Schema reporting schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/visibility/reporting	reporting attributes
POST /axapi/v3/visibility/reporting Payload: { "reporting": { "sampling-enable": [ { "counters1": "all" } ] } }
Get Object	GET	/axapi/v3/visibility/reporting	reporting attributes
GET /axapi/v3/visibility/reporting Reponse: { "reporting": { "uuid": "db1e4310-6612-11d9-9a27-692335d4f00d", "sampling-enable": [ { "counters1": "all" } ], "a10-url": "/axapi/v3/visibility/reporting" } }
Modify Object	POST	/axapi/v3/visibility/reporting	reporting attributes
Replace Object	PUT	/axapi/v3/visibility/reporting	reporting attributes
PUT /axapi/v3/visibility/reporting Payload: { "reporting": { "sampling-enable": [ { "counters1": "log-transmit-failure" } ] } }
Delete Object	DELETE	/axapi/v3/visibility/reporting	reporting attributes
DELETE /axapi/v3/visibility/reporting Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

reporting attributes¶

sampling-enable

Type: List

session-logging

Description ‘enable’: Enable session logging; ‘disable’: Disable session logging(default);

Type: string

Supported Values: enable, disable

Default: disable

telemetry-export-interval

Description: telemetry-export-interval is a JSON Block. Please see below for telemetry-export-interval

Type: Object

Reference Object: /axapi/v3/visibility/reporting/telemetry-export-interval

template

Description: template is a JSON Block. Please see below for template

Type: Object

Reference Object: /axapi/v3/visibility/reporting/template

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘log-transmit-failure’: Total log transmit failures; ‘buffer-alloc-failure’: Total reporting buffer allocation failures; ‘notif-jobs-in-queue’: Total notification jobs in queue; ‘enqueue-fail’: Total enqueue jobs failed; ‘enqueue-pass’: Total enqueue jobs passed; ‘dequeued’: Total jobs dequeued;

Type: string

Supported Values: all, log-transmit-failure, buffer-alloc-failure, notif-jobs-in-queue, enqueue-fail, enqueue-pass, dequeued

template¶

Specification Value

Type object

notification

Description: notification is a JSON Block. Please see below for template_notification

Type: Object

Reference Object: /axapi/v3/visibility/reporting/template/notification

template_notification¶

Specification Value

Type object

debug

Description: debug is a JSON Block. Please see below for template_notification_debug

Type: Object

Reference Object: /axapi/v3/visibility/reporting/template/notification/debug

template-name-list

Type: List

Reference Object: /axapi/v3/visibility/reporting/template/notification/template-name/{name}

template_notification_debug¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template_notification_template-name-list¶

Specification Value

Type list

Block object keys

action

Description ‘enable’: Enable; ‘disable’: Disable;

Type: string

Supported Values: enable, disable

Default: enable

authentication

Description: authentication is a JSON Block. Please see below for template_notification_template-name-list_authentication

Type: Object

Reference Object: /axapi/v3/visibility/reporting/template/notification/template-name/{name}/authentication

debug-mode

Description Enable debug mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

host-name

Description Configure the host name(e.g www.a10networks.com)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: host-name, ipv4-address, and ipv6-address are mutually exclusive

http-port

Description Configure the http port to use(default 80) (http port(default 80))

Type: number

Range: 1-65535

Default: 80

https-port

Description Configure the https port to use(default 443) (http port(default 443))

Type: number

Range: 1-65535

Default: 443

ipv4-address

Description Configure the host IPv4 address

Type: string

Format: ipv4-address

Mutual Exclusion: ipv4-address, ipv6-address, and host-name are mutually exclusive

ipv6-address

Description Configure the host IPv6 address

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6-address, ipv4-address, and host-name are mutually exclusive

name

Description Notification template name

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

protocol

Description ‘http’: Use http protocol; ‘https’: Use https protocol(default); (http protocol)

Type: string

Supported Values: http, https

Default: https

relative-uri

Description Configure the relative uri(e.g /example , default /)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Default: /

sampling-enable

Type: List

test-connectivity

Description Test connectivity to notification receiver

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port for notifications

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template_notification_template-name-list_authentication¶

Specification Value

Type object

api-key

Description Configure api-key as a mode of authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

api-key-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

api-key-string

Description Configure api-key as a mode of authentication

Type: string

Format: password

Maximum Length: 64 characters

Maximum Length: 1 characters

auth-password

Description Configure the authentication user password (Authentication password)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auth-password-string

Description Configure the authentication user password (Authentication password)

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

auth-username

Description Configure the authentication user name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

relative-login-uri

Description Configure the authentication login uri

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

relative-logoff-uri

Description Configure the authentication logoff uri

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template_notification_template-name-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘sent_successful’: Sent successful; ‘send_fail’: Send failures; ‘response_fail’: Response failures;

Type: string

Supported Values: all, sent_successful, send_fail, response_fail

telemetry-export-interval¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Monitored entity telemetry data export interval in mins (Default 5 mins)

Type: number

Range: 1-5

Default: 5