{ "id":"/axapi/v3/netflow", "type":"object", "node-type":"intermediate", "title":"netflow", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "description":"Configure NetFlow/IPFIX", "properties":{ "common":{ "type":"object", "$ref":"/axapi/v3/netflow/common", "properties":{ "max-packet-queue-time":{ "type":"number", "format":"number", "minimum":0, "maximum":50, "default":50, "partition-visibility":"shared", "description":"Configure netflow packet queue time (Max packet queue time(*20ms). Default:50( *20ms = 1s)))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "selector-algorithm-list":{ "type":"array", "minItems":1, "items":{ "type":"selector-algorithm" }, "uniqueItems":true, "$ref":"/axapi/v3/netflow/common/selector-algorithm/{algorithm-name}", "array":[ { "properties":{ "algorithm-name":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'random': random; ", "enum":[ "random" ], "optional":false }, "sampling-population":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "default":1, "partition-visibility":"shared", "description":"Configure sampling population for random algorithm", "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 } }, "required":[ "algorithm-name" ] } ] } } }, "monitor-list":{ "type":"array", "minItems":1, "items":{ "type":"monitor" }, "uniqueItems":true, "$ref":"/axapi/v3/netflow/monitor/{name}", "array":[ { "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 }, "counter-polling-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":3600, "default":60, "partition-visibility":"shared", "description":"Configure the interval to export global counters (Number of seconds: default is 60)", "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 }, "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" }, "ip-list":{ "type":"array", "minItems":1, "items":{ "type":"ip" }, "uniqueItems":true, "$ref":"/axapi/v3/netflow/monitor/{name}/disable-log-by-destination/ip/{ipv4-addr}", "array":[ { "properties":{ "ipv4-addr":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"Configure an IP subnet", "optional":false }, "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", "optional":true }, "others":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for other L4 protocols", "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 } }, "required":[ "ipv4-addr" ] } ] }, "ip6-list":{ "type":"array", "minItems":1, "items":{ "type":"ip6" }, "uniqueItems":true, "$ref":"/axapi/v3/netflow/monitor/{name}/disable-log-by-destination/ip6/{ipv6-addr}", "array":[ { "properties":{ "ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"Configure an IPv6 subnet", "optional":false }, "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", "optional":true }, "others":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for other L4 protocols", "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 } }, "required":[ "ipv6-addr" ] } ] } } }, "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" }, "ddos-general-stat":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"General DDOS statistics" }, "ddos-http-stat":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"HTTP DDOS statistics" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "custom-record":{ "type":"object", "$ref":"/axapi/v3/netflow/monitor/{name}/custom-record", "properties":{ "custom-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "event":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'sesn-event-nat44-creation': Export NAT44 session creation events; 'sesn-event-nat44-deletion': Export NAT44 session deletion events; 'sesn-event-nat64-creation': Export NAT64 session creation events; 'sesn-event-nat64-deletion': Export NAT64 session deletion events; 'sesn-event-dslite-creation': Export Dslite session creation events; 'sesn-event-dslite-deletion': Export Dslite session deletion events; 'sesn-event-fw4-creation': Export FW4 session creation events; 'sesn-event-fw4-deletion': Export FW4 session deletion events; 'sesn-event-fw6-creation': Export FW6 session creation events; 'sesn-event-fw6-deletion': Export FW6 session deletion events; 'deny-reset-event-fw4': Export FW4 Deny Reset events; 'deny-reset-event-fw6': Export FW6 Deny Reset events; 'port-mapping-nat44-creation': Export NAT44 Port Mapping Creation Event; 'port-mapping-nat44-deletion': Export NAT44 Port Mapping Deletion Event; 'port-mapping-nat64-creation': Export NAT64 Port Mapping Creation Event; 'port-mapping-nat64-deletion': Export NAT64 Port Mapping Deletion Event; 'port-mapping-dslite-creation': Export Dslite Port Mapping Creation Event; 'port-mapping-dslite-deletion': Export Dslite Port Mapping Deletion Event; 'port-batch-nat44-creation': Export NAT44 Port Batch Creation Event; 'port-batch-nat44-deletion': Export NAT44 Port Batch Deletion Event; 'port-batch-nat64-creation': Export NAT64 Port Batch Creation Event; 'port-batch-nat64-deletion': Export NAT64 Port Batch Deletion Event; 'port-batch-dslite-creation': Export Dslite Port Batch Creation Event; 'port-batch-dslite-deletion': Export Dslite Port Batch Deletion Event; 'port-batch-v2-nat44-creation': Export NAT44 Port Batch v2 Creation Event; 'port-batch-v2-nat44-deletion': Export NAT44 Port Batch v2 Deletion Event; 'port-batch-v2-nat64-creation': Export NAT64 Port Batch v2 Creation Event; 'port-batch-v2-nat64-deletion': Export NAT64 Port Batch v2 Deletion Event; 'port-batch-v2-dslite-creation': Export Dslite Port Batch v2 Creation Event; 'port-batch-v2-dslite-deletion': Export Dslite Port Batch v2 Deletion Event; 'gtp-c-tunnel-event': Export GTP Control Tunnel Creation or Deletion Events; 'gtp-u-tunnel-event': Export GTP User Tunnel Creation or Deletion Events; 'gtp-deny-event': Export GTP Deny events on GTP C/U Tunnels; 'gtp-info-event': Export GTP Info events on GTP C/U Tunnels; ", "enum":[ "sesn-event-nat44-creation", "sesn-event-nat44-deletion", "sesn-event-nat64-creation", "sesn-event-nat64-deletion", "sesn-event-dslite-creation", "sesn-event-dslite-deletion", "sesn-event-fw4-creation", "sesn-event-fw4-deletion", "sesn-event-fw6-creation", "sesn-event-fw6-deletion", "deny-reset-event-fw4", "deny-reset-event-fw6", "port-mapping-nat44-creation", "port-mapping-nat44-deletion", "port-mapping-nat64-creation", "port-mapping-nat64-deletion", "port-mapping-dslite-creation", "port-mapping-dslite-deletion", "port-batch-nat44-creation", "port-batch-nat44-deletion", "port-batch-nat64-creation", "port-batch-nat64-deletion", "port-batch-dslite-creation", "port-batch-dslite-deletion", "port-batch-v2-nat44-creation", "port-batch-v2-nat44-deletion", "port-batch-v2-nat64-creation", "port-batch-v2-nat64-deletion", "port-batch-v2-dslite-creation", "port-batch-v2-dslite-deletion", "gtp-c-tunnel-event", "gtp-u-tunnel-event", "gtp-deny-event", "gtp-info-event" ] }, "optional":true } } ] }, "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":{ "ip-cfg":{ "type":"object", "properties":{ "ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"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":"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 disable template resend based on timeout)" }, "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 disable template resend based on record-count)" }, "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":4, "maximum":103, "partition-visibility":"shared", "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" ] } ] } } } }, "required":[ "name" ] } ] }, "collector":{ "type":"object", "$ref":"/axapi/v3/netflow/collector", "properties":{ "template":{ "type":"object", "$ref":"/axapi/v3/netflow/collector/template", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "template-detail":{ "type":"object", "$ref":"/axapi/v3/netflow/collector/template-detail", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } } } }