createOrgMxTunnel

POST https://{{host}}/api/v1/orgs/:org_id/mxtunnels

Body Parameters

NameTypeDescription
namestringthe name of the tunnel
protocollistudp / ip, default is udp
vlan_idslistlist of vlan ids/ranges that will be used
mxcluster_idslistlist of mxclusters to deploy this tunnel to
anchor_mxtunnel_idslistlist of anchor mxtunnels used for forming edge to edge tunnels
hello_intervalfloatin seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by hello_retries. between 0.5 and 300, default is 60 seconds
hello_retriesintbetween 1 and 30, default is 7
auto_preemptionobjectschedule(daily/weekly) to preempt ap’s which are not connected to preferred peer

Auto Preemption Parameters

ParameterTypeDescription
enabledbooleanwhether auto preemption should happen, default is false
timeofdaystringany / HH:MM (24-hour format). Preemption will happen within an hour of this time
dayofweekstringany / mon / tue / wed / thu / fri / sat / sun

Request Body

{"name"=>"HQ", "protocol"=>"udp", "vlan_ids"=>[3, 4, 5, "7-9"], "mxcluster_ids"=>["572586b7-f97b-a22b-526c-8b97a3f609c4"], "anchor_mxtunnel_ids"=>["1e970fec-0a7a-4d73-a472-3ef3b6a456aa"], "hello_interval"=>60, "hello_retries"=>3, "ipsec"=>{"enabled"=>true, "split_tunnel"=>true, "dns_servers"=>["172.16.0.8"], "dns_suffix"=>["corp.juniper.com", "juniper.internal"], "extra_routes"=>[{"dest"=>"172.16.0.0/12", "next_hop"=>"172.16.0.1"}]}, "auto_preemption"=>{"enabled"=>true, "time_of_day"=>"23:00", "day_of_week"=>"sun"}}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
X-CSRFTokenstring
Content-Typestring