.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.networks_wireless_ssids_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.networks_wireless_ssids module -- Resource module for networks \_wireless \_ssids ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection `_ (version 2.17.0). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.meraki.networks_wireless_ssids`. .. version_added .. rst-class:: ansible-version-added New in cisco.meraki 2.16.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource networks \_wireless \_ssids. - Update the attributes of an MR SSID. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.meraki.networks_wireless_ssids_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - meraki \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory: .. rst-class:: ansible-option-title **activeDirectory** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for Active Directory. Only valid if splashPage is 'Password-protected with Active Directory'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory/credentials: .. rst-class:: ansible-option-title **credentials** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
(Optional) The credentials of the user account to be used by the AP to bind to your Active Directory server. The Active Directory account should have permissions on all your Active Directory servers. Only valid if the splashPage is 'Password-protected with Active Directory'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory/credentials/logonname: .. rst-class:: ansible-option-title **logonName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The logon name of the Active Directory account. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory/credentials/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password to the Active Directory user account. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The Active Directory servers to be used for authentication. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory/servers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of your Active Directory server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-activedirectory/servers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
(Optional) UDP port the Active Directory server listens on. By default, uses port 3268. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-adultcontentfilteringenabled: .. rst-class:: ansible-option-title **adultContentFilteringEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean indicating whether or not adult content will be blocked. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-aptagsandvlanids: .. rst-class:: ansible-option-title **apTagsAndVlanIds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The list of tags and VLAN IDs used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-aptagsandvlanids/tags: .. rst-class:: ansible-option-title **tags** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Array of AP tags. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-aptagsandvlanids/vlanid: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Numerical identifier that is assigned to the VLAN. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-authmode: .. rst-class:: ansible-option-title **authMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The association control method for the SSID ('open', 'open-enhanced', 'psk', 'open-with-radius', 'open-with-nac', '8021x-meraki', '8021x-nac', '8021x-radius', '8021x-google', '8021x-localradius', 'ipsk-with-radius' or 'ipsk-without-radius'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-availabilitytags: .. rst-class:: ansible-option-title **availabilityTags** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-availableonallaps: .. rst-class:: ansible-option-title **availableOnAllAps** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean indicating whether all APs should broadcast the SSID or if it should be restricted to APs matching any availability tags. Can only be false if the SSID has availability tags. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-bandselection: .. rst-class:: ansible-option-title **bandSelection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The client-serving radio frequencies of this SSID in the default indoor RF profile. ('Dual band operation', '5 GHz band only' or 'Dual band operation with Band Steering'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-concentratornetworkid: .. rst-class:: ansible-option-title **concentratorNetworkId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The concentrator to use when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-defaultvlanid: .. rst-class:: ansible-option-title **defaultVlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The default VLAN ID used for 'all other APs'. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-disassociateclientsonvpnfailover: .. rst-class:: ansible-option-title **disassociateClientsOnVpnFailover** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Disassociate clients when 'VPN' concentrator failover occurs in order to trigger clients to re-associate and generate new DHCP requests. This param is only valid if ipAssignmentMode is 'VPN'. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dnsrewrite: .. rst-class:: ansible-option-title **dnsRewrite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
DNS servers rewrite settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dnsrewrite/dnscustomnameservers: .. rst-class:: ansible-option-title **dnsCustomNameservers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
User specified DNS servers (up to two servers). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dnsrewrite/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean indicating whether or not DNS server rewrite is enabled. If disabled, upstream DNS will be used. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dot11r: .. rst-class:: ansible-option-title **dot11r** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for 802.11r. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dot11r/adaptive: .. rst-class:: ansible-option-title **adaptive** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
(Optional) Whether 802.11r is adaptive or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dot11r/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether 802.11r is enabled or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dot11w: .. rst-class:: ansible-option-title **dot11w** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for Protected Management Frames (802.11w). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dot11w/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether 802.11w is enabled or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-dot11w/required: .. rst-class:: ansible-option-title **required** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
(Optional) Whether 802.11w is required or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not the SSID is enabled. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-encryptionmode: .. rst-class:: ansible-option-title **encryptionMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-enterpriseadminaccess: .. rst-class:: ansible-option-title **enterpriseAdminAccess** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-gre: .. rst-class:: ansible-option-title **gre** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ethernet over GRE settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-gre/concentrator: .. rst-class:: ansible-option-title **concentrator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The EoGRE concentrator's settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-gre/concentrator/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The EoGRE concentrator's IP or FQDN. This param is required when ipAssignmentMode is 'Ethernet over GRE'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-gre/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Optional numerical identifier that will add the GRE key field to the GRE header. Used to identify an individual traffic flow within a tunnel. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ipassignmentmode: .. rst-class:: ansible-option-title **ipAssignmentMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The client IP assignment mode ('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Ethernet over GRE', 'Layer 3 roaming with a concentrator' or 'VPN'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-lanisolationenabled: .. rst-class:: ansible-option-title **lanIsolationEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap: .. rst-class:: ansible-option-title **ldap** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for LDAP. Only valid if splashPage is 'Password-protected with LDAP'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/basedistinguishedname: .. rst-class:: ansible-option-title **baseDistinguishedName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The base distinguished name of users on the LDAP server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/credentials: .. rst-class:: ansible-option-title **credentials** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
(Optional) The credentials of the user account to be used by the AP to bind to your LDAP server. The LDAP account should have permissions on all your LDAP servers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/credentials/distinguishedname: .. rst-class:: ansible-option-title **distinguishedName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The distinguished name of the LDAP user account (example cn=user,dc=meraki,dc=com). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/credentials/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password of the LDAP user account. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/servercacertificate: .. rst-class:: ansible-option-title **serverCaCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The CA certificate used to sign the LDAP server's key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/servercacertificate/contents: .. rst-class:: ansible-option-title **contents** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The contents of the CA certificate. Must be in PEM or DER format. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The LDAP servers to be used for authentication. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/servers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of your LDAP server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-ldap/servers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
UDP port the LDAP server listens on. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius: .. rst-class:: ansible-option-title **localRadius** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for Local Authentication, a built-in RADIUS server on the access point. Only valid if authMode is '8021x-localradius'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/cachetimeout: .. rst-class:: ansible-option-title **cacheTimeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The duration (in seconds) for which LDAP and OCSP lookups are cached. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication: .. rst-class:: ansible-option-title **certificateAuthentication** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for certificate verification. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication/clientrootcacertificate: .. rst-class:: ansible-option-title **clientRootCaCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The Client CA Certificate used to sign the client certificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication/clientrootcacertificate/contents: .. rst-class:: ansible-option-title **contents** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The contents of the Client CA Certificate. Must be in PEM or DER format. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not to use EAP-TLS certificate-based authentication to validate wireless clients. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication/ocspresponderurl: .. rst-class:: ansible-option-title **ocspResponderUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
(Optional) The URL of the OCSP responder to verify client certificate status. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication/useldap: .. rst-class:: ansible-option-title **useLdap** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not to verify the certificate with LDAP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/certificateauthentication/useocsp: .. rst-class:: ansible-option-title **useOcsp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not to verify the certificate with OCSP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/passwordauthentication: .. rst-class:: ansible-option-title **passwordAuthentication** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The current setting for password-based authentication. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-localradius/passwordauthentication/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not to use EAP-TTLS/PAP or PEAP-GTC password-based authentication via LDAP lookup. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-mandatorydhcpenabled: .. rst-class:: ansible-option-title **mandatoryDhcpEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_action_batch_retry_wait_time: .. rst-class:: ansible-option-title **meraki_action_batch_retry_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_action\_batch\_retry\_wait\_time (integer), action batch concurrency error retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_api_key: .. rst-class:: ansible-option-title **meraki_api_key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
meraki\_api\_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI\_DASHBOARD\_API\_KEY .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_base_url: .. rst-class:: ansible-option-title **meraki_base_url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_base\_url (string), preceding all endpoint resources .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"https://api.meraki.com/api/v1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_be_geo_id: .. rst-class:: ansible-option-title **meraki_be_geo_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_be\_geo\_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE\_GEO\_ID .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_caller: .. rst-class:: ansible-option-title **meraki_caller** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI\_PYTHON\_SDK\_CALLER .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_certificate_path: .. rst-class:: ansible-option-title **meraki_certificate_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_certificate\_path (string), path for TLS/SSL certificate verification if behind local proxy .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_inherit_logging_config: .. rst-class:: ansible-option-title **meraki_inherit_logging_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_inherit\_logging\_config (boolean), Inherits your own logger instance .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_log_file_prefix: .. rst-class:: ansible-option-title **meraki_log_file_prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_log\_file\_prefix (string), log file name appended with date and timestamp .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"meraki\_api\_"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_log_path: .. rst-class:: ansible-option-title **meraki_log_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
log\_path (string), path to output log; by default, working directory of script if not specified .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_maximum_retries: .. rst-class:: ansible-option-title **meraki_maximum_retries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_maximum\_retries (integer), retry up to this many times when encountering 429s or other server-side errors .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_nginx_429_retry_wait_time: .. rst-class:: ansible-option-title **meraki_nginx_429_retry_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_nginx\_429\_retry\_wait\_time (integer), Nginx 429 retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_output_log: .. rst-class:: ansible-option-title **meraki_output_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_output\_log (boolean), create an output log file? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_print_console: .. rst-class:: ansible-option-title **meraki_print_console** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_print\_console (boolean), print logging output to console? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_requests_proxy: .. rst-class:: ansible-option-title **meraki_requests_proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_requests\_proxy (string), proxy server and port, if needed, for HTTPS .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_retry_4xx_error: .. rst-class:: ansible-option-title **meraki_retry_4xx_error** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_retry\_4xx\_error (boolean), retry if encountering other 4XX error (besides 429)? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_retry_4xx_error_wait_time: .. rst-class:: ansible-option-title **meraki_retry_4xx_error_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_retry\_4xx\_error\_wait\_time (integer), other 4XX error retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_simulate: .. rst-class:: ansible-option-title **meraki_simulate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_single_request_timeout: .. rst-class:: ansible-option-title **meraki_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_single\_request\_timeout (integer), maximum number of seconds for each API call .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_suppress_logging: .. rst-class:: ansible-option-title **meraki_suppress_logging** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_suppress\_logging (boolean), disable all logging? you're on your own then! .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_use_iterator_for_get_pages: .. rst-class:: ansible-option-title **meraki_use_iterator_for_get_pages** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_use\_iterator\_for\_get\_pages (boolean), list\* methods will return an iterator with each object instead of a complete list with all items .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-meraki_wait_on_rate_limit: .. rst-class:: ansible-option-title **meraki_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_wait\_on\_rate\_limit (boolean), retry if 429 rate limit error encountered? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-minbitrate: .. rst-class:: ansible-option-title **minBitrate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
The minimum bitrate in Mbps of this SSID in the default indoor RF profile. ('1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the SSID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-networkid: .. rst-class:: ansible-option-title **networkId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkId path parameter. Network ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-number: .. rst-class:: ansible-option-title **number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Number path parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-oauth: .. rst-class:: ansible-option-title **oauth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-oauth/alloweddomains: .. rst-class:: ansible-option-title **allowedDomains** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
(Optional) The list of domains allowed access to the network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-perclientbandwidthlimitdown: .. rst-class:: ansible-option-title **perClientBandwidthLimitDown** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The download bandwidth limit in Kbps. (0 represents no limit.). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-perclientbandwidthlimitup: .. rst-class:: ansible-option-title **perClientBandwidthLimitUp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The upload bandwidth limit in Kbps. (0 represents no limit.). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-perssidbandwidthlimitdown: .. rst-class:: ansible-option-title **perSsidBandwidthLimitDown** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The total download bandwidth limit in Kbps. (0 represents no limit.). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-perssidbandwidthlimitup: .. rst-class:: ansible-option-title **perSsidBandwidthLimitUp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The total upload bandwidth limit in Kbps. (0 represents no limit.). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-psk: .. rst-class:: ansible-option-title **psk** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The passkey for the SSID. This param is only valid if the authMode is 'psk'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingenabled: .. rst-class:: ansible-option-title **radiusAccountingEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountinginteriminterval: .. rst-class:: ansible-option-title **radiusAccountingInterimInterval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The interval (in seconds) in which accounting information is updated and sent to the RADIUS accounting server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingservers: .. rst-class:: ansible-option-title **radiusAccountingServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingservers/cacertificate: .. rst-class:: ansible-option-title **caCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate used for authorization for the RADSEC Server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingservers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address to which the APs will send RADIUS accounting messages. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingservers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port on the RADIUS server that is listening for accounting messages. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingservers/radsecenabled: .. rst-class:: ansible-option-title **radsecEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Use RADSEC (TLS over TCP) to connect to this RADIUS accounting server. Requires radiusProxyEnabled. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusaccountingservers/secret: .. rst-class:: ansible-option-title **secret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared key used to authenticate messages between the APs and RADIUS server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusattributeforgrouppolicies: .. rst-class:: ansible-option-title **radiusAttributeForGroupPolicies** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba-User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusauthenticationnasid: .. rst-class:: ansible-option-title **radiusAuthenticationNasId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The template of the NAS identifier to be used for RADIUS authentication (ex. $NODE\_MAC$ $VAP\_NUM$). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiuscalledstationid: .. rst-class:: ansible-option-title **radiusCalledStationId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The template of the called station identifier to be used for RADIUS (ex. $NODE\_MAC$ $VAP\_NUM$). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiuscoaenabled: .. rst-class:: ansible-option-title **radiusCoaEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusfailoverpolicy: .. rst-class:: ansible-option-title **radiusFailoverPolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusfallbackenabled: .. rst-class:: ansible-option-title **radiusFallbackEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not higher priority RADIUS servers should be retried after 60 seconds. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusguestvlanenabled: .. rst-class:: ansible-option-title **radiusGuestVlanEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not RADIUS Guest VLAN is enabled. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusguestvlanid: .. rst-class:: ansible-option-title **radiusGuestVlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID of the RADIUS Guest VLAN. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusloadbalancingpolicy: .. rst-class:: ansible-option-title **radiusLoadBalancingPolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusoverride: .. rst-class:: ansible-option-title **radiusOverride** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusproxyenabled: .. rst-class:: ansible-option-title **radiusProxyEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusserverattemptslimit: .. rst-class:: ansible-option-title **radiusServerAttemptsLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers: .. rst-class:: ansible-option-title **radiusServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers/cacertificate: .. rst-class:: ansible-option-title **caCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate used for authorization for the RADSEC Server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of your RADIUS server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers/openroamingcertificateid: .. rst-class:: ansible-option-title **openRoamingCertificateId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The ID of the Openroaming Certificate attached to radius server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
UDP port the RADIUS server listens on for Access-requests. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers/radsecenabled: .. rst-class:: ansible-option-title **radsecEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Use RADSEC (TLS over TCP) to connect to this RADIUS server. Requires radiusProxyEnabled. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservers/secret: .. rst-class:: ansible-option-title **secret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS client shared secret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiusservertimeout: .. rst-class:: ansible-option-title **radiusServerTimeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-radiustestingenabled: .. rst-class:: ansible-option-title **radiusTestingEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki\_8021x\_test' to ensure that the RADIUS servers are reachable. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-secondaryconcentratornetworkid: .. rst-class:: ansible-option-title **secondaryConcentratorNetworkId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The secondary concentrator to use when the ipAssignmentMode is 'VPN'. If configured, the APs will switch to using this concentrator if the primary concentrator is unreachable. This param is optional. ('disabled' represents no secondary concentrator.). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-speedburst: .. rst-class:: ansible-option-title **speedBurst** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The SpeedBurst setting for this SSID'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-speedburst/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean indicating whether or not to allow users to temporarily exceed the bandwidth limit for short periods while still keeping them under the bandwidth limit over time. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-splashguestsponsordomains: .. rst-class:: ansible-option-title **splashGuestSponsorDomains** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Array of valid sponsor email domains for sponsored guest splash type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-splashpage: .. rst-class:: ansible-option-title **splashPage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The type of splash page for the SSID ('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', 'Cisco ISE' or 'Google Apps domain'). This attribute is not supported for template children. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-usevlantagging: .. rst-class:: ansible-option-title **useVlanTagging** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-visible: .. rst-class:: ansible-option-title **visible** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean indicating whether APs should advertise or hide this SSID. APs will only broadcast this SSID if set to true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-vlanid: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The VLAN ID used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-walledgardenenabled: .. rst-class:: ansible-option-title **walledGardenEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allow access to a configurable list of IP ranges, which users may access prior to sign-on. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-walledgardenranges: .. rst-class:: ansible-option-title **walledGardenRanges** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Specify your walled garden by entering an array of addresses, ranges using CIDR notation, domain names, and domain wildcards (e.g. '192.168.1.1/24', '192.168.37.10/32', 'www.yahoo.com', '\*.google.com'). Meraki's splash page is automatically included in your walled garden. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__parameter-wpaencryptionmode: .. rst-class:: ansible-option-title **wpaEncryptionMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode', 'WPA3 only' or 'WPA3 192-bit Security'). .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.update\_network\_wireless\_ssid, - Paths used are put /networks/{networkId}/wireless/ssids/{number}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco Meraki documentation for wireless updateNetworkWirelessSsid `_ Complete reference of the updateNetworkWirelessSsid API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update by id cisco.meraki.networks_wireless_ssids: meraki_api_key: "{{meraki_api_key}}" meraki_base_url: "{{meraki_base_url}}" meraki_single_request_timeout: "{{meraki_single_request_timeout}}" meraki_certificate_path: "{{meraki_certificate_path}}" meraki_requests_proxy: "{{meraki_requests_proxy}}" meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}" meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}" meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}" meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}" meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}" meraki_maximum_retries: "{{meraki_maximum_retries}}" meraki_output_log: "{{meraki_output_log}}" meraki_log_file_prefix: "{{meraki_log_file_prefix}}" meraki_log_path: "{{meraki_log_path}}" meraki_print_console: "{{meraki_print_console}}" meraki_suppress_logging: "{{meraki_suppress_logging}}" meraki_simulate: "{{meraki_simulate}}" meraki_be_geo_id: "{{meraki_be_geo_id}}" meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}" meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}" state: present enabled: true name: My SSID networkId: string number: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_wireless_ssids_module__return-meraki_response: .. rst-class:: ansible-option-title **meraki_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Meraki Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Francisco Munoz (@fmunoz) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors