updateSiteGroups
PUT https://{{host}}/api/v1/sites/:site_id
Body Parameter
| Parameter | Type | Description |
|---|
| analytic.enabled | boolean | enable Advanced Analytic feature, default is false (using SUB-ANA license) |
| app_waking | boolean | default is false |
| auto_upgrade | object | auto upgrade |
| bandwidth | int | channel width for the band, 20 / 40 / 80 / 160, 80 is only applicable for band5, 160 is only for band6 |
| ble_config | object | BLE config (see Site:BLE Config) |
| ble | object | BLE asset settings |
| brightness | int | 0-255, default is 255 |
| channel | int | (primary) channel for the band, 0 means auto |
| channels | list | list of channels, null or empty array means auto |
| deviceupdownthreshold | int | enable threshold-based device down delivery via 1) device-updowns webhooks topic, 2) Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 30, default is 0 (trigger immediate) |
| flags | list | name/val pair objects for location engine to use |
| hello_interval | float | in 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 1 and 300, default is 60 seconds |
| hello_retries | int | between 2 and 30, default is 7 |
| led.enabled | boolean | whether to enable LED, default is true |
| led | object | LED control |
| model_specific | object | overwrites for a specific model. If a band is specified, it will shadow the default. |
| configautorevert | boolean | whether to enable ap auto config revert, default is false |
| mxtunnel.mtu | int | 552-1500, default is 0 |
| mxtunnel.auto_preemption | object | schedule to preempt ap’s which are not connected to preferred peer |
| ntp_servers | list | list of NTP servers |
| persistconfigon_device | boolean | whether to store the config on AP, default is false |
| power_max | int | when power=0, min tx power to use, HW-specific values will be used if not set |
| power_min | int | when power=0, min tx power to use, HW-specific values will be used if not set |
| power | int | tx power of the radio, 0 mean auto |
| preamble | string | short / long / auto, default is short |
| proxy | object | Proxy Configuration for APs to talk to Mist |
| radio_config | object | site RF settings |
| remote_syslog | object | syslog parameters |
| report_gatt | boolean | default is false; whether AP should periodically connect to BLE devices and report GATT device info (device name, manufacturer name, serial number, battery %, temperature, humidity) |
| rogue | object | rogue detection parameters |
| rtsa | object | managed mobility |
| ssh_keys | list | when limitsshaccess = true in Org Setting, list of SSH public keys provided by Mist Support to install onto APs (see Org:Setting) |
| trackanonymousdevices | boolean | default is false; whether to track anonymous BLE assets (requires ‘track_asset’ enabled) |
| track_asset | boolean | enable Asset Tracking, default is false (using SUB-AST license) |
| vars | object | a dictionary of name->value, the vars can then be used in Wlans |
| wifi | object | managed connectivity |
Occupancy Parameter
| Parameter | Type | Description |
|---|
| assets_enabled | boolean | indicate whether named BLE assets should be included in the zone occupancy calculation, default is false |
| sdkclients_enabled | boolean | indicate whether SDK clients should be included in the zone occupancy calculation, default is false |
| clients_enabled | boolean | indicate whether connected WiFi clients should be included in the zone occupancy calculation, default is true |
| unconnectedclientsenabled | boolean | indicate whether unconnected WiFi clients should be included in the zone occupancy calculation, default is false |
| min_duration | int | minimum duration, default is 3000 |
Zone Occupancy Alert Parameters
| Parameter | Type | Description |
|---|
| enabled | boolean | indicate whether zone occupancy alert is enabled for the site, default is false |
| threshold | int | sending zone-occupancy-alert webhook message only if a zone stays non-compliant (i.e. actual occupancy > occupancy_limit) for a minimum duration specified in the threshold, in minutes, 0 - 30, default is 5 minutes |
| email_notifiers | array of strings | list of email addresses to send email notifications when the alert threshold is reached |
Wi-Fi Parameter
| Name | Type | Description |
|---|
enabled | boolean | enable WIFI feature, default is true (using SUB-MAN license) |
enable_arp_spoof_check | boolean | when proxy_arp is enabled, check for arp spoofing. default is false |
enable_channel_144 | boolean | whether to enable channel 144 (some older clients may not support it), default is false |
vna.enabled | boolean | enable Virtual Network Assistant, default is false (using SUB-VNA license) |
proxy_arp | string | default / enabled / disabled |
locate_unconnected | boolean | whether to locate unconnected clients, default is false |
mesh_enabled | boolean | whether to enable Mesh feature for the site, default is false |
mesh_allow_dfs | boolean | whether to allow Mesh to use DFS channels, default is false. For DFS channels, Remote Mesh AP would have to do CAC when scanning for new Base AP, which is slow and will distrupt the connection. If roaming is desired, keep it disabled. |
mesh_enable_crm | boolean | used to enable/disable CRM |
mesh_ssid | string | optional ssid of mesh networking, default is based on site_id |
mesh_psk | string | optional passphrase of mesh networking, default is generated randomly |
disable_11k | boolean | whether to disable 11k, default is false |
Remote Syslog Parameter
| Parameter | Type | Description |
|---|
| enabled | boolean | whether or not remote syslog is enabled |
| servers | list | list of syslog servers |
| host | string | host to which syslog is sent |
| protocol | string | udp / tcp, protocol to use for remote syslog, default is udp |
| port | int | port on which to connect to host for syslog, default is 514 if protocol=udp, 6514 if protocol=tcp |
| facility | string | kern / user / mail / daemon / auth / syslog / lpr / news / uucp / cron / authpriv / ftp / ntp / security / console / solaris-cron / local0 - local7, default is config |
| severity | string | emerg / alert / crit / err / warning / notice / info / debug, default is info |
| tag | string | optional, tag to attach to log record |
Rogue Detection Parameter
| Parameter | Type | Description |
|---|
| enabled | boolean | whether or not rogue detection is enabled |
| honeypot_enabled | boolean | whether or not honeypot detection is enabled |
| min_rssi | int | minimum RSSI for an AP to be considered rogue (ignoring APs that’s far away), default is -80. Minimum allowed value is -85. |
| min_duration | int | minimum duration for a bssid to be considered rogue, maximum is 59, default is 10 |
| whitelisted_ssids | list | list of SSIDs to whitelist |
| whitelisted_bssids | list | list of BSSIDs to whitelist |
Auto Upgrade Parameter
| Parameter | Type | Description |
|---|
| enabled | boolean | whether auto upgrade should happen, default is false (Note that Mist may auto-upgrade if the version is not supported) |
| version | string | desired version, beta / stable / custom, default is stable |
| timeofday | string | any / HH:MM (24-hour format), upgrade will happen within up to 1-hour from this time |
| dayofweek | string | any / mon / tue / wed / thu / fri / sat / sun |
| custom_versions | object | custome versions for different models |
Engagement Parameter
| Parameter | Type | Description |
|---|
| dwell_tags | object | add tags to visits within the duration (in seconds), available tags (passerby, bounce, engaged, stationed) |
| max_dwell | int | max time, default is 43200(12h), max is 68400 (18h) |
| min_dwell | int | min time, default is 0. |
| hours | object | hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun). Note: If the dow is not defined then it’s treated as 00:00-23:59. |
NOTE: if hours does not exist, it’s treated as everyday of the week, 00:00-23:59. Currently we don’t allow multiple ranges for the same day
NOTE: default values for dwell_tags: passerby (1,300) bounce (301, 14400) engaged (14401, 28800) stationed (28801, 42000)
NOTE: default values for dwelltagnames: passerby = “Passerby”, bounce = “Visitor”, engaged = “Associates”, stationed = “Assets”
WIDS Parameter
| Parameter | Type | Description |
|---|
| threshold | int | count of events to trigger |
| duration | int | window where a trigger will be detected and action to be taken (in seconds) |
Tunnel Parameter
| Parameter | Type | Description |
|---|
| hosts | list | hostnames or IPs where a Mist Tunnel will use as the Peer (i.e. they are reachable from AP) |
| ap_subnets | list | list of subnets where we allow AP to establish Mist Tunnels from |
| protocol | list | udp / ip, default is udp |
| vlan_ids | list | list of vlan ids/ranges that will be used |
| hello_interval | float | in 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 1 and 300, default is 60 seconds |
| hello_retries | int | between 2 and 30, default is 7 |
Switch Related
Some important / cmmmon properties describing the network topology are captured in the following sections.
-
networks defines local network segments (think VLAN) that will be used for the site
-
port_usages defines how physical ports can be used (access/trunk, networks, whether to do dot1x)
-
radius_config defines the RADIUS server configurations if dot1x is being used
-
switch_matching allows definitions of some rules to provision similar swithces with same settings (see Switch Config)
NOTE: names of networks or port_usages can only use a-z, 1-9, _, -, . and up to 32 characters
Port Usage
| Parameter | Type | Description |
|---|
| description | string | description |
| mode | string | access (default) / trunk |
| disabled | bool | whether the port is disabled, default is false |
| all_networks | bool | if mode=trunk, whether to trunk all network/vlans, default is false |
| networks | list | if mode=trunk, the list of network/vlans |
| port_network | string | native network/vlan for untagged traffic |
| stp_edge | string | when enabled, the port is not expected to receive BPDU frames |
| voip_network | string | network/vlan for voip traffic |
| port_auth | string | if dot1x is desired, set to dot1x |
| enablemacauth | bool | if port_auth=dot1x, whether to enable MAC Auth |
| guest_network | string | if port_auth=dot1x, which network to put the device into if the device cannot do dot1x. default is null (i.e. not allowed) |
| bypassauthwhenserverdown | bool | if port_auth=dot1x, whether to allow the device to connect if RADIUS server is down |
| speed | string | speed, default is auto to automatically negotiate speed |
| duplex | string | link connection mode, choices are auto (default), full, and half |
| mac_limit | int | max number of mac addresses, default is 0 for unlimited, otherwise range is 1 or higher, with upper bound constrained by platform |
| persist_mac | bool | if mode=access and port_auth!=dot1x, whether the port should retain dynamically learned MAC addresses, default is false |
| poe_disabled | bool | whether PoE capabilities are disabled for a port, default is false |
| storm_control | object | storm-control-profile settings |
| mtu | int | media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation. The default value is 1514. |
| enable_qos | bool | whether QoS is enabled, default is false. When QoS is enabled, the default QoS setting is applied. |
| allow_dhcpd | bool | whether DHCP server is allowed on the interfaces with. All the interfaces from. port configs using this port usage are effected. Please notice that allow_dhcpd is a tri-state. When it is not defined, it means using the system’s default setting which depends on whether the port is a access or trunk port |
Storm Control
| Parameter | Type | Description |
|---|
| percentage | int | bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth, default is 80 |
| no_broadcast | bool | whether to disable storm control on broadcast traffic, default is false |
| nounknownunicast | bool | whether to disable storm control on unknown unicast traffic, default is false |
| no_multicast | bool | whether to disable storm control on multicast traffic, default is false |
| noregisteredmulticast | bool | whether to disable storm control on registered multicast traffic, default is false |
Switch Matching (Draft)
In many scenarios, people have conventions like having port ge-0/0/0 as uplink, ge-0/0/5-42 for user devices, … for many switches in the same site. While it’s achievable by doing Switch Config on each of them, switch_matching allows them to use same setting by matching name/model/role.
| Parameter | Type | Description |
|---|
| lldpchassisid | string | MAC address of LLDP neighbor |
| lldpsystemname | string | system name of LLDP neighbor |
| lldpserialnumber | string | Serial number of LLDP neighbor |
| lldphardwarerevision | string | Hardware revision of LLDP neighbor |
| lldpmanufacturername | string | The manufacturer of LLDP neighbor |
| lldp_oui | string | The OUI of LLDP neighbor |
| radius_username | string | The username of the connected supplicant. |
| radius_usermac | string | The MAC address of the connected supplicant. |
| radius_dynamicfilter | string | User policy filter sent by the RADIUS server. |
| link_peermac | string | MAC address of the device directly connected to a port. |
OSPF Areas Parameters
| Parameter | Type | Description |
|---|
| osp_areas | object | OSPF areas, key is the area id |
| type | string | OSPF type, default (default) / stub / nssa |
| networks | object | networks to participate in an OSPF area, key is the network name |
| passive' | bool | whether to send OSPF-Hello, default is false |
| auth_type | string | auth type, none (default) / md5 / password |
| auth_keys | object | if auth_type==’md5’, the md5 keys |
| auth_password | string | if auth_type==’password’, the password, max length is 8 |
| interface_type | string | interface type, broadcast / nbma (non-broadcast multi-access) / p2p / p2mp, default is broadcast |
Auto Preemption Parameters
| Parameter | Type | Description |
|---|
| enabled | boolean | whether auto preemption should happen, default is false |
| timeofday | string | any / HH:MM (24-hour format) |
| dayofweek | string | any / mon / tue / wed / thu / fri / sat / sun |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
Accept | string | | |
X-CSRFToken | string | | |