cisco.meraki.networks_appliance_ssids module – Resource module for networks _appliance _ssids
Note
This module is part of the cisco.meraki collection (version 2.21.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.meraki.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.networks_appliance_ssids.
New in cisco.meraki 1.0.0
Synopsis
Manage operation update of the resource networks _appliance _ssids.
Update the attributes of an MX SSID.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The association control method for the SSID (‘open’, ‘psk’, ‘8021x-meraki’ or ‘8021x-radius’). |
|
The VLAN ID of the VLAN associated to this SSID. This parameter is only valid if the network is in routed mode. |
|
DHCP Enforced Deauthentication enables the disassociation of wireless clients in addition to Mandatory DHCP. This param is only valid on firmware versions >= MX 17.0 where the associated LAN has Mandatory DHCP Enabled. |
|
Enable DCHP Enforced Deauthentication on the SSID. Choices:
|
|
The current setting for Protected Management Frames (802.11w). |
|
Whether 802.11w is enabled or not. Choices:
|
|
(Optional) Whether 802.11w is required or not. Choices:
|
|
Whether or not the SSID is enabled. Choices:
|
|
The psk encryption mode for the SSID (‘wep’ or ‘wpa’). This param is only valid if the authMode is ‘psk’. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices:
|
|
meraki_log_file_prefix (string), log file name appended with date and timestamp Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
meraki_output_log (boolean), create an output log file? Choices:
|
|
meraki_print_console (boolean), print logging output to console? Choices:
|
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices:
|
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices:
|
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: |
|
meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices:
|
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices:
|
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices:
|
|
The name of the SSID. |
|
NetworkId path parameter. Network ID. |
|
Number path parameter. |
|
The passkey for the SSID. This param is only valid if the authMode is ‘psk’. |
|
The RADIUS 802.1x servers to be used for authentication. This param is only valid if the authMode is ‘8021x-radius’. |
|
The IP address of your RADIUS server. |
|
The UDP port your RADIUS servers listens on for Access-requests. |
|
The RADIUS client shared secret. |
|
Boolean indicating whether the MX should advertise or hide this SSID. Choices:
|
|
The types of WPA encryption. (‘WPA1 and WPA2’, ‘WPA2 only’, ‘WPA3 Transition Mode’ or ‘WPA3 only’). This param is only valid if (1) the authMode is ‘psk’ & the encryptionMode is ‘wpa’ OR (2) the authMode is ‘8021x-meraki’ OR (3) the authMode is ‘8021x-radius’. |
Notes
Note
SDK Method used are appliance.Appliance.update_network_appliance_ssid,
Paths used are put /networks/{networkId}/appliance/ssids/{number},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager
from Cisco Dashboard API Python(SDK)
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for appliance updateNetworkApplianceSsid
Complete reference of the updateNetworkApplianceSsid API.
Examples
- name: Update by id
cisco.meraki.networks_appliance_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_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
state: present
authMode: 8021x-radius
defaultVlanId: 1
dhcpEnforcedDeauthentication:
enabled: true
dot11w:
enabled: true
required: true
enabled: true
encryptionMode: wpa
name: My SSID
networkId: string
number: string
psk: psk
radiusServers:
- host: 0.0.0.0
port: 1000
secret: secret
visible: true
wpaEncryptionMode: WPA2 only
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: |