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 schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/visibility/monitor	monitor attributes
POST /axapi/v3/visibility/monitor Payload: { "monitor": { "primary-monitor": "traffic", "monitor-key": "source", "mon-entity-topk": 1 } }
Get Object	GET	/axapi/v3/visibility/monitor	monitor attributes
GET /axapi/v3/visibility/monitor Reponse: { "monitor": { "primary-monitor": "traffic", "monitor-key": "source", "mon-entity-topk": 1, "source-entity-topk": 0, "uuid": "9c8b73ac-514e-11ee-99f1-db2b8dabed7a", "a10-url": "/axapi/v3/visibility/monitor" } }
Modify Object	POST	/axapi/v3/visibility/monitor	monitor attributes
Replace Object	PUT	/axapi/v3/visibility/monitor	monitor attributes
PUT /axapi/v3/visibility/monitor Payload: { "monitor": { "primary-monitor": "traffic", "monitor-key": "source", "mon-entity-topk": 0 } }
Delete Object	DELETE	/axapi/v3/visibility/monitor	monitor attributes
DELETE /axapi/v3/visibility/monitor Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

monitor attributes¶

agent-list

Type: List

Reference Object: /axapi/v3/visibility/monitor/agent/{agent-name}

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

index-sessions

Description Start indexing associated sessions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

index-sessions-type

Description ‘per-cpu’: Use per cpu list;

Type: string

Supported Values: per-cpu

mon-entity-topk

Description Enable topk for primary entities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

monitor-key

Description ‘source’: Monitor traffic from all sources; ‘dest’: Monitor traffic to any destination; ‘service’: Monitor traffic to any service; ‘source-nat-ip’: Monitor traffic to all source nat IPs;

Type: string

Supported Values: source, dest, service, source-nat-ip

netflow

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

Type: Object

Reference Object: /axapi/v3/visibility/monitor/netflow

primary-monitor

Description ‘traffic’: Mointor traffic; ‘xflow’: Monitor xflow samples;

Type: string

Supported Values: traffic, 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

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

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

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

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

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

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

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

agent-list¶

Specification Value

Type list

Block object keys

agent-name

Description Specify name for the agent

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

agent-v4-addr

Description Configure agent’s IPv4 address

Type: string

Format: ipv4-address

agent-v6-addr

Description Configure agent’s IPv6 address

Type: string

Format: ipv6-address

sampling-enable

Type: List

user-tag

Description Customized tag

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

agent-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘sflow-packets-received’: sFlow Packets Received; ‘sflow-samples-received’: sFlow Samples Received; ‘sflow-samples-bad-len’: sFlow Samples Bad Length; ‘sflow-samples-non-std’: sFlow Samples Non-standard; ‘sflow-samples-skipped’: sFlow Samples Skipped; ‘sflow-sample-record-bad-len’: sFlow Sample Records Bad Length; ‘sflow-samples-sent-for-detection’: sFlow Samples Processed For Detection; ‘sflow-sample-record-invalid-layer2’: sFlow Sample Records Unknown Layer-2; ‘sflow-sample-ipv6-hdr-parse-fail’: sFlow Sample IPv6 Record Header Parse Failures; ‘sflow-disabled’: sFlow Packet Samples Processing Disabled; ‘netflow-disabled’: Netflow Flow Samples Processing Disabled; ‘netflow-v5-packets-received’: Netflow v5 Packets Received; ‘netflow-v5-samples-received’: Netflow v5 Samples Received; ‘netflow-v5-samples-sent-for-detection’: Netflow v5 Samples Processed For Detection; ‘netflow-v5-sample-records-bad-len’: Netflow v5 Sample Records Bad Length; ‘netflow-v5-max-records-exceed’: Netflow v5 Sample Max Records Error; ‘netflow-v9-packets-received’: Netflow v9 Packets Received; ‘netflow-v9-samples-received’: Netflow v9 Samples Received; ‘netflow-v9-samples-sent-for-detection’: Netflow v9 Samples Processed For Detection; ‘netflow-v9-sample-records-bad-len’: Netflow v9 Sample Records Bad Length; ‘netflow-v9-max-records-exceed’: Netflow v9 Sample Max Records Error; ‘netflow-v10-packets-received’: Netflow v10 Packets Received; ‘netflow-v10-samples-received’: Netflow v10 Samples Received; ‘netflow-v10-samples-sent-for-detection’: Netflow v10 Samples Procssed For Detection; ‘netflow-v10-sample-records-bad-len’: Netflow v10 Sample Records Bad Length; ‘netflow-v10-max-records-exceed’: Netflow v10 Sample Max records Error; ‘netflow-tcp-sample-received’: Netflow TCP Samples Received; ‘netflow-udp-sample-received’: Netflow UDP Samples received; ‘netflow-icmp-sample-received’: Netflow ICMP Samples Received; ‘netflow-other-sample-received’: Netflow OTHER Samples Received; ‘netflow-record-copy-oom-error’: Netflow Data Record Copy Fail OOM; ‘netflow-record-rse-invalid’: Netflow Data Record Reduced Size Invalid; ‘netflow-sample-flow-dur-error’: Netflow Sample Flow Duration Error;

Type: string

Supported Values: all, sflow-packets-received, sflow-samples-received, sflow-samples-bad-len, sflow-samples-non-std, sflow-samples-skipped, sflow-sample-record-bad-len, sflow-samples-sent-for-detection, sflow-sample-record-invalid-layer2, sflow-sample-ipv6-hdr-parse-fail, sflow-disabled, netflow-disabled, netflow-v5-packets-received, netflow-v5-samples-received, netflow-v5-samples-sent-for-detection, netflow-v5-sample-records-bad-len, netflow-v5-max-records-exceed, netflow-v9-packets-received, netflow-v9-samples-received, netflow-v9-samples-sent-for-detection, netflow-v9-sample-records-bad-len, netflow-v9-max-records-exceed, netflow-v10-packets-received, netflow-v10-samples-received, netflow-v10-samples-sent-for-detection, netflow-v10-sample-records-bad-len, netflow-v10-max-records-exceed, netflow-tcp-sample-received, netflow-udp-sample-received, netflow-icmp-sample-received, netflow-other-sample-received, netflow-record-copy-oom-error, netflow-record-rse-invalid, netflow-sample-flow-dur-error