visibility monitor¶
Configure monitoring keys
monitor Specification¶
Parameter Value Type Configuration Resource Element Name monitor Element URI /axapi/v3/visibility/monitor Element Attributes monitor_attributes Partition Visibility shared Schema monitor schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/monitor | ||
Get Object | GET | /axapi/v3/visibility/monitor | ||
Modify Object | POST | /axapi/v3/visibility/monitor | ||
Replace Object | PUT | /axapi/v3/visibility/monitor | ||
Delete Object | DELETE | /axapi/v3/visibility/monitor |
monitor attributes¶
debug-list
Type: List
Reference Object: /axapi/v3/visibility/monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}
delete-debug-file
Description: delete-debug-file is a JSON Block. Please see below for delete-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr}
mon-entity-topk
Description Enable topk for primary entities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-key
Description ‘dest’: Monitor traffic to any destination; ‘service’: Monitor traffic to any service;
Type: string
Supported Values: dest, service
netflow
Description: netflow is a JSON Block. Please see below for netflow
Type: Object
Reference Object: /axapi/v3/visibility/monitor/netflow
port-scan-filter-settings
Description: port-scan-filter-settings is a JSON Block. Please see below for port-scan-filter-settings
Type: Object
Reference Object: /axapi/v3/visibility/monitor/port-scan-filter-settings
primary-monitor
Description ‘xflow’: Monitor xflow samples;
Type: string
Supported Values: xflow
replay-debug-file
Description: replay-debug-file is a JSON Block. Please see below for replay-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/replay-debug-file/{debug-ip-addr}
secondary-monitor
Description: secondary-monitor is a JSON Block. Please see below for secondary-monitor
Type: Object
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor
sflow
Description: sflow is a JSON Block. Please see below for sflow
Type: Object
Reference Object: /axapi/v3/visibility/monitor/sflow
source-entity-topk
Description Enable topk for sources to primary-entities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template
Description: template is a JSON Block. Please see below for template
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
v4-class-list
Description Class list of ipv4 addresses to be monitored
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
v4-grouping
Description Enable aggregate the log and notification per class-list
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
v6-class-list
Description Class list of ipv6 addresses to be monitored
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
v6-grouping
Description Enable aggregate the log and notification per class-list
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
debug-list¶
Specification Value Type list Block object keys debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sflow¶
Specification Value Type object listening-port
Description sFlow port to receive packets (sFlow port number(default 6343))
Type: number
Range: 1-65535
Default: 6343
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
delete-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
replay-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
port-scan-filter-settings¶
Specification Value Type object pkt-rate-threshold
Description packet rate threshold for the filter (default 10 pkts/sec, set to 0 pkts/sec to disable the feature)
Type: number
Range: 0-255
Default: 10
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template¶
Specification Value Type object notification
Type: List
template_notification¶
Specification Value Type list Block object keys notif-template-name
Description
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/reporting/template/notification/template-name
netflow¶
Specification Value Type object listening-port
Description Netflow port to receive packets (Netflow port number(default 9996))
Type: number
Range: 1-65535
Default: 9996
template-active-timeout
Description Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins))
Type: number
Range: 2-300
Default: 30
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
secondary-monitor¶
Specification Value Type object debug-list
Type: List
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}
delete-debug-file
Description: delete-debug-file is a JSON Block. Please see below for secondary-monitor_delete-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file/{debug-ip-addr}
mon-entity-topk
Description Enable topk for secondary entities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
replay-debug-file
Description: replay-debug-file is a JSON Block. Please see below for secondary-monitor_replay-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file/{debug-ip-addr}
secondary-monitoring-key
Description ‘service’: Monitor traffic to any service;
Type: string
Supported Values: service
source-entity-topk
Description Enable topk for sources to secondary-entities
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
secondary-monitor_debug-list¶
Specification Value Type list Block object keys debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
secondary-monitor_delete-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
secondary-monitor_replay-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP