{
    "id":"/axapi/v3/visibility/monitor",
    "type":"object",
    "node-type":"scalar",
    "title":"monitor",
    "partition-visibility":"shared",
    "description":"Configure monitoring keys",
    "properties":{
        "primary-monitor":{
            "type":"string",
            "format":"enum",
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"'traffic': Mointor traffic; 'xflow': Monitor xflow samples; ",
            "enum":[
                "traffic",
                "xflow"
            ],
            "optional":false
        },
        "monitor-key":{
            "type":"string",
            "format":"enum",
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "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; ",
            "enum":[
                "source",
                "dest",
                "service",
                "source-nat-ip"
            ],
            "optional":true
        },
        "mon-entity-topk":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Enable topk for primary entities",
            "optional":true
        },
        "source-entity-topk":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Enable topk for sources to primary-entities",
            "optional":true
        },
        "index-sessions":{
            "type":"number",
            "format":"flag",
            "plat-neg-list":["tps"],
            "default":0,
            "partition-visibility":"shared",
            "description":"Start indexing associated sessions",
            "optional":true
        },
        "index-sessions-type":{
            "type":"string",
            "format":"enum",
            "plat-neg-list":["tps"],
            "partition-visibility":"shared",
            "description":"'per-cpu': Use per cpu list; ",
            "enum":[
                "per-cpu"
            ],
            "optional":true
        },
        "template":{
            "type":"object",
            "properties":{
                "notification":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "notif-template-name":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "$ref":"/axapi/v3/visibility/reporting/template/notification/template-name"
                                }
                            }
                        }
                    ]
                }
            }
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "agent-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"agent"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/visibility/monitor/agent/{agent-name}",
            "array":[
                {
                    "properties":{
                        "agent-name":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Specify name for the agent",
                            "optional":false
                        },
                        "agent-v4-addr":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"Configure agent's IPv4 address",
                            "optional":true
                        },
                        "agent-v6-addr":{
                            "type":"string",
                            "format":"ipv6-address",
                            "partition-visibility":"shared",
                            "description":"Configure agent's IPv6 address",
                            "optional":true
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object",
                            "optional":true
                        },
                        "user-tag":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Customized tag",
                            "optional":true
                        },
                        "sampling-enable":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "counters1":{
                                            "type":"string",
                                            "format":"enum",
                                            "partition-visibility":"shared",
                                            "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; ",
                                            "enum":[
                                                "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"
                                            ]
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    "required":[
                        "agent-name"
                    ]
                }
            ]
        },
        "sflow":{
            "type":"object",
            "$ref":"/axapi/v3/visibility/monitor/sflow",
            "properties":{
                "listening-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "default":6343,
                    "partition-visibility":"shared",
                    "description":"sFlow port to receive packets (sFlow port number(default 6343))"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "netflow":{
            "type":"object",
            "$ref":"/axapi/v3/visibility/monitor/netflow",
            "properties":{
                "listening-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "default":9996,
                    "partition-visibility":"shared",
                    "description":"Netflow port to receive packets (Netflow port number(default 9996))"
                },
                "template-active-timeout":{
                    "type":"number",
                    "format":"number",
                    "minimum":2,
                    "maximum":300,
                    "default":30,
                    "partition-visibility":"shared",
                    "description":"Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins))"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "debug-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"debug"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/visibility/monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}",
            "array":[
                {
                    "properties":{
                        "debug-ip-addr":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":128,
                            "partition-visibility":"shared",
                            "description":"Specify source/dest ip addr",
                            "optional":false
                        },
                        "debug-port":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Specify port",
                            "optional":false
                        },
                        "debug-protocol":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ",
                            "enum":[
                                "TCP",
                                "UDP",
                                "ICMP"
                            ],
                            "optional":false
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object",
                            "optional":true
                        }
                    },
                    "required":[
                        "debug-ip-addr",
                        "debug-port",
                        "debug-protocol"
                    ]
                }
            ]
        },
        "replay-debug-file":{
            "type":"object",
            "$ref":"/axapi/v3/visibility/monitor/replay-debug-file",
            "properties":{
                "debug-ip-addr":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "description":"Specify source/dest ip addr"
                },
                "debug-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "partition-visibility":"shared",
                    "description":"Specify port"
                },
                "debug-protocol":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ",
                    "enum":[
                        "TCP",
                        "UDP",
                        "ICMP"
                    ]
                }
            },
            "required":[
                "debug-ip-addr"
            ]
        },
        "delete-debug-file":{
            "type":"object",
            "$ref":"/axapi/v3/visibility/monitor/delete-debug-file",
            "properties":{
                "debug-ip-addr":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "description":"Specify source/dest ip addr"
                },
                "debug-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "partition-visibility":"shared",
                    "description":"Specify port"
                },
                "debug-protocol":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ",
                    "enum":[
                        "TCP",
                        "UDP",
                        "ICMP"
                    ]
                }
            },
            "required":[
                "debug-ip-addr"
            ]
        },
        "secondary-monitor":{
            "type":"object",
            "$ref":"/axapi/v3/visibility/monitor/secondary-monitor",
            "properties":{
                "secondary-monitoring-key":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'service': Monitor traffic to any service; ",
                    "enum":[
                        "service"
                    ]
                },
                "mon-entity-topk":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Enable topk for secondary entities"
                },
                "source-entity-topk":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Enable topk for sources to secondary-entities"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "debug-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"debug"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/visibility/monitor/secondary-monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}",
                    "array":[
                        {
                            "properties":{
                                "debug-ip-addr":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":128,
                                    "partition-visibility":"shared",
                                    "description":"Specify source/dest ip addr",
                                    "optional":false
                                },
                                "debug-port":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "partition-visibility":"shared",
                                    "description":"Specify port",
                                    "optional":false
                                },
                                "debug-protocol":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ",
                                    "enum":[
                                        "TCP",
                                        "UDP",
                                        "ICMP"
                                    ],
                                    "optional":false
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                }
                            },
                            "required":[
                                "debug-ip-addr",
                                "debug-port",
                                "debug-protocol"
                            ]
                        }
                    ]
                },
                "delete-debug-file":{
                    "type":"object",
                    "$ref":"/axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file",
                    "properties":{
                        "debug-ip-addr":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":128,
                            "partition-visibility":"shared",
                            "description":"Specify source/dest ip addr"
                        },
                        "debug-port":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Specify port"
                        },
                        "debug-protocol":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ",
                            "enum":[
                                "TCP",
                                "UDP",
                                "ICMP"
                            ]
                        }
                    },
                    "required":[
                        "debug-ip-addr"
                    ]
                },
                "replay-debug-file":{
                    "type":"object",
                    "$ref":"/axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file",
                    "properties":{
                        "debug-ip-addr":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":128,
                            "partition-visibility":"shared",
                            "description":"Specify source/dest ip addr"
                        },
                        "debug-port":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Specify port"
                        },
                        "debug-protocol":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ",
                            "enum":[
                                "TCP",
                                "UDP",
                                "ICMP"
                            ]
                        }
                    },
                    "required":[
                        "debug-ip-addr"
                    ]
                }
            }
        }
    }
}