visibility reporting¶
Configure reporting framework
reporting Specification¶
Type
Configuration Resource
Element Name
reporting
Element URI
/axapi/v3/visibility/reporting
Element Attributes
reporting_attributes
Statistics Data URI
/axapi/v3/visibility/reporting/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/reporting | ||
Get Object | GET | /axapi/v3/visibility/reporting | ||
Modify Object | POST | /axapi/v3/visibility/reporting | ||
Replace Object | PUT | /axapi/v3/visibility/reporting | ||
Delete Object | DELETE | /axapi/v3/visibility/reporting |
reporting attributes¶
grouping-export-interval
Description: grouping-export-interval is a JSON Block. Please see below for grouping-export-interval
Type: Object
Refernce Object: /axapi/v3/visibility/reporting/grouping-export-interval
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
Refernce Object: /axapi/v3/visibility/reporting/telemetry-export-interval
template
Description: template is a JSON Block. Please see below for template
Type: Object
Refernce Object: /axapi/v3/visibility/reporting/template
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
grouping-export-interval¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description The aggregation and exporting interval in seconds (Default 30 seconds)
Type: number
Range: 10-300
Default: 30
template¶
Specification
Type
object
notification
Description: notification is a JSON Block. Please see below for template_notification
Type: Object
Refernce Object: /axapi/v3/visibility/reporting/template/notification
template_notification¶
Specification
Type
object
debug
Description: debug is a JSON Block. Please see below for template_notification_debug
Type: Object
Refernce Object: /axapi/v3/visibility/reporting/template/notification/debug
template-name-list
Type: List
Refernce Object: /axapi/v3/visibility/reporting/template/notification/template-name/{name}
template_notification_debug¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template_notification_template-name-list¶
Specification
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
Refernce 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: /
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
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
telemetry-export-interval¶
Specification
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
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
buffer-alloc-failure |
8 |
Total reporting buffer allocation failures |
|
dequeued |
8 |
Total jobs dequeued |
|
enqueue-pass |
8 |
Total enqueue jobs passed |
|
notif-jobs-in-queue |
8 |
Total notification jobs in queue |
|
enqueue-fail |
8 |
Total enqueue jobs failed |
|
log-transmit-failure |
8 |
Total log transmit failures |