Qodex.ai

getOrgSettings

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

Response Parameters

NameTypeDescription
namestringorg name
password_policyobjectpassword policy
enabledbooleanwhether the policy is enabled, default is false
freshnessintdays, required if password policy is enabled
min_lengthintrequired password length, default is 8
requires_special_charbooleanwhether to require special character, default is false
requires_two_factor_authbooleanwhether to require two-factor auth, default is false
ui_idle_timeoutintautomatically logout the user when UI session is inactive, 0-480 in minutes, default is 0 (disabled)
mgmtobjectmanagement-related properties
use_wxtunnelbooleanwhether to use wxtunnel for mgmt connectivity, default is false
use_mxtunnelbooleanwhether to use Mist Tunnel for mgmt connectivity, default is false, this takes precedence over use_wxtunnel
mxtunnel_idslistlist of Mist Tunnels
disable_pcapbooleanwhether to disallow Mist to analyze pcap files (this is required for marvis pcap), default is false
max_pkt_lenintmax_len of non-management packets to capture, default is 128, maximum is 128
disable_local_sshbooleanwhether to disable local SSH (by default, local SSH is enabled with allow_mist in Org is enabled
limit_ssh_accessbooleanwhether to allow certain SSH keys to SSH into the AP (see Site:Setting), default is false
fips_zeroize_passwordstringpassword required to zeroize devices (FIPS) on site level
cacertslistlist of PEM-encoded ca certs
device_certobjectcommon device cert, optional
tagslistlist of tags
remote_syslogobjectsyslog parameters
device_updown_thresholdintenable 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)
simple_alertobjectthreshold 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}

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.

RESPONSES

status: OK

