visibility monitor agent¶
Configure xflow agent
agent Specification¶
Type Collection Object Key(s) agent-name Collection Name agent-list Collection URI /axapi/v3/visibility/monitor/agent Element Name agent Element URI /axapi/v3/visibility/monitor/agent/{agent-name} Element Attributes agent_attributes Statistics Data URI /axapi/v3/visibility/monitor/agent/{agent-name}/stats Schema agent schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/monitor/agent | ||
Create List | POST | /axapi/v3/visibility/monitor/agent | ||
Get Object | GET | /axapi/v3/visibility/monitor/agent/{agent-name} | ||
Get List | GET | /axapi/v3/visibility/monitor/agent | ||
Modify Object | POST | /axapi/v3/visibility/monitor/agent/{agent-name} | ||
Replace Object | PUT | /axapi/v3/visibility/monitor/agent/{agent-name} | ||
Replace List | PUT | /axapi/v3/visibility/monitor/agent | ||
Delete Object | DELETE | /axapi/v3/visibility/monitor/agent/{agent-name} |
agent-list¶
agent-list is JSON List of agent attributes
agent-list : [
]
agent attributes¶
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: Listuser-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
sampling-enable¶
Specification 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
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| netflow-v10-packets-received | 8 | Netflow v10 Packets Received | |
| netflow-v9-sample-records-bad-len | 8 | Netflow v9 Sample Records Bad Length | |
| sflow-disabled | 8 | sFlow Packet Samples Processing Disabled | |
| netflow-v5-max-records-exceed | 8 | Netflow v5 Sample Max Records Error | |
| netflow-v5-sample-records-bad-len | 8 | Netflow v5 Sample Records Bad Length | |
| netflow-tcp-sample-received | 8 | Netflow TCP Samples Received | |
| netflow-v10-samples-received | 8 | Netflow v10 Samples Received | |
| netflow-record-rse-invalid | 8 | Netflow Data Record Reduced Size Invalid | |
| sflow-samples-skipped | 8 | sFlow Samples Skipped | |
| netflow-v10-max-records-exceed | 8 | Netflow v10 Sample Max records Error | |
| netflow-v9-samples-received | 8 | Netflow v9 Samples Received | |
| sflow-samples-received | 8 | sFlow Samples Received | |
| sflow-sample-record-invalid-layer2 | 8 | sFlow Sample Records Unknown Layer-2 | |
| netflow-v10-sample-records-bad-len | 8 | Netflow v10 Sample Records Bad Length | |
| netflow-icmp-sample-received | 8 | Netflow ICMP Samples Received | |
| netflow-udp-sample-received | 8 | Netflow UDP Samples received | |
| netflow-v9-packets-received | 8 | Netflow v9 Packets Received | |
| netflow-v10-samples-sent-for-detection | 8 | Netflow v10 Samples Procssed For Detection | |
| sflow-packets-received | 8 | sFlow Packets Received | |
| sflow-samples-sent-for-detection | 8 | sFlow Samples Processed For Detection | |
| netflow-v9-max-records-exceed | 8 | Netflow v9 Sample Max Records Error | |
| netflow-v5-samples-received | 8 | Netflow v5 Samples Received | |
| netflow-sample-flow-dur-error | 8 | Netflow Sample Flow Duration Error | |
| sflow-samples-non-std | 8 | sFlow Samples Non-standard | |
| netflow-other-sample-received | 8 | Netflow OTHER Samples Received | |
| netflow-v5-packets-received | 8 | Netflow v5 Packets Received | |
| sflow-sample-record-bad-len | 8 | sFlow Sample Records Bad Length | |
| sflow-sample-ipv6-hdr-parse-fail | 8 | sFlow Sample IPv6 Record Header Parse Failures | |
| netflow-disabled | 8 | Netflow Flow Samples Processing Disabled | |
| netflow-v5-samples-sent-for-detection | 8 | Netflow v5 Samples Processed For Detection | |
| sflow-samples-bad-len | 8 | sFlow Samples Bad Length | |
| netflow-record-copy-oom-error | 8 | Netflow Data Record Copy Fail OOM | |
| netflow-v9-samples-sent-for-detection | 8 | Netflow v9 Samples Processed For Detection |