getOrgMxEdges

GET https://{{host}}/api/v1/orgs/:org_id/mxedges

Query Parameters

Name	Type	Description
`for_site`	`boolean`	true / false/ any (default false). Filter for site level mist edges

Response Parameters

Name	Type	Description
`mxcluster_id`	`string`	MxCluster this MxEdge belongs to
`oob_ip_config`	`object`	ip configuration of the Mist Edge out-of-band management interface
`proxy`	`object`	Proxy Configuration to talk to Mist
`tunterm_ip_config`	`object`	ip configuration of the Mist Tunnel interface
`tunterm_other_ip_configs`	`object`	ip configuration of the Mist Tunneled VLANs
`tunterm_extra_routes`	`object`	extra routes for Mist Tunneled VLANs
`tunterm_dhcpd_config`	`object`	DHCP server/relay configuration of Mist Tunneled VLANs
`services`	`list`	list of services to run, `tunterm` only for now
`tunterm_port_config`	`object`	ethernet port configurations
`separate_upstream_downstream`	`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)
`upstream_port_vlan_id`	`int`	native VLAN id for upstream ports, default is 1
`tunterm_igmp_snooping_config`	`object`	tunterm igmp snooping config

MxEdge OOB IP Config

Name	Type	Description
`oob_ip_config`	`object`	ip config
`type`	`string`	static. default: not managed from cloud.
`ip`	`string`	required if type==static
`netmask`	`string`	required if type==static
`gateway`	`string`	required if type==static
`dns`	`list`	if type==static. default is `8.8.8.8, 8.8.4.4`

MxEdge Mist Tunnel IP Config

Name	Type	Description
`tunterm_ip_config`	`object`	ip config
`ip`	`string`	required
`netmask`	`string`	required
`gateway`	`string`	required

MxEdge Mist Tunnel VLAN IP Config

Parameter	Type	Description
tuntermotherip_configs	object	ip configs by VLAN ID
ip	string	required
netmask	string	required

Extra Routes for Mist Tunneled VLANs

Parameter	Type	Description
tuntermextraroutes	object	key is the dest
via	string	next-hop

DHCP server/relay for Mist Tunneled VLANs

Parameter	Type	Description
tuntermdhcpdconfig	object	global and per-VLAN
type	string	relay (default)
enabled	boolean	enabled or not, default is false
servers	list	DHCP servers; required if type==relay

Tunterm IGMP Snooping Config

Parameter	Type	Description
tuntermigmpsnooping_config	object	tunterm igmp snooping config
vlan_ids	array of ints	the list of vlans on which tunterm performs IGMP snooping
querier.query_interval	int	querier’s query interval, in seconds
querier.maxresponsetime	int	querier’s query response interval, in tenths-of-seconds
querier.robustness	int	querier’s robustness (1 to 7)
querier.version	int	querier’s maximum protocol version
querier.mtu	int	the MTU we use (needed when forming large IGMPv3 Reports)

Request Params

Key	Datatype	Required	Description
`for_site`	null		true / false/ any (default false). Filter for site level mist edges

RESPONSES

status: OK

[{&quot;id&quot;:&quot;95ddd29a-6a3c-929e-a431-51a5b09f36a6&quot;,&quot;name&quot;:&quot;Guest&quot;,&quot;model&quot;:&quot;ME-100&quot;,&quot;magic&quot;:&quot;L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD&quot;,&quot;tunterm_registered&quot;:true,&quot;mxagent_registered&quot;:true,&quot;proxy&quot;:{&quot;url&quot;:&quot;http://proxy.internal:8080/&quot;},&quot;mxedge_mgmt&quot;:{&quot;mist_password&quot;:&quot;MIST_PASSWORD&quot;,&quot;root_password&quot;:&quot;ROOT_PASSWORD&quot;},&quot;oob_ip_config&quot;:{&quot;type&quot;:&quot;static&quot;,&quot;ip&quot;:&quot;10.2.1.10&quot;,&quot;netmask&quot;:&quot;255.255.255.0&quot;,&quot;gateway&quot;:&quot;10.2.1.254&quot;,&quot;type6&quot;:&quot;static&quot;,&quot;ip6&quot;:&quot;2601:1700:43c0:dc0:20c:29ff:fea7:93bc&quot;,&quot;netmask6&quot;:&quot;/64&quot;,&quot;gateway6&quot;:&quot;2601:1700:43c0:dc0::1&quot;,&quot;dns&quot;:[&quot;10.2.1.2&quot;,&quot;2601:1700:43c0:dc0::2&quot;]},&quot;tunterm_ip_config&quot;:{&quot;ip&quot;:&quot;10.2.1.1&quot;,&quot;netmask&quot;:&quot;255.255.255.0&quot;,&quot;gateway&quot;:&quot;10.2.1.254&quot;,&quot;ip6&quot;:&quot;2001:1010:1010:1010::2&quot;,&quot;netmask6&quot;:&quot;/64&quot;,&quot;gateway6&quot;:&quot;2001:1010:1010:1010::1&quot;},&quot;tunterm_other_ip_configs&quot;:{&quot;5&quot;:{&quot;ip&quot;:&quot;10.3.3.1&quot;,&quot;netmask&quot;:&quot;255.255.255.0&quot;}},&quot;tunterm_extra_routes&quot;:{&quot;11.0.0.0/8&quot;:{&quot;via&quot;:&quot;10.3.3.1&quot;}},&quot;tunterm_dhcpd_config&quot;:{&quot;enabled&quot;:false,&quot;servers&quot;:[&quot;11.2.3.4&quot;],&quot;2&quot;:{&quot;enabled&quot;:true,&quot;servers&quot;:[&quot;11.2.3.44&quot;]}},&quot;tunterm_port_config&quot;:{&quot;separate_upstream_downstream&quot;:true,&quot;downstream_ports&quot;:[&quot;3&quot;],&quot;upstream_ports&quot;:[&quot;0&quot;,&quot;1&quot;,&quot;2&quot;],&quot;upstream_port_vlan_id&quot;:30},&quot;tunterm_switch_config&quot;:{&quot;enabled&quot;:true,&quot;0&quot;:{&quot;vlan_ids&quot;:[1,3055],&quot;port_vlan_id&quot;:1}},&quot;tunterm_monitoring&quot;:[{&quot;protocol&quot;:&quot;ping&quot;,&quot;host&quot;:&quot;10.2.8.15&quot;,&quot;timeout&quot;:300,&quot;port&quot;:80}],&quot;ntp_servers&quot;:[],&quot;mxcluster_id&quot;:&quot;572586b7-f97b-a22b-526c-8b97a3f609c4&quot;,&quot;tunterm_igmp_snooping_config&quot;:{&quot;enabled&quot;:true,&quot;vlan_ids&quot;:[2,3,5],&quot;querier&quot;:{&quot;query_interval&quot;:125,&quot;max_response_time&quot;:10,&quot;robustness&quot;:2,&quot;version&quot;:3,&quot;mtu&quot;:1500}},&quot;tunterm_multicast_config&quot;:{&quot;mdns&quot;:{&quot;enabled&quot;:true,&quot;vlan_ids&quot;:[2,3,5]},&quot;ssdp&quot;:{&quot;enabled&quot;:true,&quot;vlan_ids&quot;:[2,3,5]}}}]