{ "id":"/axapi/v3/sflow", "type":"object", "node-type":"intermediate", "title":"sflow", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"Configure sFlow", "properties":{ "setting":{ "type":"object", "$ref":"/axapi/v3/sflow/setting", "properties":{ "max-header":{ "type":"number", "format":"number", "minimum":14, "maximum":512, "partition-visibility":"shared", "description":"Configure maximum number of bytes that should be copied from a sampled packet (default: 128) (The maximum number of bytes (Default: 128))" }, "source-ip-use-mgmt":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use management interface's IP address for source IP of sFlow packets" }, "packet-sampling-rate":{ "type":"number", "format":"number", "minimum":10, "maximum":10000, "default":1000, "partition-visibility":"shared", "description":"sFlow packet sampling rate, default is 1000" }, "counter-polling-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "default":20, "partition-visibility":"shared", "description":"sFlow counter polling interval, default is 20" }, "management-link-utilization-percentage":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "default":30, "partition-visibility":"shared", "not":"management-link-utilization", "description":"percentage limit of the management link speed (Default is 30%)" }, "management-link-utilization":{ "type":"number", "format":"number", "minimum":1, "maximum":10000, "partition-visibility":"shared", "not":"management-link-utilization-percentage", "description":"limit management link speed in (Mbps)" }, "local-collection":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable local sflow collection; 'disable': Disable local sflow collection; ", "enum":[ "enable", "disable" ] }, "randomize-source-port":{ "type":"string", "format":"enum", "default":"packet-sampling-only", "partition-visibility":"shared", "description":"'enable': Randomize source port; 'disable': Fix source port 6343; 'packet-sampling-only': Only randomized source port for packet-sampling (Default); ", "enum":[ "enable", "disable", "packet-sampling-only" ] }, "port-range-start":{ "type":"number", "format":"number", "minimum":2049, "maximum":63640, "partition-visibility":"shared", "description":"Source port-range" }, "port-range-end":{ "type":"number", "format":"number", "minimum":2049, "maximum":63640, "partition-visibility":"shared", "description":"Source port-range end" }, "local-t1-polling-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":18000, "partition-visibility":"shared", "description":"Set sFlow local counter polling interval for T1 stats" }, "local-t2-polling-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":18000, "partition-visibility":"shared", "description":"Set sFlow local counter polling interval for T2 stats" }, "default-counter-polling-mtu":{ "type":"number", "format":"number", "minimum":1200, "maximum":1500, "default":1500, "partition-visibility":"shared", "description":"Default MTU for counter-polling packets - DDoS 3.2 format only (Default: 1500)" }, "append-mapping-info":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Allow TPS to always send mapping ctr block (260, 271, and 272)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "collector":{ "type":"object", "$ref":"/axapi/v3/sflow/collector", "properties":{ "ip-list":{ "type":"array", "minItems":1, "items":{ "type":"ip" }, "uniqueItems":true, "$ref":"/axapi/v3/sflow/collector/ip/{addr}+{port}", "array":[ { "properties":{ "addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Configure sFlow collector IP address", "optional":false }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":6343, "partition-visibility":"shared", "description":"Port number (default is 6343)", "optional":false }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"sFlow collector is through out-of-band management", "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 }, "customized-setting":{ "type":"object", "$ref":"/axapi/v3/sflow/collector/ip/{addr}+{port}/customized-setting", "properties":{ "export-enable":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'export': Export settings; ", "enum":[ "export" ] }, "packet-sampling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable packet sampling" }, "counter-polling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable counter polling" }, "a10-proprietary-polling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable counters for ACOS control blocks" }, "event-notification":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable event notification" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "addr", "port" ] } ] }, "custom-list":{ "type":"array", "minItems":1, "items":{ "type":"custom" }, "uniqueItems":true, "$ref":"/axapi/v3/sflow/collector/custom/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure name of sFlow Receiver", "optional":false }, "ipv4_addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Configure IP address of the sFlow Receiver", "optional":true }, "ipv6_addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Configure IPv6 address of the sFlow Receiver", "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":[ "name" ] } ] }, "ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"ipv6" }, "uniqueItems":true, "$ref":"/axapi/v3/sflow/collector/ipv6/{addr}+{port}", "array":[ { "properties":{ "addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Configure sFlow collector IPv6 address", "optional":false }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":6343, "partition-visibility":"shared", "description":"Port number (default is 6343)", "optional":false }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-neg-list":["chassis-duo"], "default":0, "partition-visibility":"shared", "description":"sFlow collector is through out-of-band management", "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 }, "customized-setting":{ "type":"object", "$ref":"/axapi/v3/sflow/collector/ipv6/{addr}+{port}/customized-setting", "properties":{ "export-enable":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'export': Customizes export settings for collector; ", "enum":[ "export" ] }, "packet-sampling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable packet sampling" }, "counter-polling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable counter polling" }, "a10-proprietary-polling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable counters for ACOS control blocks" }, "event-notification":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable event notification" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "addr", "port" ] } ] } } }, "agent":{ "type":"object", "$ref":"/axapi/v3/sflow/agent", "properties":{ "address":{ "type":"object", "$ref":"/axapi/v3/sflow/agent/address", "properties":{ "ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"ipv6", "description":"Configure sFlow agent IP address" }, "ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"ip", "description":"Configure sFlow agent IPv6 address" }, "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/sflow/source-address", "properties":{ "ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Source IPv4 address" }, "ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Source IPv6 address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "polling":{ "type":"object", "$ref":"/axapi/v3/sflow/polling", "properties":{ "eth-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "eth-start":{ "type":"number", "format":"interface", "plat-neg-list":["tps"], "partition-visibility":"shared", "description":"Ethernet interface to sample" }, "eth-end":{ "type":"number", "format":"interface", "plat-neg-list":["tps"], "partition-visibility":"shared", "description":"Ethernet interface to sample" } } } ] }, "ve-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve-start":{ "type":"number", "format":"number", "plat-neg-list":["tps"], "partition-visibility":"shared", "$ref":"/axapi/v3/interface/ve", "description":"VE interface to sample" }, "ve-end":{ "type":"number", "format":"number", "plat-neg-list":["tps"], "partition-visibility":"shared", "$ref":"/axapi/v3/interface/ve", "description":"VE interface to sample" } } } ] }, "cpu-usage":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Polling CPU usage" }, "http-counter":{ "type":"number", "format":"flag", "plat-neg-list":["tps"], "default":0, "partition-visibility":"shared", "description":"Polling HTTP counters" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "http":{ "type":"object", "$ref":"/axapi/v3/sflow/polling/http", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable polling HTTP counters; 'disable': Disable polling HTTP counters; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "system-health":{ "type":"object", "$ref":"/axapi/v3/sflow/polling/system-health", "properties":{ "system-health-usage":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable polling system health information; 'disable': Disable polling system health information; ", "enum":[ "enable", "disable" ] }, "per-control-cpu-usage":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable polling control cpu; 'disable': Disable polling control cpu usage; ", "enum":[ "enable", "disable" ] }, "per-data-cpu-usage":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable polling data cpu; 'disable': Disable polling data cpu usage; ", "enum":[ "enable", "disable" ] }, "license-statistics":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable polling license statistics; 'disable': Disable polling license statistics; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "ddos":{ "type":"object", "$ref":"/axapi/v3/sflow/polling/ddos", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable sflow polling for DDOS statistics; 'disable': Disable sflow polling for DDOS statistics; ", "enum":[ "enable", "disable" ] }, "3_0-compatibility":{ "type":"number", "format":"flag", "plat-neg-list":["chassis-duo"], "default":0, "partition-visibility":"shared", "not":"2_9-compatibility", "description":"Enable DDOS sflow polling 3.0/3.1 compatibility mode" }, "address-byte-order-host":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Export sflow address field in host byte order" }, "2_9-compatibility":{ "type":"number", "format":"flag", "plat-neg-list":["chassis-duo"], "default":0, "partition-visibility":"shared", "not":"3_0-compatibility", "description":"Enable DDOS sflow polling 2.9 compatibility mode" }, "dns-cache-zone-stats":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable polling for dns cache per instance and per zone statistics" }, "enable-anomaly-stats":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Polling for system wide anomaly statistics" }, "dyn-entry-stats":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable polling for dynamic entry statistics" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "a10-proprietary":{ "type":"object", "$ref":"/axapi/v3/sflow/polling/a10-proprietary", "properties":{ "export-deprecated-counters":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Export deprecated counters" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "ethernet-list":{ "type":"array", "minItems":1, "items":{ "type":"ethernet" }, "uniqueItems":true, "$ref":"/axapi/v3/sflow/polling/ethernet/{start}", "array":[ { "properties":{ "start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet interface to poll", "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":[ "start" ] } ] }, "ethernet-ext-list":{ "type":"array", "minItems":1, "items":{ "type":"ethernet-ext" }, "uniqueItems":true, "$ref":"/axapi/v3/sflow/polling/ethernet-ext/{start}", "array":[ { "properties":{ "start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet interface to poll", "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":[ "start" ] } ] } } }, "sampling":{ "type":"object", "$ref":"/axapi/v3/sflow/sampling", "properties":{ "eth-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "eth-start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet interface to sample" }, "eth-end":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet interface to sample" } } } ] }, "ve-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "$ref":"/axapi/v3/interface/ve", "description":"VE interface to sample" }, "ve-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "$ref":"/axapi/v3/interface/ve", "description":"VE interface to sample" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "event-notification":{ "type":"object", "$ref":"/axapi/v3/sflow/event-notification", "properties":{ "ddos":{ "type":"object", "$ref":"/axapi/v3/sflow/event-notification/ddos", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable sflow notification for DDOS events; 'disable': Disable sflow notification for DDOS events; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "global":{ "type":"object", "$ref":"/axapi/v3/sflow/global", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'total-packet-sample-records': Total packet sample records; 'total-counter-sample-records': Total counter sample records; 'total-sflow-packets-sent': Total sflow packets sent; 'total-sflow-local-packets-sent': Total sflow packets sent desc {}; 'total-sflow-packets-sent-mgmt': Total sflow packets sent via Mgmt Interface; 'total-sflow-packets-drop-mgmt': sflow packets dropped because of rate limit via Mgmt Interface; ", "enum":[ "all", "total-packet-sample-records", "total-counter-sample-records", "total-sflow-packets-sent", "total-sflow-local-packets-sent", "total-sflow-packets-sent-mgmt", "total-sflow-packets-drop-mgmt" ] } } } ] } } } } }