Skip to content

SSID Base Configuration

Dashboard Location: Wireless > Configure > SSIDs

Wireless SSID Management and Configuration

Section titled “Wireless SSID Management and Configuration”

SSID base configuration in Meraki wireless networks provides administrators with comprehensive wireless network service management, enabling authentication methods, encryption protocols, VLAN assignments, access control, bandwidth management, and network isolation. This functionality supports enterprise wireless security, guest access provisioning, device connectivity management, and network segmentation strategies. SSID configuration is essential for creating secure wireless services, implementing access policies, managing user authentication, and maintaining network performance across diverse client requirements and security zones.

Diagram

wireless (meraki.domains.organizations.networks)

Section titled “wireless (meraki.domains.organizations.networks)”
NameTypeConstraintMandatoryDefault Value
ssidsList[ssids]No

ssids (meraki.domains.organizations.networks.wireless)

Section titled “ssids (meraki.domains.organizations.networks.wireless)”
NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
enabledBooleantrue, falseNo
auth_modeChoice8021x-entra, 8021x-google, 8021x-localradius, 8021x-meraki, 8021x-nac, 8021x-radius, ipsk-with-nac, ipsk-with-radius, ipsk-with-radius-easy-psk, ipsk-without-radius, open, open-enhanced, open-with-nac, open-with-radius, pskNo
enterprise_admin_accessChoiceaccess disabled, access enabledNo
encryption_modeChoiceopen, wep, wpa, wpa-eapNo
pskStringmin: 1, max: 64No
wpa_encryption_modeChoiceWPA1 and WPA2, WPA1 only, WPA2 only, WPA3 192-bit Security, WPA3 Transition Mode, WPA3 onlyNo
dot11wClass[dot11w]No
dot11rClass[dot11r]No
splash_pageChoiceBilling, Cisco ISE, Click-through splash page, Facebook Wi-Fi, Google Apps domain, Google OAuth, Microsoft Entra ID, None, Password-protected with Active Directory, Password-protected with LDAP, Password-protected with Meraki RADIUS, Password-protected with custom RADIUS, SMS authentication, Sponsored guest, Systems Manager SentryNo
splash_guest_sponsor_domainsListString[min: 1, max: 127]No
ldapClass[ldap]No
active_directoryClass[active_directory]No
ip_assignment_modeChoiceNAT mode, Bridge mode, Layer 3 roaming, Ethernet over GRE, Layer 3 roaming with a concentrator, VPNNo
use_vlan_taggingBooleantrue, falseNo
disassociate_clients_on_vpn_failoverBooleantrue, falseNo
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
default_vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
ap_tags_and_vlan_idsList[ap_tags_and_vlan_ids]No
walled_garden_rangesListAny[String[min: 1, max: 255] or IP or String[match: ^(\d{1,3}\.){2}\d{1,3}(\/\d{1,2})$]]No
greClass[gre]No
min_bitrateChoice1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54No
band_selectionChoiceDual band operation, 5 GHz band only, Dual band operation with Band SteeringNo
per_client_bandwidth_limit_upIntegermin: 0, max: 1000000No
per_client_bandwidth_limit_downIntegermin: 0, max: 1000000No
per_ssid_bandwidth_limit_upIntegermin: 0, max: 1000000No
per_ssid_bandwidth_limit_downIntegermin: 0, max: 1000000No
visibleBooleantrue, falseNo
available_on_all_apsBooleantrue, falseNo
availability_tagsListString[min: 1, max: 255]No
dns_rewriteClass[dns_rewrite]No
speed_burstBooleantrue, falseNo
named_vlansClass[named_vlans]No
walled_gardenBooleantrue, falseNo
lan_isolationBooleantrue, falseNo
mandatory_dhcpBooleantrue, falseNo
adult_content_filteringBooleantrue, falseNo
concentrator_network_nameStringmin: 1, max: 127No
secondary_concentrator_network_nameStringmin: 1, max: 127No
ssid_numberChoice0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14No
oauth_allowed_domainsListString[min: 1, max: 127]No
bonjour_forwardingClass[bonjour_forwarding]No
device_type_group_policiesClass[device_type_group_policies]No
eap_overrideClass[eap_override]No
firewall_l3_firewall_rulesClass[firewall_l3_firewall_rules]No
firewall_l7_firewall_rulesList[firewall_l7_firewall_rules]No
hotspot20Class[hotspot20]No
identity_psksList[identity_psks]No
schedulesClass[schedules]No
splash_settingsClass[splash_settings]No
traffic_shaping_rulesClass[traffic_shaping_rules]No
vpnClass[vpn]No
radiusClass[radius]No

