meraki_ssid – Manage wireless SSIDs in the Meraki cloud
meraki_ssid – Manage wireless SSIDs in the Meraki cloud
New in version 2.7.
Synopsis
- Allows for management of SSIDs in a Meraki wireless environment.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
ap_tags_vlan_ids list |
List of VLAN tags. | ||
tags list |
List of AP tags. | ||
vlan_id integer |
Numerical identifier that is assigned to the VLAN. | ||
auth_key string |
Authentication key provided by the dashboard. Required if environmental variable | ||
auth_mode string |
|
Set authentication mode of network. | |
band_selection string |
|
Set band selection mode. | |
concentrator_network_id string |
The concentrator to use for 'Layer 3 roaming with a concentrator' or 'VPN'. | ||
default_vlan_id string |
Default VLAN ID. | ||
enabled boolean |
|
Enable or disable SSID network. | |
encryption_mode string |
|
Set encryption mode of network. | |
host string |
Default: "api.meraki.com" |
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. | |
ip_assignment_mode string |
|
Method of which SSID uses to assign IP addresses. | |
min_bitrate float |
|
Minimum bitrate (Mbps) allowed on SSID. | |
name string |
Name of SSID. | ||
net_id string |
ID of network. | ||
net_name string |
Name of network. | ||
number integer |
SSID number within network.
| ||
org_id integer |
ID of organization. | ||
org_name string |
Name of organization.
| ||
output_level string |
|
Set amount of debug output during module execution. | |
per_client_bandwidth_limit_down integer |
Maximum bandwidth in Mbps devices on SSID can download. | ||
per_client_bandwidth_limit_up integer |
Maximum bandwidth in Mbps devices on SSID can upload. | ||
psk string |
Password for wireless network. Requires auth_mode to be set to psk. | ||
radius_accounting_enabled boolean |
|
Enable or disable RADIUS accounting. | |
radius_accounting_servers list |
List of RADIUS servers for RADIUS accounting. | ||
host string |
IP address or hostname of RADIUS server. | ||
port integer |
Port number RADIUS server is listening to. | ||
secret string |
RADIUS password. | ||
radius_coa_enabled boolean |
|
Enable or disable RADIUS CoA (Change of Authorization) on SSID. | |
radius_failover_policy string |
|
Set client access policy in case RADIUS servers aren't available. | |
radius_load_balancing_policy string |
|
Set load balancing policy when multiple RADIUS servers are specified. | |
radius_servers list |
List of RADIUS servers. | ||
host string |
IP address or hostname of RADIUS server. | ||
port integer |
Port number RADIUS server is listening to. | ||
secret string |
RADIUS password. | ||
splash_page string |
|
Set to enable splash page and specify type of splash. | |
state string |
|
Specifies whether SNMP information should be queried or modified. | |
timeout integer |
Default: 30 |
Time to timeout for HTTP requests. | |
use_https boolean |
|
If Only useful for internal Meraki developers. | |
use_proxy boolean |
|
If | |
use_vlan_tagging boolean |
|
Set whether to use VLAN tagging. | |
validate_certs boolean |
|
Whether to validate HTTP certificates. | |
vlan_id integer |
ID number of VLAN on SSID. | ||
walled_garden_enabled boolean |
|
Enable or disable walled garden functionality. | |
walled_garden_ranges list |
List of walled garden ranges. | ||
wpa_encryption_mode string |
|
Encryption mode within WPA2 specification. |
Notes
Note
- Deleting an SSID does not delete RADIUS servers.
- More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
- Some of the options are likely only used for developers within Meraki.
Examples
- name: Enable and name SSID
meraki_ssid:
auth_key: abc123
state: present
org_name: YourOrg
net_name: WiFi
name: GuestSSID
enabled: true
delegate_to: localhost
- name: Set PSK with invalid encryption mode
meraki_ssid:
auth_key: abc123
state: present
org_name: YourOrg
net_name: WiFi
name: GuestSSID
auth_mode: psk
psk: abc1234
encryption_mode: eap
ignore_errors: yes
delegate_to: localhost
- name: Configure RADIUS servers
meraki_ssid:
auth_key: abc123
state: present
org_name: YourOrg
net_name: WiFi
name: GuestSSID
auth_mode: open-with-radius
radius_servers:
- host: 192.0.1.200
port: 1234
secret: abc98765
delegate_to: localhost
- name: Enable click-through splash page
meraki_ssid:
auth_key: abc123
state: present
org_name: YourOrg
net_name: WiFi
name: GuestSSID
splash_page: Click-through splash page
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
data complex |
success |
List of wireless SSIDs.
| |
authMode string |
success |
Authentication method.
Sample: psk | |
bandSelection string |
success |
Wireless RF frequency wireless network will be broadcast on.
Sample: 5 GHz band only | |
enabled boolean |
success |
Enabled state of wireless network.
Sample: True | |
encryptionMode string |
success |
Wireless traffic encryption method.
Sample: wpa | |
ipAssignmentMode string |
success |
Wireless client IP assignment method.
Sample: NAT mode | |
minBitrate integer |
success |
Minimum bitrate a wireless client can connect at.
Sample: 11 | |
name string |
success |
Name of wireless SSID. This value is what is broadcasted.
Sample: CorpWireless | |
number integer |
success |
Zero-based index number for SSIDs.
| |
perClientBandwidthLimitDown integer |
success |
Maximum download bandwidth a client can use.
| |
perClientBandwidthLimitUp integer |
success |
Maximum upload bandwidth a client can use.
Sample: 1000 | |
psk string |
success |
Secret wireless password.
Sample: SecretWiFiPass | |
splashPage string |
success |
Splash page to show when user authenticates.
Sample: Click-through splash page | |
ssidAdminAccessible boolean |
success |
Whether SSID is administratively accessible.
Sample: True | |
wpaEncryptionMode string |
success |
Enabled WPA versions.
Sample: WPA2 only |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/meraki_ssid_module.html