{
    "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,
                    "default":128,
                    "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":1000000,
                    "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":10,
                    "partition-visibility":"shared",
                    "description":"sFlow counter polling interval, default is 10"
                },
                "local-collection":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Enable local sflow collection"
                },
                "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
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                }
                            },
                            "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",
                                    "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
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                }
                            },
                            "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",
                                    "partition-visibility":"shared",
                                    "description":"Ethernet interface to sample"
                                },
                                "eth-end":{
                                    "type":"number",
                                    "format":"interface",
                                    "partition-visibility":"shared",
                                    "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",
                                    "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"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "cpu-usage":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Polling CPU usage"
                },
                "http-counter":{
                    "type":"number",
                    "format":"flag",
                    "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"
                }
            }
        },
        "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"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "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"
                                },
                                "optional":true
                            }
                        }
                    ]
                },
                "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; ",
                                    "enum":[
                                        "all",
                                        "total-packet-sample-records",
                                        "total-counter-sample-records",
                                        "total-sflow-packets-sent"
                                    ]
                                },
                                "optional":true
                            }
                        }
                    ]
                }
            }
        }
    }
}