updateOrgSettings
PUT https://{{host}}/api/v1/orgs/:org_id/setting
Body Parameters
Parameters
| Name | Type | Description |
|---|---|---|
name | string | org name |
password_policy | object | password policy |
enabled | boolean | whether the policy is enabled, default is false |
freshness | int | days, required if password policy is enabled |
min_length | int | required password length, default is 8 |
requires_special_char | boolean | whether to require special character, default is false |
requires_two_factor_auth | boolean | whether to require two-factor auth, default is false |
ui_idle_timeout | int | automatically logout the user when UI session is inactive, 0-480 in minutes, default is 0 (disabled) |
mgmt | object | management-related properties |
use_wxtunnel | boolean | whether to use wxtunnel for mgmt connectivity, default is false |
use_mxtunnel | boolean | whether to use Mist Tunnel for mgmt connectivity, default is false, this takes precedence over use_wxtunnel |
mxtunnel_ids | list | list of Mist Tunnels |
disable_pcap | boolean | whether to disallow Mist to analyze pcap files (this is required for marvis pcap), default is false |
max_pkt_len | int | max_len of non-management packets to capture, default is 128, maximum is 128 |
disable_local_ssh | boolean | whether to disable local SSH (by default, local SSH is enabled with allow_mist in Org is enabled |
limit_ssh_access | boolean | whether to allow certain SSH keys to SSH into the AP (see Site:Setting), default is false |
fips_zeroize_password | string | password required to zeroize devices (FIPS) on site level |
cacerts | list | list of PEM-encoded ca certs |
device_cert | object | common device cert, optional |
tags | list | list of tags |
remote_syslog | object | syslog parameters |
device_updown_threshold | 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 - 240, default is 0 (trigger immediate) |
ap_updown_threshold | int | enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and deviceupdownthreshold is ignored. |
gateway_updown_threshold | int | enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and deviceupdownthreshold is ignored. |
switch_updown_threshold | int | enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and deviceupdownthreshold is ignored. |
simple_alert | object | threshold setting for dhcp, dns, arp failure alerts. Alert generates if there are x (int) failures or y (int) clients failing within z (int) minutes per server, where 5<=z<=60. Defaults: dhcp_failure: {client_count: 10, incident_count: 20, duration: 10}, dns_failure: {client_count: 20 , incident_count: 30 , duration: 10}, arp_failure: {client_count: 10 , incident_count: 10 , duration: 20} |
ap_affinity_threshold | int | apaffinitythreshold can be added as a field under org/setting. By default this value is set to 12. If the field is set in both site/setting and org/setting, the value from site/setting will be used. |
host | string | ip / hostname of TACACS server |
port | int | port of TACACS server, default is 49 |
secret | string | secret of TACACS server |
timeout | int | TACACS timeout, default is 10, from 1 to 90 |
disable_remote_shell | boolean | whether to disable remote shell access for an entire org |
Automatic Site Assignment
Auto Site Assignment can be enabled to automatically assign APs to sites. Once enabled, when an AP in the Org inventory is seen online (e.g. freshly installed), we will try to use the criteria defined to identify the Site Name. Only when a non-empty Site Name is identified and the Site exists, the AP will be assigned to the site.
Automatic Device Naming
Automatic Device Naming works along with Automatic Site Assignment. When an AP that’s already assigned to a site that has no name, we will try to use the criteria defined to name the device. Only when a non-empty Name is identified and no AP with the same name exists in the same Site, the AP will be assigned the name.
Request Body
{"password_policy"=>{"enabled"=>true, "freshness"=>60, "min_length"=>8, "requires_special_char"=>false, "requires_two_factor_auth"=>true}, "ui_idle_timeout"=>10, "switch_mgmt"=>{"ap_affinity_threshold"=>10}, "mgmt"=>{"use_wxtunnel"=>false, "use_mxtunnel"=>true, "mxtunnel_ids"=>["08cd7499-5841-51c8-e663-fb16b6f3b45e"]}, "disable_remote_shell"=>false, "disable_pcap"=>false, "pcap"=>{"bucket"=>"myorg-pcap", "max_pkt_len"=>128}, "pcap_bucket_verified"=>true, "security"=>{"disable_local_ssh"=>false, "limit_ssh_access"=>false, "fips_zeroize_password"=>"NUKETHESITE"}, "api_policy"=>{"no_reveal"=>true}, "installer"=>{"grace_period"=>14, "extra_site_ids"=>["4ac1dcf4-9d8b-7211-65c4-057819f0862b", "52f4347e-3e4b-186c-21ca-ad5b70eb23d6"], "allow_all_sites"=>false, "allow_all_devices"=>false}, "wan_pma"=>{"enabled"=>false}, "wired_pma"=>{"enabled"=>false}, "wireless_pma"=>{"enabled"=>true}, "auto_site_assignment"=>{"enable"=>true, "rules"=>[{"src"=>"name", "expression"=>"[0:3]", "prefix"=>"XX-", "suffix"=>"-YY"}, {"src"=>"subnet", "subnet"=>"10.1.2.0/18", "value"=>"s1351"}, {"src"=>"lldp_system_name", "expression"=>"..."}, {"src"=>"dns_suffix", "expression"=>"..."}, {"src"=>"model", "model"=>"AP41", "value"=>"s1351"}, {"match_device_type"=>"ap", "match_model"=>"AP41"}]}, "auto_device_naming"=>{"enable"=>true, "rules"=>[{"src"=>"lldp_port_desc", "prefix"=>"MIST-", "suffix"=>"", "expression"=>"..."}, {"src"=>"mac", "prefix"=>"MIST-", "suffix"=>""}]}, "cloudshark"=>{"apitoken"=>"accbd6f10c6d05c3", "url"=>"https://cloudshark.hosted.domain"}, "cradlepoint"=>{"ecm_api_id"=>"73446d61-2206-4ea5-855a-0043f980be62", "ecm_api_key"=>"68b329da9893e34099c7d8ad5cb9c9405", "cp_api_id"=>"84446d61-2206-4ea5-855a-0043f980be54", "cp_api_key"=>"79c329da9893e34099c7d8ad5cb9c941"}, "celona"=>{"api_prefix"=>"cc3273fcb016470e", "api_key"=>"$2a$04$OkaLCoJn6rDjR8ha.oduQVDST3.kJNIrte"}, "auto_deviceprofile_assignment"=>{"enable"=>true}, "cacerts"=>["-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----", "-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----"], "device_cert"=>{"cert"=>"-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----", "key"=>"-----BEGIN PRI..."}, "tags"=>["beta"], "device_updown_threshold"=>0, "ap_updown_threshold"=>nil, "gateway_updown_threshold"=>10, "switch_updown_threshold"=>0, "mxedge_mgmt"=>{"mist_password"=>"MIST_PASSWORD", "root_password"=>"ROOT_PASSWORD", "fips_enabled"=>true, "oob_ip_type"=>"disabled", "oob_ip_type6"=>"disabled"}, "blacklist_url"=>"https://papi.s3.amazonaws.com/blacklist/xxx...", "mist_nac"=>{"eu_only"=>false, "use_ssl_port"=>true, "use_ip_version"=>"v4", "default_idp_id"=>"4c441a74-d0de-32c4-78a7-a05e00d080ae", "idps"=>[{"id"=>"4c441a74-d0de-32c4-78a7-a05e00d080ae", "user_realms"=>["abc"]}, {"id"=>"5c441a74-d0de-32c4-78a7-a05e00d080af", "user_realms"=>["*.edu"], "exclude_realms"=>["stanford.edu"]}], "cacerts"=>["-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----"], "server_cert"=>{"cert"=>"-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----", "key"=>"-----BEGIN PRI...", "password"=>"****"}, "eap_ssl_security_level"=>2, "disable_rsae_algorithms"=>false, "idp_user_cert_lookup_field"=>"automatic", "idp_machine_cert_lookup_field"=>"automatic"}, "gateway_mgmt"=>{"app_usage"=>true, "app_probing"=>{"apps"=>["facebook"]}, "overlay_ip"=>{"ip"=>"172.16.10.5", "node1_ip"=>"172.16.10.6"}, "host_out_policies"=>{"dns"=>{"path_preference"=>"dc_path"}, "mist"=>{"path_preference"=>"internet"}, "ntp"=>{"path_preference"=>"dc_path"}}}, "synthetic_test"=>{"disabled"=>false, "vlans"=>[{"vlan_ids"=>[10, 20], "custom_test_urls"=>["http://www.abc.com/", "https://10.3.5.1:8080/about"]}, {"vlan_ids"=>[30, 40], "disabled"=>true}], "wan_speedtest"=>{"enabled"=>false, "time_of_day"=>"02:00", "port_ids"=>["ge-0/0/0", "ge-0/0/1.3"]}}, "vpn_options"=>{"as_base"=>65000, "st_subnet"=>"10.224.0.0/12"}, "juniper"=>{"linked"=>true, "customer_name"=>"Corp NMO"}, "jcloud"=>{"org_id"=>"<jcloud_org_id>", "org_apitoken"=>"<jcloud_token>", "org_apitoken_name"=>"<jcloud_token_name>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
X-CSRFToken | string | ||
Content-Type | string |
RESPONSES
status: OK
{"password_policy":{"enabled":true,"freshness":60,"min_length":8,"requires_special_char":false,"requires_two_factor_auth":true},"ui_idle_timeout":10,"mgmt":{"use_wxtunnel":false,"use_mxtunnel":true,"mxtunnel_ids":["08cd7499-5841-51c8-e663-fb16b6f3b45e"]},"disable_pcap":false,"pcap":{"bucket":"myorg-pcap","max_pkt_len":128},"pcap_bucket_verified":true,"security":{"disable_local_ssh":false,"limit_ssh_access":false},"installer":{"grace_period":14,"extra_site_ids":["4ac1dcf4-9d8b-7211-65c4-057819f0862b","52f4347e-3e4b-186c-21ca-ad5b70eb23d6"],"allow_all_sites":false},"auto_site_assignment":{"enable":true,"rules":[{"src":"name","expression":"[0:3]","prefix":"XX-","suffix":"-YY"},{"src":"subnet","subnet":"10.1.2.0/18","value":"s1351"},{"src":"model","model":"AP41","value":"s1351"}]},"auto_device_naming":{"enable":true,"rules":[{"src":"lldp_port_desc","expression":"[0:3]"}]},"auto_deviceprofile_assignment":{"enable":false},"cacerts":["-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----","-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----"],"tags":["beta"]}