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
Section titled “Diagram”Classes
Section titled “Classes”wireless (meraki.domains.organizations.networks)
Section titled “wireless (meraki.domains.organizations.networks)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
ssids | List | [ssids] | No |
ssids (meraki.domains.organizations.networks.wireless)
Section titled “ssids (meraki.domains.organizations.networks.wireless)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
name | String | min: 1 , max: 127 | No | |
enabled | Boolean | true , false | No | |
auth_mode | Choice | 8021x-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 , psk | No | |
enterprise_admin_access | Choice | access disabled , access enabled | No | |
encryption_mode | Choice | open , wep , wpa , wpa-eap | No | |
psk | String | min: 1 , max: 64 | No | |
wpa_encryption_mode | Choice | WPA1 and WPA2 , WPA1 only , WPA2 only , WPA3 192-bit Security , WPA3 Transition Mode , WPA3 only | No | |
dot11w | Class | [dot11w] | No | |
dot11r | Class | [dot11r] | No | |
splash_page | Choice | Billing , 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 Sentry | No | |
splash_guest_sponsor_domains | List | String[min: 1 , max: 127 ] | No | |
ldap | Class | [ldap] | No | |
active_directory | Class | [active_directory] | No | |
ip_assignment_mode | Choice | NAT mode , Bridge mode , Layer 3 roaming , Ethernet over GRE , Layer 3 roaming with a concentrator , VPN | No | |
use_vlan_tagging | Boolean | true , false | No | |
disassociate_clients_on_vpn_failover | Boolean | true , false | No | |
vlan_id | Any | Integer[min: 1 , max: 4094 ] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
default_vlan_id | Any | Integer[min: 1 , max: 4094 ] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
ap_tags_and_vlan_ids | List | [ap_tags_and_vlan_ids] | No | |
walled_garden_ranges | List | Any[String[min: 1 , max: 255 ] or IP or String[match: ^(\d{1,3}\.){2}\d{1,3}(\/\d{1,2})$ ]] | No | |
gre | Class | [gre] | No | |
min_bitrate | Choice | 1 , 2 , 5.5 , 6 , 9 , 11 , 12 , 18 , 24 , 36 , 48 , 54 | No | |
band_selection | Choice | Dual band operation , 5 GHz band only , Dual band operation with Band Steering | No | |
per_client_bandwidth_limit_up | Integer | min: 0 , max: 1000000 | No | |
per_client_bandwidth_limit_down | Integer | min: 0 , max: 1000000 | No | |
per_ssid_bandwidth_limit_up | Integer | min: 0 , max: 1000000 | No | |
per_ssid_bandwidth_limit_down | Integer | min: 0 , max: 1000000 | No | |
visible | Boolean | true , false | No | |
available_on_all_aps | Boolean | true , false | No | |
availability_tags | List | String[min: 1 , max: 255 ] | No | |
dns_rewrite | Class | [dns_rewrite] | No | |
speed_burst | Boolean | true , false | No | |
named_vlans | Class | [named_vlans] | No | |
walled_garden | Boolean | true , false | No | |
lan_isolation | Boolean | true , false | No | |
mandatory_dhcp | Boolean | true , false | No | |
adult_content_filtering | Boolean | true , false | No | |
concentrator_network_name | String | min: 1 , max: 127 | No | |
secondary_concentrator_network_name | String | min: 1 , max: 127 | No | |
ssid_number | Choice | 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 | No | |
oauth_allowed_domains | List | String[min: 1 , max: 127 ] | No | |
bonjour_forwarding | Class | [bonjour_forwarding] | No | |
device_type_group_policies | Class | [device_type_group_policies] | No | |
eap_override | Class | [eap_override] | No | |
firewall_l3_firewall_rules | Class | [firewall_l3_firewall_rules] | No | |
firewall_l7_firewall_rules | List | [firewall_l7_firewall_rules] | No | |
hotspot20 | Class | [hotspot20] | No | |
identity_psks | List | [identity_psks] | No | |
schedules | Class | [schedules] | No | |
splash_settings | Class | [splash_settings] | No | |
traffic_shaping_rules | Class | [traffic_shaping_rules] | No | |
vpn | Class | [vpn] | No | |
radius | Class | [radius] | No |
dot11w (meraki.domains.organizations.networks.wireless.ssids)
Section titled “dot11w (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
required | Boolean | true , false | No |
dot11r (meraki.domains.organizations.networks.wireless.ssids)
Section titled “dot11r (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
adaptive | Boolean | true , false | No |
ldap (meraki.domains.organizations.networks.wireless.ssids)
Section titled “ldap (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
servers | List | [servers] | No | |
credentials | Class | [credentials] | No | |
base_distinguished_name | String | min: 1 , max: 127 | No | |
server_ca_certificate | String | min: 1 , max: 4096 | No |
active_directory (meraki.domains.organizations.networks.wireless.ssids)
Section titled “active_directory (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
servers | List | [servers] | No | |
credentials | Class | [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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
tags | List | String[min: 1 , max: 255 ] | No | |
vlan_id | Any | Integer[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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
concentrator | Any | String[matches: ^(([a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])\.)+[a-zA-Z]{2,}$ ] or IP | No | |
key | Integer | min: 0 , max: 4294967295 | No |
dns_rewrite (meraki.domains.organizations.networks.wireless.ssids)
Section titled “dns_rewrite (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
dns_custom_nameservers | List | IP | No |
named_vlans (meraki.domains.organizations.networks.wireless.ssids)
Section titled “named_vlans (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
tagging | Class | [tagging] | No | |
radius_guest_vlan | Class | [radius_guest_vlan] | No |
bonjour_forwarding (meraki.domains.organizations.networks.wireless.ssids)
Section titled “bonjour_forwarding (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
rules | List | [rules] | No | |
exception | Boolean | true , false | No |
device_type_group_policies (meraki.domains.organizations.networks.wireless.ssids)
Section titled “device_type_group_policies (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
device_type_policies | List | [device_type_policies] | No |
eap_override (meraki.domains.organizations.networks.wireless.ssids)
Section titled “eap_override (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
timeout | Integer | min: 1 , max: 600 | No | |
identity | Class | [identity] | No | |
max_retries | Integer | min: 1 , max: 5 | No | |
eapol_key | Class | [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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
rules | List | [rules] | No | |
allow_lan_access | Boolean | true , false | No |
firewall_l7_firewall_rules (meraki.domains.organizations.networks.wireless.ssids)
Section titled “firewall_l7_firewall_rules (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
policy | Choice | deny | No | |
type | Choice | application , applicationCategory , host , ipRange , port | No | |
value | String | min: 1 , max: 127 | No |
hotspot20 (meraki.domains.organizations.networks.wireless.ssids)
Section titled “hotspot20 (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
operator | String | min: 1 , max: 127 | No | |
venue | Class | [venue] | No | |
network_access_type | Choice | Chargeable public network , Emergency services only network , Free public network , Personal device network , Private network , Private network with guest access , Test or experimental , Wildcard | No | |
domains | List | String[min: 1 , max: 127 ] | No | |
roam_consort_ois | List | String[Regex: ^[0-9a-gA-G]{6,10}$ ] | No | |
mcc_mncs | List | [mcc_mncs] | No | |
nai_realms | List | [nai_realms] | No |
identity_psks (meraki.domains.organizations.networks.wireless.ssids)
Section titled “identity_psks (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
name | String | min: 1 , max: 127 | No | |
passphrase | String | min: 1 , max: 127 | No | |
expires_at | String | min: 1 , max: 127 | No | |
group_policy_name | String | min: 1 , max: 127 | No |
schedules (meraki.domains.organizations.networks.wireless.ssids)
Section titled “schedules (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
ranges | List | [ranges] | No | |
ranges_in_seconds | List | [ranges_in_seconds] | No |
splash_settings (meraki.domains.organizations.networks.wireless.ssids)
Section titled “splash_settings (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
splash_url | String | min: 1 , max: 1024 | No | |
use_splash_url | Boolean | true , false | No | |
splash_timeout | Integer | min: 1 , max: 86400 | No | |
redirect_url | String | min: 1 , max: 1024 | No | |
use_redirect_url | Boolean | true , false | No | |
welcome_message | String | min: 1 , max: 4096 | No | |
splash_logo | Class | [splash_logo] | No | |
splash_image | Class | [splash_image] | No | |
splash_prepaid_front | Class | [splash_prepaid_front] | No | |
block_all_traffic_before_sign_on | Boolean | true , false | No | |
controller_disconnection_behavior | Choice | default , open , restricted | No | |
allow_simultaneous_logins | Boolean | true , false | No | |
guest_sponsorship | Class | [guest_sponsorship] | No | |
billing | Class | [billing] | No | |
sentry_enrollment | Class | [sentry_enrollment] | No | |
self_registration | Class | [self_registration] | No | |
theme_name | String | min: 1 , max: 127 | No |
traffic_shaping_rules (meraki.domains.organizations.networks.wireless.ssids)
Section titled “traffic_shaping_rules (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
rules | List | [rules] | No | |
traffic_shaping | Boolean | true , false | No | |
default_rules | Boolean | true , false | No |
vpn (meraki.domains.organizations.networks.wireless.ssids)
Section titled “vpn (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
concentrator | Class | [concentrator] | No | |
split_tunnel | Class | [split_tunnel] | No | |
failover | Class | [failover] | No |
radius (meraki.domains.organizations.networks.wireless.ssids)
Section titled “radius (meraki.domains.organizations.networks.wireless.ssids)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
name | String | min: 1 , max: 127 | No | |
local_radius | Class | [local_radius] | No | |
servers | List | [servers] | No | |
called_station_id | String | min: 1 , max: 127 | No | |
authentication_nas_id | String | min: 1 , max: 127 | No | |
server_timeout | Integer | min: 1 , max: 10 | No | |
server_attempts_limit | Integer | min: 1 , max: 5 | No | |
radsec_tls_tunnel_timeout | Integer | min: 1 , max: 32767 | No | |
failover_policy | Choice | Allow access , Deny access | No | |
load_balancing_policy | Choice | Round robin , Strict priority order | No | |
accounting_servers | List | [accounting_servers] | No | |
accounting_interim_interval | Integer | min: 1 , max: 360 | No | |
attribute_for_group_policies | Choice | Airespace-ACL-Name , Aruba-User-Role , Filter-Id , Reply-Message | No | |
override | Boolean | true , false | No | |
guest_vlan_id | Any | Integer[min: 1 , max: 4094 ] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
proxy | Boolean | true , false | No | |
testing | Boolean | true , false | No | |
fallback | Boolean | true , false | No | |
coa | Boolean | true , false | No | |
accounting | Boolean | true , false | No | |
guest_vlan | Boolean | true , false | No |
servers (meraki.domains.organizations.networks.wireless.ssids.ldap)
Section titled “servers (meraki.domains.organizations.networks.wireless.ssids.ldap)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
host | String | min: 1 , max: 127 | Yes | |
port | Integer | min: 0 , max: 65535 | Yes |
credentials (meraki.domains.organizations.networks.wireless.ssids.ldap)
Section titled “credentials (meraki.domains.organizations.networks.wireless.ssids.ldap)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
distinguished_name | String | min: 1 , max: 127 | No | |
password | String | min: 5 , max: 64 | No |
servers (meraki.domains.organizations.networks.wireless.ssids.active_directory)
Section titled “servers (meraki.domains.organizations.networks.wireless.ssids.active_directory)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
host | String | min: 1 , max: 127 | Yes | |
port | Integer | min: 0 , max: 65535 | No |
credentials (meraki.domains.organizations.networks.wireless.ssids.active_directory)
Section titled “credentials (meraki.domains.organizations.networks.wireless.ssids.active_directory)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
logon_name | String | min: 1 , max: 127 | No | |
password | String | min: 5 , max: 64 | No |
tagging (meraki.domains.organizations.networks.wireless.ssids.named_vlans)
Section titled “tagging (meraki.domains.organizations.networks.wireless.ssids.named_vlans)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
default_vlan_name | String | min: 1 , max: 127 | No | |
by_ap_tags | List | [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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
name | String | min: 1 , max: 127 | No |
rules (meraki.domains.organizations.networks.wireless.ssids.bonjour_forwarding)
Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.bonjour_forwarding)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
description | String | min: 1 , max: 1024 | No | |
vlan_id | Any | Integer[min: 1 , max: 4094 ] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
services | List | Choice[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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
device_type | Choice | Android , B&N Nook , BlackBerry , Chrome OS , Mac OS X , Other OS , Windows , Windows Phone , iPad , iPhone , iPod | Yes | |
device_policy | Choice | Allowed , Blocked , Group policy | Yes | |
group_policy_name | String | min: 1 , max: 127 | No |
identity (meraki.domains.organizations.networks.wireless.ssids.eap_override)
Section titled “identity (meraki.domains.organizations.networks.wireless.ssids.eap_override)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
retries | Integer | min: 1 , max: 5 | No | |
timeout | Integer | min: 1 , max: 600 | No |
eapol_key (meraki.domains.organizations.networks.wireless.ssids.eap_override)
Section titled “eapol_key (meraki.domains.organizations.networks.wireless.ssids.eap_override)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
retries | Integer | min: 1 , max: 5 | No | |
timeout_in_ms | Integer | min: 1 , max: 5000 | No |
rules (meraki.domains.organizations.networks.wireless.ssids.firewall_l3_firewall_rules)
Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.firewall_l3_firewall_rules)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
comment | String | min: 1 , max: 127 | No | |
policy | Choice | allow , deny | Yes | |
protocol | Choice | any , icmp , icmp6 , tcp , udp | Yes | |
destination_port | Any | Integer[min: 0 , max: 65535 ] or String[matches: `(?:[1-9][0-9]3 | [1-5][0-9]4 | 6[0-4][0-9]3 |
destination_cidr | String | Regex: ^(?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_version | Choice | any , ipv4 , ipv6 | No |
venue (meraki.domains.organizations.networks.wireless.ssids.hotspot20)
Section titled “venue (meraki.domains.organizations.networks.wireless.ssids.hotspot20)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
name | String | min: 1 , max: 127 | No | |
type | Choice | Airplane , 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 Aquarium | No |
mcc_mncs (meraki.domains.organizations.networks.wireless.ssids.hotspot20)
Section titled “mcc_mncs (meraki.domains.organizations.networks.wireless.ssids.hotspot20)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
mcc | String | min: 1 , max: 127 | No | |
mnc | String | min: 1 , max: 127 | No |
nai_realms (meraki.domains.organizations.networks.wireless.ssids.hotspot20)
Section titled “nai_realms (meraki.domains.organizations.networks.wireless.ssids.hotspot20)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
format | Choice | 0 , 1 | No | |
realm | String | min: 1 , max: 127 | No | |
methods | List | [methods] | No |
ranges (meraki.domains.organizations.networks.wireless.ssids.schedules)
Section titled “ranges (meraki.domains.organizations.networks.wireless.ssids.schedules)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
start_day | Choice | Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday | Yes | |
start_time | String | Regex: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ | Yes | |
end_day | Choice | Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday | Yes | |
end_time | String | Regex: ^([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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
start | Integer | min: 1 , max: 604800 | Yes | |
end | Integer | min: 1 , max: 604800 | Yes |
splash_logo (meraki.domains.organizations.networks.wireless.ssids.splash_settings)
Section titled “splash_logo (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
md5 | String | min: 1 , max: 4096 | No | |
extension | String | min: 1 , max: 10 | No | |
image | Class | [image] | No |
splash_image (meraki.domains.organizations.networks.wireless.ssids.splash_settings)
Section titled “splash_image (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
md5 | String | min: 1 , max: 4096 | No | |
extension | String | min: 1 , max: 10 | No | |
image | Class | [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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
md5 | String | min: 1 , max: 4096 | No | |
extension | String | min: 1 , max: 10 | No | |
image | Class | [image] | No |
guest_sponsorship (meraki.domains.organizations.networks.wireless.ssids.splash_settings)
Section titled “guest_sponsorship (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
duration_in_minutes | Integer | min: 1 , max: 60480 | No | |
guest_can_request_timeframe | Boolean | true , false | No |
billing (meraki.domains.organizations.networks.wireless.ssids.splash_settings)
Section titled “billing (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
free_access | Class | [free_access] | No | |
reply_to_email_address | String | min: 1 , max: 127 | No | |
prepaid_access_fast_login | Boolean | true , false | No |
sentry_enrollment (meraki.domains.organizations.networks.wireless.ssids.splash_settings)
Section titled “sentry_enrollment (meraki.domains.organizations.networks.wireless.ssids.splash_settings)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
systems_manager_network | String | min: 1 , max: 127 | No | |
strength | Choice | click-through , focused , strict | No | |
enforced_systems | List | Choice[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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
authorization_type | Choice | admin , auto , self_email | No |
rules (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules)
Section titled “rules (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
definitions | List | [definitions] | Yes | |
per_client_bandwidth_limits | Class | [per_client_bandwidth_limits] | No | |
dscp_tag_value | Integer | min: 0 , max: 63 | No | |
pcp_tag_value | Integer | min: 0 , max: 7 | No |
concentrator (meraki.domains.organizations.networks.wireless.ssids.vpn)
Section titled “concentrator (meraki.domains.organizations.networks.wireless.ssids.vpn)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
network_id | String | min: 1 , max: 127 | No | |
vlan_id | Any | Integer[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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
rules | List | [rules] | No |
failover (meraki.domains.organizations.networks.wireless.ssids.vpn)
Section titled “failover (meraki.domains.organizations.networks.wireless.ssids.vpn)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
request_ip | IP | No | ||
heartbeat_interval | Integer | min: 1 , max: 360 | No | |
idle_timeout | Integer | min: 1 , max: 360 | No |
local_radius (meraki.domains.organizations.networks.wireless.ssids.radius)
Section titled “local_radius (meraki.domains.organizations.networks.wireless.ssids.radius)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
cache_timeout | Integer | min: 1 , max: 86400 | No | |
password_authentication | Boolean | true , false | No | |
certificate_authentication | Class | [certificate_authentication] | No |
servers (meraki.domains.organizations.networks.wireless.ssids.radius)
Section titled “servers (meraki.domains.organizations.networks.wireless.ssids.radius)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
host | String | min: 1 , max: 127 | Yes | |
port | Integer | min: 0 , max: 65535 | No | |
secret | String | min: 1 , max: 127 | No | |
open_roaming_certificate_id | Integer | min: 1 , max: 65535 | No | |
ca_certificate | String | min: 1 , max: 4096 | No | |
radsec | Boolean | true , false | No |
accounting_servers (meraki.domains.organizations.networks.wireless.ssids.radius)
Section titled “accounting_servers (meraki.domains.organizations.networks.wireless.ssids.radius)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
host | String | min: 1 , max: 127 | Yes | |
port | Integer | min: 0 , max: 65535 | No | |
secret | String | min: 1 , max: 127 | No | |
ca_certificate | String | min: 1 , max: 4096 | No | |
radsec | Boolean | true , false | No |
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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
tags | List | String[min: 1 , max: 255 ] | No | |
vlan_name | String | min: 1 , max: 127 | No |
methods (meraki.domains.organizations.networks.wireless.ssids.hotspot20.nai_realms)
Section titled “methods (meraki.domains.organizations.networks.wireless.ssids.hotspot20.nai_realms)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
id | String | min: 1 , max: 127 | No | |
authentication_types | Class | [authentication_types] | No |
image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_logo)
Section titled “image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_logo)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
format | Choice | gif , jpg , png | No | |
contents | String | min: 1 , max: 4096 | No |
image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_image)
Section titled “image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_image)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
format | Choice | gif , jpg , png | No | |
contents | String | min: 1 , max: 4096 | No |
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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
format | Choice | gif , jpg , png | No | |
contents | String | min: 1 , max: 4096 | No |
free_access (meraki.domains.organizations.networks.wireless.ssids.splash_settings.billing)
Section titled “free_access (meraki.domains.organizations.networks.wireless.ssids.splash_settings.billing)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
duration_in_minutes | Integer | min: 1 , max: 60480 | No |
definitions (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules)
Section titled “definitions (meraki.domains.organizations.networks.wireless.ssids.traffic_shaping_rules.rules)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
type | Choice | application , applicationCategory , host , ipRange , localNet , port | Yes | |
value | String | min: 1 , max: 127 | Yes |
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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
settings | Choice | network default , ignore , custom | No | |
bandwidth_limits | Class | [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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
protocol | Choice | Any , TCP , UDP | No | |
policy | String | min: 1 , max: 127 | Yes | |
comment | String | min: 1 , max: 127 | No | |
destination_cidr | String | No | ||
destination_port | Any | Integer[min: 0 , max: 65535 ] or String[matches: `(?:[1-9][0-9]3 | [1-5][0-9]4 | 6[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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
enabled | Boolean | true , false | No | |
use_ldap | Boolean | true , false | No | |
use_ocsp | Boolean | true , false | No | |
ocsp_responder_url | String | min: 1 , max: 1024 | No | |
client_root_ca_certificate | String | min: 1 , max: 4096 | No |
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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
non_eap_inner_authentication | Choice | Reserved , PAP , CHAP , MSCHAP , MSCHAPV2 | No | |
eap_inner_authentication | Choice | EAP-TLS , EAP-SIM , EAP-AKA , EAP-TTLS with MSCHAPv2 | No | |
credentials | Choice | SIM , USIM , NFC Secure Element , Hardware Token , Softoken , Certificate , username/password , none , Reserved , Vendor Specific | No | |
tunneled_eap_method_credentials | Choice | SIM , USIM , NFC Secure Element , Hardware Token , Softoken , Certificate , username/password , Reserved , Anonymous , Vendor Specific | No |
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)”Name | Type | Constraint | Mandatory | Default Value |
---|---|---|---|---|
limit_up | Integer | min: 0 , max: 1000000 | No | |
limit_down | Integer | min: 0 , max: 1000000 | No |
Examples
Section titled “Examples”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