{
    "id":"/axapi/v3/sflow",
    "type":"object",
    "node-type":"intermediate",
    "title":"sflow",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "description":"Configure sFlow",
    "properties":{
        "setting":{
            "type":"object",
            "$ref":"/axapi/v3/sflow/setting",
            "properties":{
                "max-header":{
                    "type":"number",
                    "format":"number",
                    "minimum":14,
                    "maximum":512,
                    "description":"Configure maximum number of bytes that should be copied from a sampled packet (default: 128) (The maximum number of bytes (Default: 128))"
                },
                "packet-sampling-rate":{
                    "type":"number",
                    "format":"number",
                    "minimum":10,
                    "maximum":10000,
                    "description":"sFlow packet sampling rate, default is 1000"
                },
                "counter-polling-interval":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":200,
                    "description":"sFlow counter polling interval, default is 20"
                },
                "management-link-utilization-percentage":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100,
                    "default":30,
                    "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,
                    "not":"management-link-utilization-percentage",
                    "description":"limit management link speed in (Mbps)"
                },
                "randomize-source-port":{
                    "type":"string",
                    "format":"enum",
                    "default":"packet-sampling-only",
                    "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,
                    "description":"Source port-range"
                },
                "port-range-end":{
                    "type":"number",
                    "format":"number",
                    "minimum":2049,
                    "maximum":63640,
                    "description":"Source port-range end"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "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",
                                    "description":"Configure sFlow collector IP address",
                                    "optional":false
                                },
                                "port":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":6343,
                                    "description":"Port number (default is 6343)",
                                    "optional":false
                                },
                                "use-mgmt-port":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "description":"sFlow collector is through out-of-band management",
                                    "optional":true
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                },
                                "user-tag":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":127,
                                    "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",
                                            "description":"'export': Export settings; ",
                                            "enum":[
                                                "export"
                                            ]
                                        },
                                        "packet-sampling":{
                                            "type":"number",
                                            "format":"flag",
                                            "default":0,
                                            "description":"Enable packet sampling"
                                        },
                                        "counter-polling":{
                                            "type":"number",
                                            "format":"flag",
                                            "default":0,
                                            "description":"Enable counter polling"
                                        },
                                        "a10-proprietary-polling":{
                                            "type":"number",
                                            "format":"flag",
                                            "default":0,
                                            "description":"Enable counters for ACOS control blocks"
                                        },
                                        "event-notification":{
                                            "type":"number",
                                            "format":"flag",
                                            "plat-neg-list":["chassis-duo"],
                                            "default":0,
                                            "description":"Enable event notification"
                                        },
                                        "uuid":{
                                            "type":"string",
                                            "format":"string",
                                            "minLength":1,
                                            "maxLength":64,
                                            "modify-not-allowed":1,
                                            "description":"uuid of the object"
                                        }
                                    }
                                }
                            },
                            "required":[
                                "addr",
                                "port"
                            ]
                        }
                    ]
                },
                "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",
                                    "description":"Configure sFlow collector IPv6 address",
                                    "optional":false
                                },
                                "port":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":6343,
                                    "description":"Port number (default is 6343)",
                                    "optional":false
                                },
                                "use-mgmt-port":{
                                    "type":"number",
                                    "format":"flag",
                                    "plat-neg-list":["chassis-duo"],
                                    "default":0,
                                    "description":"sFlow collector is through out-of-band management",
                                    "optional":true
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                },
                                "user-tag":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":127,
                                    "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",
                                            "description":"'export': Customizes export settings for collector; ",
                                            "enum":[
                                                "export"
                                            ]
                                        },
                                        "packet-sampling":{
                                            "type":"number",
                                            "format":"flag",
                                            "default":0,
                                            "description":"Enable packet sampling"
                                        },
                                        "counter-polling":{
                                            "type":"number",
                                            "format":"flag",
                                            "default":0,
                                            "description":"Enable counter polling"
                                        },
                                        "a10-proprietary-polling":{
                                            "type":"number",
                                            "format":"flag",
                                            "default":0,
                                            "description":"Enable counters for ACOS control blocks"
                                        },
                                        "event-notification":{
                                            "type":"number",
                                            "format":"flag",
                                            "plat-neg-list":["chassis-duo"],
                                            "default":0,
                                            "description":"Enable event notification"
                                        },
                                        "uuid":{
                                            "type":"string",
                                            "format":"string",
                                            "minLength":1,
                                            "maxLength":64,
                                            "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",
                            "not":"ipv6",
                            "description":"Configure sFlow agent IP address"
                        },
                        "ipv6":{
                            "type":"string",
                            "format":"ipv6-address",
                            "not":"ip",
                            "description":"Configure sFlow agent IPv6 address"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "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",
                    "description":"Source IPv4 address"
                },
                "ipv6":{
                    "type":"string",
                    "format":"ipv6-address",
                    "description":"Source IPv6 address"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "polling":{
            "type":"object",
            "$ref":"/axapi/v3/sflow/polling",
            "properties":{
                "http":{
                    "type":"object",
                    "$ref":"/axapi/v3/sflow/polling/http",
                    "properties":{
                        "toggle":{
                            "type":"string",
                            "format":"enum",
                            "default":"disable",
                            "description":"'enable': Enable polling HTTP counters; 'disable': Disable polling HTTP counters; ",
                            "enum":[
                                "enable",
                                "disable"
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                },
                "cpu-usage":{
                    "type":"object",
                    "$ref":"/axapi/v3/sflow/polling/cpu-usage",
                    "properties":{
                        "toggle":{
                            "type":"string",
                            "format":"enum",
                            "default":"disable",
                            "description":"'enable': Enable polling CPU usage; 'disable': Disable polling CPU usage; ",
                            "enum":[
                                "enable",
                                "disable"
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "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",
                            "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",
                            "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",
                            "description":"'enable': Enable polling data cpu; 'disable': Disable polling data cpu usage; ",
                            "enum":[
                                "enable",
                                "disable"
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "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",
                            "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",
                            "default":0,
                            "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,
                            "description":"Export sflow address field in host byte order"
                        },
                        "dns-cache-zone-stats":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "description":"Enable polling for dns cache per instance and per zone statistics"
                        },
                        "enable-anomaly-stats":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "description":"Enable Polling for system wide anomaly statistics"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "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,
                            "description":"Export deprecated counters"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "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",
                                    "minimum":91,
                                    "maximum":15,
                                    "description":"Ethernet interface to poll",
                                    "optional":false
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "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",
                                    "description":"Ethernet interface to sample"
                                },
                                "eth-end":{
                                    "type":"number",
                                    "format":"interface",
                                    "description":"Ethernet interface to sample"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "ve-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "ve-start":{
                                    "type":"number",
                                    "format":"number",
                                    "$ref":"/axapi/v3/interface/ve",
                                    "description":"VE interface to sample"
                                },
                                "ve-end":{
                                    "type":"number",
                                    "format":"number",
                                    "$ref":"/axapi/v3/interface/ve",
                                    "description":"VE interface to sample"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "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",
                            "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,
                            "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,
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        }
    }
}