&quot;{\n    \&quot;password_policy\&quot;: {\n        \&quot;enabled\&quot;: true,\n        \&quot;freshness\&quot;: 60,\n        \&quot;min_length\&quot;: 8,\n        \&quot;requires_special_char\&quot;: false,\n        \&quot;requires_two_factor_auth\&quot;: true\n    },\n    \&quot;ui_idle_timeout\&quot;: 10,\n\n    \&quot;mgmt\&quot;: {\n        \&quot;use_wxtunnel\&quot;: false,\n        \&quot;use_mxtunnel\&quot;: true,\n        \&quot;mxtunnel_ids\&quot;: [\&quot;08cd7499-5841-51c8-e663-fb16b6f3b45e\&quot;]\n    },\n\n    \&quot;disable_pcap\&quot;: false,\n    \&quot;pcap\&quot;: {\n        \&quot;bucket\&quot;: \&quot;myorg-pcap\&quot;,\n        \&quot;max_pkt_len\&quot;: 128\n    },\n    \&quot;pcap_bucket_verified\&quot;: true,\n\n    \&quot;security\&quot;: {\n        \&quot;disable_local_ssh\&quot;: false,\n        \&quot;limit_ssh_access\&quot;: false,\n        \&quot;fips_zeroize_password\&quot;: \&quot;NUKETHESITE\&quot;\n    },\n\n    \&quot;installer\&quot;: {\n        \&quot;grace_period\&quot;: 14, \n        \&quot;extra_site_ids\&quot;: [\n            \&quot;4ac1dcf4-9d8b-7211-65c4-057819f0862b\&quot;,\n            \&quot;52f4347e-3e4b-186c-21ca-ad5b70eb23d6\&quot;\n        ],\n        \&quot;allow_all_sites\&quot;: false,\n        \&quot;allow_all_devices\&quot;: false\n    },\n\n    \&quot;remote_syslog\&quot;: {\n        \&quot;enabled\&quot;: true,\n        \&quot;send_to_all_servers\&quot;: true,\n        \&quot;servers\&quot;: [\n            {\n                \&quot;host\&quot;: \&quot;syslogd.internal\&quot;,\n                \&quot;port\&quot;: 514,\n                \&quot;protocol\&quot;: \&quot;udp\&quot;,\n                \&quot;facility\&quot;: \&quot;config\&quot;,\n                \&quot;severity\&quot;: \&quot;info\&quot;,\n                \&quot;tag\&quot;: \&quot;\&quot;\n            }\n        ]\n    },\n\n    \&quot;auto_site_assignment\&quot;: {\n        \&quot;enable\&quot;: true,\n\n        \&quot;rules\&quot;: [\n            // use device name (via Installer APIs)\n            {\n                \&quot;src\&quot;: \&quot;name\&quot;,\n                \&quot;expression\&quot;: \&quot;[0:3]\&quot;,           // \&quot;abcdef\&quot; -\u003e \&quot;abc\&quot;\n                             // \&quot;split(.)[1]\&quot;,     // \&quot;a.b.c\&quot; -\u003e \&quot;b\&quot;\n                             // \&quot;split(-)[1][0:3], // \&quot;a1234-b5678-c90\&quot; -\u003e \&quot;b56\&quot;  \n                \&quot;prefix\&quot;: \&quot;XX-\&quot;,\n                \&quot;suffix\&quot;: \&quot;-YY\&quot;\n            },             \n            // use subnet\n            {\n                \&quot;src\&quot;: \&quot;subnet\&quot;,\n                \&quot;subnet\&quot;: \&quot;10.1.2.0/18\&quot;,\n                \&quot;value\&quot;: \&quot;s1351\&quot;\n            },\n            // use LLDP System Name\n            {\n                \&quot;src\&quot;: \&quot;lldp_system_name\&quot;,\n                \&quot;expression\&quot;: \&quot;...\&quot; // same as above\n            },\n            // use DNS Suffix\n            {\n                \&quot;src\&quot;: \&quot;dns_suffix\&quot;,\n                \&quot;expression\&quot;: \&quot;...\&quot; // same as above\n            },\n            {\n                \&quot;src\&quot;: \&quot;model\&quot;,\n                \&quot;model\&quot;: \&quot;AP41\&quot;,\n                \&quot;value\&quot;: \&quot;s1351\&quot;\n            },\n            {\n                // optional filters\n                \&quot;match_device_type\&quot;: \&quot;ap\&quot;,  // ap / switch / gateway / other, default is `ap`\n                \&quot;match_model\&quot;: \&quot;AP41\&quot;,\n                \&quot;...\&quot;:\&quot;...\&quot;\n            }\n        ]\n    },\n\n    \&quot;auto_device_naming\&quot;: {\n        \&quot;enable\&quot;: true,\n\n        \&quot;rules\&quot;: [\n            {\n                // use LLDP Port Description\n                \&quot;src\&quot;: \&quot;lldp_port_desc\&quot;,\n                \&quot;prefix\&quot;: \&quot;MIST-\&quot;,\n                \&quot;suffix\&quot;: \&quot;\&quot;,\n                \&quot;expression\&quot;: \&quot;...\&quot; // same as above\n            },\n            {\n                // use mac directly\n                \&quot;src\&quot;: \&quot;mac\&quot;,\n                \&quot;prefix\&quot;: \&quot;MIST-\&quot;,\n                \&quot;suffix\&quot;: \&quot;\&quot;\n            }\n        ]\n    },\n\n    \&quot;cloudshark\&quot;: {\n        \&quot;apitoken\&quot;: \&quot;accbd6f10c6d05c3\&quot;,\n\n        // if using CS Enteprise\n        \&quot;url\&quot;: \&quot;https://cloudshark.hosted.domain\&quot;\n    },\n\n    \&quot;auto_deviceprofile_assignment\&quot;: {\n        \&quot;enable\&quot;: true,\n\n        \&quot;rules\&quot;: [\n            // same rules definition that can be used for auto_site_assignment\n        ]\n    },\n\n\n    \&quot;cacerts\&quot;: [\n        \&quot;-----BEGIN CERTIFICATE-----\\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\\n-----END CERTIFICATE-----\&quot;,\n        \&quot;-----BEGIN CERTIFICATE-----\\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----\&quot;\n    ],\n    \&quot;device_cert\&quot;: {\n        \&quot;cert\&quot;: \&quot;-----BEGIN CERTIFICATE-----\\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\\n-----END CERTIFICATE-----\&quot;,\n        \&quot;key\&quot;: \&quot;-----BEGIN PRI...\&quot;\n    },\n    \&quot;tags\&quot;: [ \&quot;beta\&quot; ],\n    \&quot;device_updown_threshold\&quot;: 0,\n\n    \&quot;mxedge_mgmt\&quot;: {\n        \&quot;mist_password\&quot;: \&quot;MIST_PASSWORD\&quot;,\n        \&quot;root_password\&quot;: \&quot;ROOT_PASSWORD\&quot;,\n        \&quot;oob_autoconf6\&quot;: false, // unset defaults to true\n        \&quot;oob_dhcp6\&quot;: false, // unset defaults to true\n    },\n    \&quot;mxedge_fips_enabled\&quot;: true, // default is false\n\n\n    \&quot;blacklist_url\&quot;: \&quot;https://papi.s3.amazonaws.com/blacklist/xxx...\&quot;,\n\n    \&quot;mist_nac\&quot;: {\n        // use this IDP when no explicit realm present in the incoming\n        // username/CN OR when no IDP is explicitly mapped to the incoming realm.\n        \&quot;default_idp_id\&quot;: \&quot;4c441a74-d0de-32c4-78a7-a05e00d080ae\&quot;,\n\n        \&quot;idps\&quot;: [\n            {\n                \&quot;id\&quot;: \&quot;4c441a74-d0de-32c4-78a7-a05e00d080ae\&quot;,\n\n                // which realm should trigger this IDP\n                \&quot;user_realms\&quot;: [ \&quot;abc\&quot; ]\n\n                // we extract user realm from\n                // 1. Username-AVP (`mist.com` from john@mist.com)\n                // 2. Cert CN \n            }\n        ],\n        // the CA certs we use to verify client certs\n        \&quot;cacerts\&quot;: [\n            \&quot;-----BEGIN CERTIFICATE-----\\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\\n-----END CERTIFICATE-----\&quot;\n            \n        ],\n        // radius server cert to be presented in EAP TLS\n        \&quot;server_cert\&quot;: {\n            \&quot;cert\&quot;: \&quot;-----BEGIN CERTIFICATE-----\\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\\n-----END CERTIFICATE-----\&quot;,\n            \&quot;key\&quot;: \&quot;-----BEGIN PRI...\&quot;\n        }\n    },\n    \&quot;gateway_mgmt\&quot;: {\n         \&quot;app_usage\&quot;: true,\n         \&quot;app_probing\&quot;: {\n            \&quot;apps\&quot;: [\n               \&quot;facebook\&quot; // app-keys from /const/applications\n               ]\n         }\n    },\n\n    \&quot;juniper\&quot;: {\n        \&quot;linked\&quot;: true,\n        \&quot;customer_name\&quot;: \&quot;Corp NMO\&quot;\n    },\n\n    // a set of heuristic rules will be enabled when marvis subscription is not available\n    // it triggers when, in a Z minute window (5\u003c=Z\u003c=60), there are more than Y distinct client encountring over\n    // X failures\n    \&quot;simple_alert\&quot;: {\n        \&quot;dhcp_failure\&quot;: {\n            \&quot;client_count\&quot;: 10, // number of distinct clients having this failure, default is 10\n            \&quot;incident_count\&quot;: 20, // number of failures we&#39;ve seen, default is 10\n            \&quot;duration\&quot;: 10 // failing within minutes, default is 10\n        },\n        \&quot;dns_failure\&quot;: {\n            \&quot;client_count\&quot;: 20,\n            \&quot;incident_count\&quot;: 30,\n            \&quot;duration\&quot;: 10\n        },\n        \&quot;arp_failure\&quot;: {\n            \&quot;client_count\&quot;: 10,\n            \&quot;incident_count\&quot;: 10,\n            \&quot;duration\&quot;: 20\n        }\n    }\n}&quot;