{
    "id":"/axapi/v3/netflow/monitor/{name}",
    "type":"object",
    "node-type":"list",
    "title":"monitor",
    "partition-visibility":"shared",
    "description":"Configure NetFlow Monitor",
    "properties":{
        "name":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":63,
            "partition-visibility":"shared",
            "description":"Name of netflow monitor",
            "optional":false
        },
        "disable":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Disable this netflow monitor",
            "optional":true
        },
        "source-ip-use-mgmt":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Use management interface's IP address for source ip of netflow packets",
            "optional":true
        },
        "flow-timeout":{
            "type":"number",
            "format":"number",
            "minimum":0,
            "maximum":1440,
            "default":10,
            "partition-visibility":"shared",
            "description":"Configure timeout value to export flow records periodically for long-live session ( Number of minutes: default is 10, 0 means only send flow record when session is deleted)",
            "optional":true
        },
        "protocol":{
            "type":"string",
            "format":"enum",
            "default":"v9",
            "partition-visibility":"shared",
            "description":"'v9': Netflow version 9; 'v10': Netflow version 10 (IPFIX); ",
            "enum":[
                "v9",
                "v10"
            ],
            "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; 'packets-sent': packets-sent; 'bytes-sent': bytes-sent; 'nat44-records-sent': nat44-records-sent; 'nat44-records-sent-failure': nat44-records-sent-failure; 'nat64-records-sent': nat64-records-sent; 'nat64-records-sent-failure': nat64-records-sent-failure; 'dslite-records-sent': dslite-records-sent; 'dslite-records-sent-failure': dslite-records-sent-failure; 'session-event-nat44-records-sent': session-event-nat44-records-sent; 'session-event-nat44-records-sent-failure': session-event-nat44-records-sent-failure; 'session-event-nat64-records-sent': session-event-nat64-records-sent; 'session-event-nat64-records-sent-failure': session-event-nat64-records-sent-failure; 'session-event-dslite-records-sent': session-event-dslite-records-sent; 'session-event-dslite-records-sent-failure': session-event-dslite-records-sent-failure; 'session-event-fw4-records-sent': session-event-fw4-records-sent; 'session-event-fw4-records-sent-failure': session-event-fw4-records-sent-failure; 'session-event-fw6-records-sent': session-event-fw6-records-sent; 'session-event-fw6-records-sent-failure': session-event-fw6-records-sent-failure; 'port-mapping-nat44-records-sent': port-mapping-nat44-records-sent; 'port-mapping-nat44-records-sent-failure': port-mapping-nat44-records-sent-failure; 'port-mapping-nat64-records-sent': port-mapping-nat64-records-sent; 'port-mapping-nat64-records-sent-failure': port-mapping-nat64-records-sent-failure; 'port-mapping-dslite-records-sent': port-mapping-dslite-records-sent; 'port-mapping-dslite-records-sent-failure': port-mapping-dslite-records-sent-failure; 'netflow-v5-records-sent': netflow-v5-records-sent; 'netflow-v5-records-sent-failure': netflow-v5-records-sent-failure; 'netflow-v5-ext-records-sent': netflow-v5-ext-records-sent; 'netflow-v5-ext-records-sent-failure': netflow-v5-ext-records-sent-failure; 'port-batching-nat44-records-sent': port-batching-nat44-records-sent; 'port-batching-nat44-records-sent-failure': port-batching-nat44-records-sent-failure; 'port-batching-nat64-records-sent': port-batching-nat64-records-sent; 'port-batching-nat64-records-sent-failure': port-batching-nat64-records-sent-failure; 'port-batching-dslite-records-sent': port-batching-dslite-records-sent; 'port-batching-dslite-records-sent-failure': port-batching-dslite-records-sent-failure; 'port-batching-v2-nat44-records-sent': port-batching-v2-nat44-records-sent; 'port-batching-v2-nat44-records-sent-failure': port-batching-v2-nat44-records-sent-failure; 'port-batching-v2-nat64-records-sent': port-batching-v2-nat64-records-sent; 'port-batching-v2-nat64-records-sent-failure': port-batching-v2-nat64-records-sent-failure; 'port-batching-v2-dslite-records-sent': port-batching-v2-dslite-records-sent; 'port-batching-v2-dslite-records-sent-failure': port-batching-v2-dslite-records-sent-failure; 'reduced-logs-by-destination': Reduced Logs by Destination Protocol and Port; ",
                            "enum":[
                                "all",
                                "packets-sent",
                                "bytes-sent",
                                "nat44-records-sent",
                                "nat44-records-sent-failure",
                                "nat64-records-sent",
                                "nat64-records-sent-failure",
                                "dslite-records-sent",
                                "dslite-records-sent-failure",
                                "session-event-nat44-records-sent",
                                "session-event-nat44-records-sent-failure",
                                "session-event-nat64-records-sent",
                                "session-event-nat64-records-sent-failure",
                                "session-event-dslite-records-sent",
                                "session-event-dslite-records-sent-failure",
                                "session-event-fw4-records-sent",
                                "session-event-fw4-records-sent-failure",
                                "session-event-fw6-records-sent",
                                "session-event-fw6-records-sent-failure",
                                "port-mapping-nat44-records-sent",
                                "port-mapping-nat44-records-sent-failure",
                                "port-mapping-nat64-records-sent",
                                "port-mapping-nat64-records-sent-failure",
                                "port-mapping-dslite-records-sent",
                                "port-mapping-dslite-records-sent-failure",
                                "netflow-v5-records-sent",
                                "netflow-v5-records-sent-failure",
                                "netflow-v5-ext-records-sent",
                                "netflow-v5-ext-records-sent-failure",
                                "port-batching-nat44-records-sent",
                                "port-batching-nat44-records-sent-failure",
                                "port-batching-nat64-records-sent",
                                "port-batching-nat64-records-sent-failure",
                                "port-batching-dslite-records-sent",
                                "port-batching-dslite-records-sent-failure",
                                "port-batching-v2-nat44-records-sent",
                                "port-batching-v2-nat44-records-sent-failure",
                                "port-batching-v2-nat64-records-sent",
                                "port-batching-v2-nat64-records-sent-failure",
                                "port-batching-v2-dslite-records-sent",
                                "port-batching-v2-dslite-records-sent-failure",
                                "reduced-logs-by-destination"
                            ]
                        },
                        "optional":true
                    }
                }
            ]
        },
        "disable-log-by-destination":{
            "type":"object",
            "$ref":"/axapi/v3/netflow/monitor/{name}/disable-log-by-destination",
            "properties":{
                "tcp-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "tcp-port-start":{
                                    "type":"number",
                                    "format":"number",
                                    "partition-visibility":"shared",
                                    "description":"Destination Port (Single Destination Port or Port Range Start)"
                                },
                                "tcp-port-end":{
                                    "type":"number",
                                    "format":"number",
                                    "partition-visibility":"shared",
                                    "description":"Port Range End"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "udp-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "udp-port-start":{
                                    "type":"number",
                                    "format":"number",
                                    "partition-visibility":"shared",
                                    "description":"Destination Port (Single Destination Port or Port Range Start)"
                                },
                                "udp-port-end":{
                                    "type":"number",
                                    "format":"number",
                                    "partition-visibility":"shared",
                                    "description":"Port Range End"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "icmp":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Disable logging for icmp traffic"
                },
                "others":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Disable logging for other L4 protocols"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "record":{
            "type":"object",
            "$ref":"/axapi/v3/netflow/monitor/{name}/record",
            "properties":{
                "netflow-v5":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"NetFlow V5 Flow Record Template"
                },
                "netflow-v5-ext":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Extended NetFlow V5 Flow Record Template, supports ipv6"
                },
                "nat44":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"NAT44 Flow Record Template"
                },
                "nat64":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"NAT64 Flow Record Template"
                },
                "dslite":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"DS-Lite Flow Record Template"
                },
                "sesn-event-nat44":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "sesn-event-nat64":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "sesn-event-dslite":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "sesn-event-fw4":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "sesn-event-fw6":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-mapping-nat44":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-mapping-nat64":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-mapping-dslite":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-batch-nat44":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-batch-nat64":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-batch-dslite":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-batch-v2-nat44":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-batch-v2-nat64":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "port-batch-v2-dslite":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'both': Export both creation and deletion events; 'creation': Export only creation events; 'deletion': Export only deletion events; ",
                    "enum":[
                        "both",
                        "creation",
                        "deletion"
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "destination":{
            "type":"object",
            "$ref":"/axapi/v3/netflow/monitor/{name}/destination",
            "properties":{
                "service-group":{
                    "type":"string",
                    "format":"string-rlx",
                    "minLength":1,
                    "maxLength":63,
                    "partition-visibility":"shared",
                    "not-list":[ "ip", "ipv6" ],
                    "description":"Service-group for load balancing between multiple collector servers"
                },
                "ip-cfg":{
                    "type":"object",
                    "properties":{
                        "ip":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "not-list":[ "service-group", "ipv6" ],
                            "description":"IP address of netflow collector"
                        },
                        "port4":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":9996,
                            "partition-visibility":"shared",
                            "description":"Port number, default is 9996"
                        }
                    }
                },
                "ipv6-cfg":{
                    "type":"object",
                    "properties":{
                        "ipv6":{
                            "type":"string",
                            "format":"ipv6-address",
                            "partition-visibility":"shared",
                            "not-list":[ "service-group", "ip" ],
                            "description":"IPv6 address of netflow collector"
                        },
                        "port6":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":9996,
                            "partition-visibility":"shared",
                            "description":"Port number, default is 9996"
                        }
                    }
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "source-address":{
            "type":"object",
            "$ref":"/axapi/v3/netflow/monitor/{name}/source-address",
            "properties":{
                "ip":{
                    "type":"string",
                    "format":"ipv4-address",
                    "partition-visibility":"shared",
                    "description":"Specify source IP address"
                },
                "ipv6":{
                    "type":"string",
                    "format":"ipv6-address",
                    "partition-visibility":"shared",
                    "description":"Specify source IPv6 address"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "resend-template":{
            "type":"object",
            "$ref":"/axapi/v3/netflow/monitor/{name}/resend-template",
            "properties":{
                "timeout":{
                    "type":"number",
                    "format":"number",
                    "minimum":0,
                    "maximum":86400,
                    "default":1800,
                    "partition-visibility":"shared",
                    "description":"To set time interval to resend template (number of seconds: default is 1800, 0 means never resend template)"
                },
                "records":{
                    "type":"number",
                    "format":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "default":1000,
                    "partition-visibility":"shared",
                    "description":"To resend template once for each number of records (Number of records: default is 1000, 0 means never resend template)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "sample":{
            "type":"object",
            "$ref":"/axapi/v3/netflow/monitor/{name}/sample",
            "properties":{
                "ethernet-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"ethernet"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/netflow/monitor/{name}/sample/ethernet/{ifindex}",
                    "array":[
                        {
                            "properties":{
                                "ifindex":{
                                    "type":"number",
                                    "format":"interface",
                                    "minimum":1,
                                    "maximum":103,
                                    "partition-visibility":"shared",
                                    "$ref":"/axapi/v3/interface/ethernet",
                                    "description":"Ethernet interface number",
                                    "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":[
                                "ifindex"
                            ]
                        }
                    ]
                },
                "ve-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"ve"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/netflow/monitor/{name}/sample/ve/{ve-num}",
                    "array":[
                        {
                            "properties":{
                                "ve-num":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":2,
                                    "maximum":4094,
                                    "partition-visibility":"shared",
                                    "$ref":"/axapi/v3/interface/ve",
                                    "description":"VE interface number",
                                    "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":[
                                "ve-num"
                            ]
                        }
                    ]
                },
                "nat-pool-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"nat-pool"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/netflow/monitor/{name}/sample/nat-pool/{pool-name}",
                    "array":[
                        {
                            "properties":{
                                "pool-name":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":63,
                                    "partition-visibility":"shared",
                                    "description":"Name of nat pool",
                                    "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":[
                                "pool-name"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "object-keys":[
        "name"
    ],
    "required":[
        "name"
    ]
}