dot11w (meraki.domains.organizations.networks.wireless.ssids)

Section titled “dot11w (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
requiredBooleantrue, falseNo

dot11r (meraki.domains.organizations.networks.wireless.ssids)

Section titled “dot11r (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
adaptiveBooleantrue, falseNo

ldap (meraki.domains.organizations.networks.wireless.ssids)

Section titled “ldap (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
serversList[servers]No
credentialsClass[credentials]No
base_distinguished_nameStringmin: 1, max: 127No
server_ca_certificateStringmin: 1, max: 4096No

active_directory (meraki.domains.organizations.networks.wireless.ssids)

Section titled “active_directory (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
serversList[servers]No
credentialsClass[credentials]No

ap_tags_and_vlan_ids (meraki.domains.organizations.networks.wireless.ssids)

Section titled “ap_tags_and_vlan_ids (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
tagsListString[min: 1, max: 255]No
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2

gre (meraki.domains.organizations.networks.wireless.ssids)

Section titled “gre (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
concentratorAnyString[matches: ^(([a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])\.)+[a-zA-Z]{2,}$] or IPNo
keyIntegermin: 0, max: 4294967295No

dns_rewrite (meraki.domains.organizations.networks.wireless.ssids)

Section titled “dns_rewrite (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
dns_custom_nameserversListIPNo

named_vlans (meraki.domains.organizations.networks.wireless.ssids)

Section titled “named_vlans (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
taggingClass[tagging]No
radius_guest_vlanClass[radius_guest_vlan]No

bonjour_forwarding (meraki.domains.organizations.networks.wireless.ssids)

Section titled “bonjour_forwarding (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
rulesList[rules]No
exceptionBooleantrue, falseNo

device_type_group_policies (meraki.domains.organizations.networks.wireless.ssids)

Section titled “device_type_group_policies (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
device_type_policiesList[device_type_policies]No

eap_override (meraki.domains.organizations.networks.wireless.ssids)

Section titled “eap_override (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
timeoutIntegermin: 1, max: 600No
identityClass[identity]No
max_retriesIntegermin: 1, max: 5No
eapol_keyClass[eapol_key]No

firewall_l3_firewall_rules (meraki.domains.organizations.networks.wireless.ssids)

Section titled “firewall_l3_firewall_rules (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
rulesList[rules]No
allow_lan_accessBooleantrue, falseNo

firewall_l7_firewall_rules (meraki.domains.organizations.networks.wireless.ssids)

Section titled “firewall_l7_firewall_rules (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
policyChoicedenyNo
typeChoiceapplication, applicationCategory, host, ipRange, portNo
valueStringmin: 1, max: 127No

hotspot20 (meraki.domains.organizations.networks.wireless.ssids)

Section titled “hotspot20 (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
operatorStringmin: 1, max: 127No
venueClass[venue]No
network_access_typeChoiceChargeable public network, Emergency services only network, Free public network, Personal device network, Private network, Private network with guest access, Test or experimental, WildcardNo
domainsListString[min: 1, max: 127]No
roam_consort_oisListString[Regex: ^[0-9a-gA-G]{6,10}$]No
mcc_mncsList[mcc_mncs]No
nai_realmsList[nai_realms]No

identity_psks (meraki.domains.organizations.networks.wireless.ssids)

Section titled “identity_psks (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
passphraseStringmin: 1, max: 127No
expires_atStringmin: 1, max: 127No
group_policy_nameStringmin: 1, max: 127No

schedules (meraki.domains.organizations.networks.wireless.ssids)

Section titled “schedules (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
rangesList[ranges]No
ranges_in_secondsList[ranges_in_seconds]No

splash_settings (meraki.domains.organizations.networks.wireless.ssids)

Section titled “splash_settings (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
splash_urlStringmin: 1, max: 1024No
use_splash_urlBooleantrue, falseNo
splash_timeoutIntegermin: 1, max: 86400No
redirect_urlStringmin: 1, max: 1024No
use_redirect_urlBooleantrue, falseNo
welcome_messageStringmin: 1, max: 4096No
splash_logoClass[splash_logo]No
splash_imageClass[splash_image]No
splash_prepaid_frontClass[splash_prepaid_front]No
block_all_traffic_before_sign_onBooleantrue, falseNo
controller_disconnection_behaviorChoicedefault, open, restrictedNo
allow_simultaneous_loginsBooleantrue, falseNo
guest_sponsorshipClass[guest_sponsorship]No
billingClass[billing]No
sentry_enrollmentClass[sentry_enrollment]No
self_registrationClass[self_registration]No
theme_nameStringmin: 1, max: 127No

traffic_shaping_rules (meraki.domains.organizations.networks.wireless.ssids)

Section titled “traffic_shaping_rules (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
rulesList[rules]No
traffic_shapingBooleantrue, falseNo
default_rulesBooleantrue, falseNo

vpn (meraki.domains.organizations.networks.wireless.ssids)

Section titled “vpn (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
concentratorClass[concentrator]No
split_tunnelClass[split_tunnel]No
failoverClass[failover]No

radius (meraki.domains.organizations.networks.wireless.ssids)

Section titled “radius (meraki.domains.organizations.networks.wireless.ssids)”
NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
local_radiusClass[local_radius]No
serversList[servers]No
called_station_idStringmin: 1, max: 127No
authentication_nas_idStringmin: 1, max: 127No
server_timeoutIntegermin: 1, max: 10No
server_attempts_limitIntegermin: 1, max: 5No
radsec_tls_tunnel_timeoutIntegermin: 1, max: 32767No
failover_policyChoiceAllow access, Deny accessNo
load_balancing_policyChoiceRound robin, Strict priority orderNo
accounting_serversList[accounting_servers]No
accounting_interim_intervalIntegermin: 1, max: 360No
attribute_for_group_policiesChoiceAirespace-ACL-Name, Aruba-User-Role, Filter-Id, Reply-MessageNo
overrideBooleantrue, falseNo
guest_vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
proxyBooleantrue, falseNo
testingBooleantrue, falseNo
fallbackBooleantrue, falseNo
coaBooleantrue, falseNo
accountingBooleantrue, falseNo
guest_vlanBooleantrue, falseNo

servers (meraki.domains.organizations.networks.wireless.ssids.ldap)

Section titled “servers (meraki.domains.organizations.networks.wireless.ssids.ldap)”
NameTypeConstraintMandatoryDefault Value
hostStringmin: 1, max: 127Yes
portIntegermin: 0, max: 65535Yes

credentials (meraki.domains.organizations.networks.wireless.ssids.ldap)

Section titled “credentials (meraki.domains.organizations.networks.wireless.ssids.ldap)”
NameTypeConstraintMandatoryDefault Value
distinguished_nameStringmin: 1, max: 127No
passwordStringmin: 5, max: 64No

servers (meraki.domains.organizations.networks.wireless.ssids.active_directory)

Section titled “servers (meraki.domains.organizations.networks.wireless.ssids.active_directory)”
NameTypeConstraintMandatoryDefault Value
hostStringmin: 1, max: 127Yes
portIntegermin: 0, max: 65535No

credentials (meraki.domains.organizations.networks.wireless.ssids.active_directory)

Section titled “credentials (meraki.domains.organizations.networks.wireless.ssids.active_directory)”
NameTypeConstraintMandatoryDefault Value
logon_nameStringmin: 1, max: 127No
passwordStringmin: 5, max: 64No

tagging (meraki.domains.organizations.networks.wireless.ssids.named_vlans)

Section titled “tagging (meraki.domains.organizations.networks.wireless.ssids.named_vlans)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
default_vlan_nameStringmin: 1, max: 127No
by_ap_tagsList[by_ap_tags]No

radius_guest_vlan (meraki.domains.organizations.networks.wireless.ssids.named_vlans)

Section titled “radius_guest_vlan (meraki.domains.organizations.networks.wireless.ssids.named_vlans)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
nameStringmin: 1, max: 127No

rules (meraki.domains.organizations.networks.wireless.ssids.bonjour_forwarding)

Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.bonjour_forwarding)”
NameTypeConstraintMandatoryDefault Value
descriptionStringmin: 1, max: 1024No
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
servicesListChoice[AFP, AirPlay, All Services, Apple screen share, BitTorrent, Chromecast, FTP, Printers, SSH, Samba, Scanners, Spotify, iChat, iTunes]Yes

device_type_policies (meraki.domains.organizations.networks.wireless.ssids.device_type_group_policies)

Section titled “device_type_policies (meraki.domains.organizations.networks.wireless.ssids.device_type_group_policies)”
NameTypeConstraintMandatoryDefault Value
device_typeChoiceAndroid, B&N Nook, BlackBerry, Chrome OS, Mac OS X, Other OS, Windows, Windows Phone, iPad, iPhone, iPodYes
device_policyChoiceAllowed, Blocked, Group policyYes
group_policy_nameStringmin: 1, max: 127No

identity (meraki.domains.organizations.networks.wireless.ssids.eap_override)

Section titled “identity (meraki.domains.organizations.networks.wireless.ssids.eap_override)”
NameTypeConstraintMandatoryDefault Value
retriesIntegermin: 1, max: 5No
timeoutIntegermin: 1, max: 600No

eapol_key (meraki.domains.organizations.networks.wireless.ssids.eap_override)

Section titled “eapol_key (meraki.domains.organizations.networks.wireless.ssids.eap_override)”
NameTypeConstraintMandatoryDefault Value
retriesIntegermin: 1, max: 5No
timeout_in_msIntegermin: 1, max: 5000No

rules (meraki.domains.organizations.networks.wireless.ssids.firewall_l3_firewall_rules)

Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.firewall_l3_firewall_rules)”
NameTypeConstraintMandatoryDefault Value
commentStringmin: 1, max: 127No
policyChoiceallow, denyYes
protocolChoiceany, icmp, icmp6, tcp, udpYes
destination_portAnyInteger[min: 0, max: 65535] or String[matches: `(?:[1-9][0-9]3[1-5][0-9]46[0-4][0-9]3
destination_cidrStringRegex: ^(?i:any|(\d{1,3}\.){3}\d{1,3}(\/\d{1,2})?)(,(any|(\d{1,3}\.){3}\d{1,3}(\/\d{1,2})?))*$No
ip_versionChoiceany, ipv4, ipv6No

venue (meraki.domains.organizations.networks.wireless.ssids.hotspot20)

Section titled “venue (meraki.domains.organizations.networks.wireless.ssids.hotspot20)”
NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
typeChoiceAirplane, Alcohol and Drug Rehabilitation Center, Amphitheater, Amusement Park, Arena, Attorney Office, Automobile or Truck, Automotive Service Station, Bank, Bar, Boarding House, Bus, Bus Stop, City Park, Coffee Shop, Convention Center, Doctor or Dentist office, Dormitory, Emergency Coordination Center, Factory, Ferry, Fire Station, Gas Station, Grocery Market, Group Home, Hospital, Hotel or Motel, Kiosk, Library, Long-Term Care Facility, Motor Bike, Muni-mesh Network, Museum, Passenger Terminal, Place of Worship, Police Station, Post Office, Prison or Jail, Private Residence, Professional Office, Research and Development Facility, Rest Area, Restaurant, Retail Store, School, Primary, School, Secondary, Ship or Boat, Shopping Mall, Stadium, Theater, Traffic Control, Train, University or College, Unspecified, Unspecified Assembly, Unspecified Business, Unspecified Educational, Unspecified Factory and Industrial, Unspecified Institutional, Unspecified Mercantile, Unspecified Outdoor, Unspecified Residential, Unspecified Storage, Unspecified Utility and Miscellaneous, Unspecified Vehicular, Zoo or AquariumNo

mcc_mncs (meraki.domains.organizations.networks.wireless.ssids.hotspot20)

Section titled “mcc_mncs (meraki.domains.organizations.networks.wireless.ssids.hotspot20)”
NameTypeConstraintMandatoryDefault Value
mccStringmin: 1, max: 127No
mncStringmin: 1, max: 127No

nai_realms (meraki.domains.organizations.networks.wireless.ssids.hotspot20)

Section titled “nai_realms (meraki.domains.organizations.networks.wireless.ssids.hotspot20)”
NameTypeConstraintMandatoryDefault Value
formatChoice0, 1No
realmStringmin: 1, max: 127No
methodsList[methods]No

ranges (meraki.domains.organizations.networks.wireless.ssids.schedules)

Section titled “ranges (meraki.domains.organizations.networks.wireless.ssids.schedules)”
NameTypeConstraintMandatoryDefault Value
start_dayChoiceSunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayYes
start_timeStringRegex: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$Yes
end_dayChoiceSunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayYes
end_timeStringRegex: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$Yes

ranges_in_seconds (meraki.domains.organizations.networks.wireless.ssids.schedules)

Section titled “ranges_in_seconds (meraki.domains.organizations.networks.wireless.ssids.schedules)”
NameTypeConstraintMandatoryDefault Value
startIntegermin: 1, max: 604800Yes
endIntegermin: 1, max: 604800Yes

splash_logo (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “splash_logo (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
md5Stringmin: 1, max: 4096No
extensionStringmin: 1, max: 10No
imageClass[image]No

splash_image (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “splash_image (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
md5Stringmin: 1, max: 4096No
extensionStringmin: 1, max: 10No
imageClass[image]No

splash_prepaid_front (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “splash_prepaid_front (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
md5Stringmin: 1, max: 4096No
extensionStringmin: 1, max: 10No
imageClass[image]No

guest_sponsorship (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “guest_sponsorship (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
duration_in_minutesIntegermin: 1, max: 60480No
guest_can_request_timeframeBooleantrue, falseNo

billing (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “billing (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
free_accessClass[free_access]No
reply_to_email_addressStringmin: 1, max: 127No
prepaid_access_fast_loginBooleantrue, falseNo

sentry_enrollment (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “sentry_enrollment (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
systems_manager_networkStringmin: 1, max: 127No
strengthChoiceclick-through, focused, strictNo
enforced_systemsListChoice[iOS, Android, macOS, Windows]No

self_registration (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Section titled “self_registration (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
authorization_typeChoiceadmin, auto, self_emailNo

rules (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules)

Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules)”
NameTypeConstraintMandatoryDefault Value
definitionsList[definitions]Yes
per_client_bandwidth_limitsClass[per_client_bandwidth_limits]No
dscp_tag_valueIntegermin: 0, max: 63No
pcp_tag_valueIntegermin: 0, max: 7No

concentrator (meraki.domains.organizations.networks.wireless.ssids.vpn)

Section titled “concentrator (meraki.domains.organizations.networks.wireless.ssids.vpn)”
NameTypeConstraintMandatoryDefault Value
network_idStringmin: 1, max: 127No
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2

split_tunnel (meraki.domains.organizations.networks.wireless.ssids.vpn)

Section titled “split_tunnel (meraki.domains.organizations.networks.wireless.ssids.vpn)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
rulesList[rules]No

failover (meraki.domains.organizations.networks.wireless.ssids.vpn)

Section titled “failover (meraki.domains.organizations.networks.wireless.ssids.vpn)”
NameTypeConstraintMandatoryDefault Value
request_ipIPNo
heartbeat_intervalIntegermin: 1, max: 360No
idle_timeoutIntegermin: 1, max: 360No

local_radius (meraki.domains.organizations.networks.wireless.ssids.radius)

Section titled “local_radius (meraki.domains.organizations.networks.wireless.ssids.radius)”
NameTypeConstraintMandatoryDefault Value
cache_timeoutIntegermin: 1, max: 86400No
password_authenticationBooleantrue, falseNo
certificate_authenticationClass[certificate_authentication]No

servers (meraki.domains.organizations.networks.wireless.ssids.radius)

Section titled “servers (meraki.domains.organizations.networks.wireless.ssids.radius)”
NameTypeConstraintMandatoryDefault Value
hostStringmin: 1, max: 127Yes
portIntegermin: 0, max: 65535No
secretStringmin: 1, max: 127No
open_roaming_certificate_idIntegermin: 1, max: 65535No
ca_certificateStringmin: 1, max: 4096No
radsecBooleantrue, falseNo

accounting_servers (meraki.domains.organizations.networks.wireless.ssids.radius)

Section titled “accounting_servers (meraki.domains.organizations.networks.wireless.ssids.radius)”
NameTypeConstraintMandatoryDefault Value
hostStringmin: 1, max: 127Yes
portIntegermin: 0, max: 65535No
secretStringmin: 1, max: 127No
ca_certificateStringmin: 1, max: 4096No
radsecBooleantrue, falseNo

by_ap_tags (meraki.domains.organizations.networks.wireless.ssids.named_vlans.tagging)

Section titled “by_ap_tags (meraki.domains.organizations.networks.wireless.ssids.named_vlans.tagging)”
NameTypeConstraintMandatoryDefault Value
tagsListString[min: 1, max: 255]No
vlan_nameStringmin: 1, max: 127No

methods (meraki.domains.organizations.networks.wireless.ssids.hotspot20.nai_realms)

Section titled “methods (meraki.domains.organizations.networks.wireless.ssids.hotspot20.nai_realms)”
NameTypeConstraintMandatoryDefault Value
idStringmin: 1, max: 127No
authentication_typesClass[authentication_types]No

Section titled “image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_logo)”
NameTypeConstraintMandatoryDefault Value
formatChoicegif, jpg, pngNo
contentsStringmin: 1, max: 4096No

image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_image)

Section titled “image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_image)”
NameTypeConstraintMandatoryDefault Value
formatChoicegif, jpg, pngNo
contentsStringmin: 1, max: 4096No

image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_prepaid_front)

Section titled “image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_prepaid_front)”
NameTypeConstraintMandatoryDefault Value
formatChoicegif, jpg, pngNo
contentsStringmin: 1, max: 4096No

free_access (meraki.domains.organizations.networks.wireless.ssids.splash_settings.billing)

Section titled “free_access (meraki.domains.organizations.networks.wireless.ssids.splash_settings.billing)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
duration_in_minutesIntegermin: 1, max: 60480No

definitions (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules)

Section titled “definitions (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules)”
NameTypeConstraintMandatoryDefault Value
typeChoiceapplication, applicationCategory, host, ipRange, localNet, portYes
valueStringmin: 1, max: 127Yes

per_client_bandwidth_limits (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules)

Section titled “per_client_bandwidth_limits (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules)”
NameTypeConstraintMandatoryDefault Value
settingsChoicenetwork default, ignore, customNo
bandwidth_limitsClass[bandwidth_limits]No

rules (meraki.domains.organizations.networks.wireless.ssids.vpn.split_tunnel)

Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.vpn.split_tunnel)”
NameTypeConstraintMandatoryDefault Value
protocolChoiceAny, TCP, UDPNo
policyStringmin: 1, max: 127Yes
commentStringmin: 1, max: 127No
destination_cidrStringNo
destination_portAnyInteger[min: 0, max: 65535] or String[matches: `(?:[1-9][0-9]3[1-5][0-9]46[0-4][0-9]3

certificate_authentication (meraki.domains.organizations.networks.wireless.ssids.radius.local_radius)

Section titled “certificate_authentication (meraki.domains.organizations.networks.wireless.ssids.radius.local_radius)”
NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
use_ldapBooleantrue, falseNo
use_ocspBooleantrue, falseNo
ocsp_responder_urlStringmin: 1, max: 1024No
client_root_ca_certificateStringmin: 1, max: 4096No

authentication_types (meraki.domains.organizations.networks.wireless.ssids.hotspot20.nai_realms.methods)

Section titled “authentication_types (meraki.domains.organizations.networks.wireless.ssids.hotspot20.nai_realms.methods)”
NameTypeConstraintMandatoryDefault Value
non_eap_inner_authenticationChoiceReserved, PAP, CHAP, MSCHAP, MSCHAPV2No
eap_inner_authenticationChoiceEAP-TLS, EAP-SIM, EAP-AKA, EAP-TTLS with MSCHAPv2No
credentialsChoiceSIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, none, Reserved, Vendor SpecificNo
tunneled_eap_method_credentialsChoiceSIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, Reserved, Anonymous, Vendor SpecificNo

bandwidth_limits (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules.per_client_bandwidth_limits)

Section titled “bandwidth_limits (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules.per_client_bandwidth_limits)”
NameTypeConstraintMandatoryDefault Value
limit_upIntegermin: 0, max: 1000000No
limit_downIntegermin: 0, max: 1000000No

Example-1: The example below demonstrates wireless SSID base configuration using tested YAML configuration from pipeline fixtures.

meraki:
domains:
- name: "!env domain"
administrator:
name: "!env org_admin"
organizations:
- name: "!env org"
networks:
- name: "!env network_name"
product_types:
- appliance
- switch
- wireless
- camera
- sensor
- cellularGateway
wireless:
ssids:
- name: CORP
ssid_number: "0"
enabled: true
auth_mode: 8021x-radius
available_on_all_aps: true
default_vlan_id: 666
encryption_mode: wpa-eap
ip_assignment_mode: Bridge mode
lan_isolation: false
mandatory_dhcp: false
use_vlan_tagging: true
splash_page: None
speed_burst: false
visible: true
auth_mode: "psk"
psk: "!env guest_password"
encryption_mode: "wpa"
wpa_encryption_mode: "WPA2 only"
visible: true