meraki_ssid – Manage wireless SSIDs in the Meraki cloud

From Get docs
Ansible/docs/2.7/modules/meraki ssid module


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 of VLAN tags.

tags

-

List of AP tags.

vlan_id

-

Numerical identifier that is assigned to the VLAN.

auth_key

-

Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.

auth_mode

-

  • open
  • psk
  • open-with-radius
  • 8021x-meraki
  • 8021x-radius

Set authentication mode of network.

band_selection

-

  • Dual band operation
  • 5 GHz band only
  • Dual band operation with Band Steering

Set band selection mode.

concentrator_network_id

-

The concentrator to use for 'Layer 3 roaming with a concentrator' or 'VPN'.

default_vlan_id

-

Default VLAN ID.

enabled

boolean

  • no
  • yes

Enable or disable SSID network.

encryption_mode

-

  • wpa
  • eap
  • wpa-eap

Set encryption mode of network.

host

string

Default:

"api.meraki.com"

Hostname for Meraki dashboard

Only useful for internal Meraki developers

ip_assignment_mode

-

  • NAT mode
  • Bridge mode
  • Layer 3 roaming
  • Layer 3 roaming with a concentrator
  • VPN

Method of which SSID uses to assign IP addresses.

min_bitrate

-

  • 1
  • 2
  • 5.5
  • 6
  • 9
  • 11
  • 12
  • 18
  • 24
  • 36
  • 48
  • 54

Minimum bitrate (Mbps) allowed on SSID.

name

-

Name of SSID.

net_id

-

ID of network.

net_name

-

Name of network.

number

-

SSID number within network.


aliases: ssid_number

org_id

-

ID of organization.

org_name

-

Name of organization.


aliases: organization

output_level

-

  • normal

  • debug

Set amount of debug output during module execution

per_client_bandwidth_limit_down

-

Maximum bandwidth in Mbps devices on SSID can download.

per_client_bandwidth_limit_up

-

Maximum bandwidth in Mbps devices on SSID can upload.

psk

-

Password for wireless network.

Requires auth_mode to be set to psk.

radius_accounting_enabled

boolean

  • no
  • yes

Enable or disable RADIUS accounting.

radius_accounting_servers

-

List of RADIUS servers for RADIUS accounting.

host

-

IP address or hostname of RADIUS server.

port

-

Port number RADIUS server is listening to.

secret

-

RADIUS password.

radius_coa_enabled

boolean

  • no
  • yes

Enable or disable RADIUS CoA (Change of Authorization) on SSID.

radius_failover_policy

-

  • Deny access
  • Allow access

Set client access policy in case RADIUS servers aren't available.

radius_load_balancing_policy

-

  • Strict priority order
  • Round robin

Set load balancing policy when multiple RADIUS servers are specified.

radius_servers

-

List of RADIUS servers.

host

-

IP address or hostname of RADIUS server.

port

-

Port number RADIUS server is listening to.

secret

-

RADIUS password.

splash_page

-

  • None
  • Click-through splash page
  • Billing
  • Password-protected with Meraki RADIUS
  • Password-protected with custom RADIUS
  • Password-protected with Active Directory
  • Password-protected with LDAP
  • SMS authentication
  • Systems Manager Sentry
  • Facebook Wi-Fi
  • Google OAuth
  • Sponsored guest

Set to enable splash page and specify type of splash.

state

-

  • absent
  • query
  • present

Specifies whether SNMP information should be queried or modified.

timeout

integer

Default:

30

Time to timeout for HTTP requests.

use_https

boolean

  • no
  • yes

If no, it will use HTTP. Otherwise it will use HTTPS.

Only useful for internal Meraki developers

use_proxy

boolean

  • no
  • yes

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

use_vlan_tagging

boolean

  • no
  • yes

Set whether to use VLAN tagging.

validate_certs

boolean

  • no
  • yes

Whether to validate HTTP certificates.

vlan_id

-

ID number of VLAN on SSID.

walled_garden_enabled

boolean

  • no
  • yes

Enable or disable walled garden functionality.

walled_garden_ranges

-

List of walled garden ranges.

wpa_encryption_mode

-

  • WPA1 and WPA2
  • WPA2 only

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

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

Authors

  • Kevin Breit (@kbreit)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_ssid_module.html