createOrgMxEdge
POST https://{{host}}/api/v1/orgs/:org_id/mxedges
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | name of the Mist Edge |
| model | string | model of the Mist Edge |
| service | list | list of services enabled |
| mxcluster_id | string | MxCluster this MxEdge belongs to |
| tuntermipconfig | object | ip configuration of the Mist Tunnel interface |
| services | list | list of services to run, tunterm only for now |
| tuntermportconfig | object | ethernet port configurations |
| separateupstreamdownstream | boolean | weather to separate upstream / downstream ports. default is false where all ports will be used. |
| downstream_ports | list | list of ports to be used for downstream (to AP) purpose |
| upstream_ports | list | list of ports to be used for upstrea purpose (to LAN) |
| upstreamportvlan_id | int | native VLAN id for upstream ports, default is 1 |
Note: The list of available Mist Edge Models is available in Org>Const>getMxEdgeModels
Request Body
{"name"=>"Guest", "model"=>"ME-100", "services"=>["tunterm"], "versions"=>{"mxagent"=>"2.4.194", "tunterm"=>"0.1.928-1"}, "note"=>"note for mxedge", "tunterm_ip_config"=>{"ip"=>"10.2.1.1", "netmask"=>"255.255.255.0", "gateway"=>"10.2.1.254"}, "tunterm_port_config"=>{"separate_upstream_downstream"=>true, "downstream_ports"=>["0", "1", "2", "3"], "upstream_ports"=>["0", "1", "2", "3"], "upstream_port_vlan_id"=>1}, "tunterm_switch_config"=>{"enabled"=>true, "0"=>{"vlan_ids"=>[5, 2, 3], "port_vlan_id"=>nil}}, "mxcluster_id"=>"572586b7-f97b-a22b-526c-8b97a3f609c4"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
X-CSRFToken | string | ||
Content-Type | string |
RESPONSES
status: OK
{"id":"95ddd29a-6a3c-929e-a431-51a5b09f36a6","name":"Edge1","magic":"ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD","tunterm_registered":false,"mxagent_registered":false,"mxcluster_id":"572586b7-f97b-a22b-526c-8b97a3f609c4"}