{
    "id":"/axapi/v3/overlay-tunnel",
    "type":"object",
    "node-type":"intermediate",
    "title":"overlay-tunnel",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "partition-visibility":"shared",
    "description":"Configure a Tunnel end point",
    "properties":{
        "options":{
            "type":"object",
            "$ref":"/axapi/v3/overlay-tunnel/options",
            "properties":{
                "ip-dscp-preserve":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Copy DSCP bits from inner IP to outer IP header"
                },
                "nvgre-disable-flow-id":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Disable Flow-ID computation for NVGRE"
                },
                "nvgre-key-mode-lower24":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Use the lower 24-bits of the GRE key as the VSID"
                },
                "tcp-mss-adjust-disable":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Disable TCP MSS adjustment in SYN packet for tunnels"
                },
                "gateway-mac":{
                    "type":"string",
                    "format":"mac-address",
                    "partition-visibility":"shared",
                    "description":"MAC to be used with Gateway segment Id (MAC Address for the Gateway segment)"
                },
                "fragmentation-mode-inner":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Enable the inner-fragmentation"
                },
                "vxlan-dest-port":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":65535,
                    "partition-visibility":"shared",
                    "description":"VXLAN UDP Destination Port (UDP Port Number (default 4789))"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "src-port-range":{
                    "type":"object",
                    "$ref":"/axapi/v3/overlay-tunnel/options/src-port-range",
                    "properties":{
                        "min-port":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":1,
                            "partition-visibility":"shared",
                            "description":"Minimum Port Number"
                        },
                        "max-port":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "default":65535,
                            "partition-visibility":"shared",
                            "description":"Maximum Port Number"
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        },
        "vtep-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"vtep"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}",
            "array":[
                {
                    "properties":{
                        "id":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":190,
                            "partition-visibility":"shared",
                            "description":"VTEP Identifier",
                            "optional":false
                        },
                        "encap":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'ip-encap': Tunnel encapsulation type is IP; 'gre': Tunnel encapsulation type is GRE; 'nvgre': Tunnel Encapsulation Type is NVGRE; 'vxlan': Tunnel Encapsulation Type is VXLAN; ",
                            "enum":[
                                "ip-encap",
                                "gre",
                                "nvgre",
                                "vxlan"
                            ],
                            "optional":true
                        },
                        "dest-port":{
                            "type":"number",
                            "format":"number",
                            "plat-neg-list":["pure-fpga,fpga", "fpga"],
                            "minimum":1,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Layer-4 Destination Port (Port Number)",
                            "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; 'cfg_err_count': Config errors; 'flooded_pkt_count': Flooded packet count; 'encap_unresolved_count': Encap unresolved failures; 'unknown_encap_rx_pkt': Encap miss rx pkts; 'unknown_encap_tx_pkt': Encap miss tx pkts; 'arp_req_sent': Arp request sent; 'vtep_host_learned': Hosts learned; 'vtep_host_learn_error': Host learn error; 'invalid_lif_rx': Invalid Lif pkts in; 'invalid_lif_tx': Invalid Lif pkts out; 'unknown_vtep_tx': Vtep unknown tx; 'unknown_vtep_rx': Vtep Unkown rx; 'unhandled_pkt_rx': Unhandled packets in; 'unhandled_pkt_tx': Unhandled packets out; 'total_pkts_rx': Total packets out; 'total_bytes_rx': Total packet bytes in; 'unicast_pkt_rx': Total unicast packets in; 'bcast_pkt_rx': Total broadcast packets in; 'mcast_pkt_rx': Total multicast packets in; 'dropped_pkt_rx': Dropped received packets; 'encap_miss_pkts_rx': Encap missed in received packets; 'bad_chksum_pks_rx': Bad checksum in received packets; 'requeue_pkts_in': Requeued packets in; 'pkts_out': Packets out; 'total_bytes_tx': Packet bytes out; 'unicast_pkt_tx': Unicast packets out; 'bcast_pkt_tx': Broadcast packets out; 'mcast_pkt_tx': Multicast packets out; 'dropped_pkts_tx': Dropped packets out; 'large_pkts_rx': Too large packets in; 'dot1q_pkts_rx': Dot1q packets in; 'frag_pkts_tx': Frag packets out; 'reassembled_pkts_rx': Reassembled packets in; 'bad_inner_ipv4_len_rx': bad inner ipv4 packet len; 'bad_inner_ipv6_len_rx': Bad inner ipv6 packet len; 'frag_drop_pkts_tx': Frag dropped packets out; 'lif_un_init_rx': Lif uninitialized packets in; ",
                                            "enum":[
                                                "all",
                                                "cfg_err_count",
                                                "flooded_pkt_count",
                                                "encap_unresolved_count",
                                                "unknown_encap_rx_pkt",
                                                "unknown_encap_tx_pkt",
                                                "arp_req_sent",
                                                "vtep_host_learned",
                                                "vtep_host_learn_error",
                                                "invalid_lif_rx",
                                                "invalid_lif_tx",
                                                "unknown_vtep_tx",
                                                "unknown_vtep_rx",
                                                "unhandled_pkt_rx",
                                                "unhandled_pkt_tx",
                                                "total_pkts_rx",
                                                "total_bytes_rx",
                                                "unicast_pkt_rx",
                                                "bcast_pkt_rx",
                                                "mcast_pkt_rx",
                                                "dropped_pkt_rx",
                                                "encap_miss_pkts_rx",
                                                "bad_chksum_pks_rx",
                                                "requeue_pkts_in",
                                                "pkts_out",
                                                "total_bytes_tx",
                                                "unicast_pkt_tx",
                                                "bcast_pkt_tx",
                                                "mcast_pkt_tx",
                                                "dropped_pkts_tx",
                                                "large_pkts_rx",
                                                "dot1q_pkts_rx",
                                                "frag_pkts_tx",
                                                "reassembled_pkts_rx",
                                                "bad_inner_ipv4_len_rx",
                                                "bad_inner_ipv6_len_rx",
                                                "frag_drop_pkts_tx",
                                                "lif_un_init_rx"
                                            ]
                                        }
                                    }
                                }
                            ]
                        },
                        "src-port-range":{
                            "type":"object",
                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/src-port-range",
                            "properties":{
                                "min-port":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":1,
                                    "partition-visibility":"shared",
                                    "description":"Minimum Port Number"
                                },
                                "max-port":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":65535,
                                    "partition-visibility":"shared",
                                    "description":"Maximum Port Number"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                }
                            }
                        },
                        "local-ip-address":{
                            "type":"object",
                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address",
                            "properties":{
                                "ip-address":{
                                    "type":"string",
                                    "format":"ipv4-address",
                                    "partition-visibility":"shared",
                                    "description":"Source Tunnel End Point IPv4 address"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                },
                                "vni-list":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"vni"
                                    },
                                    "uniqueItems":true,
                                    "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address/vni/{segment}",
                                    "array":[
                                        {
                                            "properties":{
                                                "segment":{
                                                    "type":"number",
                                                    "format":"number",
                                                    "minimum":1,
                                                    "maximum":16777215,
                                                    "partition-visibility":"shared",
                                                    "description":"Id of the segment that is being extended",
                                                    "optional":false
                                                },
                                                "partition":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":127,
                                                    "partition-visibility":"shared",
                                                    "$ref":"/axapi/v3/partition",
                                                    "description":"Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)",
                                                    "optional":true
                                                },
                                                "gateway":{
                                                    "type":"number",
                                                    "format":"flag",
                                                    "default":0,
                                                    "partition-visibility":"shared",
                                                    "description":"This is a Gateway segment id",
                                                    "optional":true
                                                },
                                                "lif":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":15,
                                                    "partition-visibility":"shared",
                                                    "description":"Logical interface (logical interface name)",
                                                    "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
                                                }
                                            },
                                            "required":[
                                                "segment"
                                            ]
                                        }
                                    ]
                                }
                            }
                        },
                        "local-ipv6-address":{
                            "type":"object",
                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/local-ipv6-address",
                            "properties":{
                                "ipv6-address":{
                                    "type":"string",
                                    "format":"ipv6-address",
                                    "partition-visibility":"shared",
                                    "description":"Source Tunnel End Point IPv6 address"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                }
                            }
                        },
                        "remote-ip-address-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"remote-ip-address"
                            },
                            "uniqueItems":true,
                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}",
                            "array":[
                                {
                                    "properties":{
                                        "ip-address":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"IP Address of the remote VTEP",
                                            "optional":false
                                        },
                                        "encap":{
                                            "type":"string",
                                            "format":"enum",
                                            "partition-visibility":"shared",
                                            "description":"'nvgre': Tunnel Encapsulation Type is NVGRE; 'vxlan': Tunnel Encapsulation Type is VXLAN; ",
                                            "enum":[
                                                "nvgre",
                                                "vxlan"
                                            ],
                                            "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
                                        },
                                        "use-lif":{
                                            "type":"object",
                                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/use-lif",
                                            "properties":{
                                                "partition":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":127,
                                                    "partition-visibility":"shared",
                                                    "$ref":"/axapi/v3/partition",
                                                    "description":"Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)"
                                                },
                                                "lif":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":15,
                                                    "partition-visibility":"shared",
                                                    "description":"Logical interface (logical interface name)"
                                                },
                                                "uuid":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":64,
                                                    "partition-visibility":"shared",
                                                    "modify-not-allowed":1,
                                                    "description":"uuid of the object"
                                                }
                                            }
                                        },
                                        "gre-keepalive":{
                                            "type":"object",
                                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/gre-keepalive",
                                            "properties":{
                                                "retry-time":{
                                                    "type":"number",
                                                    "format":"number",
                                                    "minimum":1,
                                                    "maximum":60,
                                                    "default":10,
                                                    "partition-visibility":"shared",
                                                    "description":"Keepalive retry interval in seconds"
                                                },
                                                "retry-count":{
                                                    "type":"number",
                                                    "format":"number",
                                                    "minimum":2,
                                                    "maximum":100,
                                                    "partition-visibility":"shared",
                                                    "description":"Keepalive multiplier"
                                                },
                                                "uuid":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":64,
                                                    "partition-visibility":"shared",
                                                    "modify-not-allowed":1,
                                                    "description":"uuid of the object"
                                                }
                                            }
                                        },
                                        "use-gre-key":{
                                            "type":"object",
                                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/use-gre-key",
                                            "properties":{
                                                "gre-key":{
                                                    "type":"number",
                                                    "format":"number",
                                                    "minimum":0,
                                                    "maximum":4294967295,
                                                    "partition-visibility":"shared",
                                                    "description":"key"
                                                },
                                                "uuid":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":64,
                                                    "partition-visibility":"shared",
                                                    "modify-not-allowed":1,
                                                    "description":"uuid of the object"
                                                }
                                            }
                                        },
                                        "vni-list":{
                                            "type":"array",
                                            "minItems":1,
                                            "items":{
                                                "type":"vni"
                                            },
                                            "uniqueItems":true,
                                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/vni/{segment}",
                                            "array":[
                                                {
                                                    "properties":{
                                                        "segment":{
                                                            "type":"number",
                                                            "format":"number",
                                                            "minimum":1,
                                                            "maximum":16777215,
                                                            "partition-visibility":"shared",
                                                            "description":"VNI configured for the remote VTEP",
                                                            "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":[
                                                        "segment"
                                                    ]
                                                }
                                            ]
                                        }
                                    },
                                    "required":[
                                        "ip-address"
                                    ]
                                }
                            ]
                        },
                        "remote-ipv6-address-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"remote-ipv6-address"
                            },
                            "uniqueItems":true,
                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ipv6-address/{ipv6-address}",
                            "array":[
                                {
                                    "properties":{
                                        "ipv6-address":{
                                            "type":"string",
                                            "format":"ipv6-address",
                                            "partition-visibility":"shared",
                                            "description":"IPv6 Address of the remote VTEP",
                                            "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
                                        },
                                        "user-tag":{
                                            "type":"string",
                                            "format":"string-rlx",
                                            "minLength":1,
                                            "maxLength":127,
                                            "partition-visibility":"shared",
                                            "description":"Customized tag",
                                            "optional":true
                                        },
                                        "use-lif":{
                                            "type":"object",
                                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/remote-ipv6-address/{ipv6-address}/use-lif",
                                            "properties":{
                                                "partition":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":127,
                                                    "partition-visibility":"shared",
                                                    "$ref":"/axapi/v3/partition",
                                                    "description":"Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)"
                                                },
                                                "lif":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":15,
                                                    "partition-visibility":"shared",
                                                    "description":"Logical interface (logical interface name)"
                                                },
                                                "uuid":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":64,
                                                    "partition-visibility":"shared",
                                                    "modify-not-allowed":1,
                                                    "description":"uuid of the object"
                                                }
                                            }
                                        }
                                    },
                                    "required":[
                                        "ipv6-address"
                                    ]
                                }
                            ]
                        },
                        "host-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"host"
                            },
                            "uniqueItems":true,
                            "$ref":"/axapi/v3/overlay-tunnel/vtep/{id}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-vtep}",
                            "array":[
                                {
                                    "properties":{
                                        "ip-addr":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"IPv4 address of the overlay host",
                                            "optional":false
                                        },
                                        "overlay-mac-addr":{
                                            "type":"string",
                                            "format":"mac-address",
                                            "partition-visibility":"shared",
                                            "description":"MAC Address of the overlay host",
                                            "optional":false
                                        },
                                        "vni":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":1,
                                            "maximum":16777215,
                                            "partition-visibility":"shared",
                                            "description":" Configure the segment id ( VNI of the remote host)",
                                            "optional":false
                                        },
                                        "remote-vtep":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"Configure the VTEP IP address (IPv4 address of the VTEP for the remote host)",
                                            "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":[
                                        "ip-addr",
                                        "overlay-mac-addr",
                                        "vni",
                                        "remote-vtep"
                                    ]
                                }
                            ]
                        }
                    },
                    "required":[
                        "id"
                    ]
                }
            ]
        }
    }
}