Try SpotterResource module for networks _appliance _ssids
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operation update of the resource networks _appliance _ssids.
Update the attributes of an MX SSID.
- 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_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
psk:
description: The passkey for the SSID. This param is only valid if the authMode is
'psk'.
type: str
name:
description: The name of the SSID.
type: str
dot11w:
description: The current setting for Protected Management Frames (802.11w).
suboptions:
enabled:
description: Whether 802.11w is enabled or not.
type: bool
required:
description: (Optional) Whether 802.11w is required or not.
type: bool
type: dict
number:
description: Number path parameter.
type: str
enabled:
description: Whether or not the SSID is enabled.
type: bool
visible:
description: Boolean indicating whether the MX should advertise or hide this SSID.
type: bool
authMode:
description: The association control method for the SSID ('open', 'psk', '8021x-meraki'
or '8021x-radius').
type: str
networkId:
description: NetworkId path parameter. Network ID.
type: str
defaultVlanId:
description: The VLAN ID of the VLAN associated to this SSID. This parameter is only
valid if the network is in routed mode.
type: int
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
radiusServers:
description: The RADIUS 802.1x servers to be used for authentication. This param is
only valid if the authMode is '8021x-radius'.
elements: dict
suboptions:
host:
description: The IP address of your RADIUS server.
type: str
port:
description: The UDP port your RADIUS servers listens on for Access-requests.
type: int
secret:
description: The RADIUS client shared secret.
type: str
type: list
encryptionMode:
description: The psk encryption mode for the SSID ('wep' or 'wpa'). This param is
only valid if the authMode is 'psk'.
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
wpaEncryptionMode:
description: 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'.
type: str
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
dhcpEnforcedDeauthentication:
description: 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.
suboptions:
enabled:
description: Enable DCHP Enforced Deauthentication on the SSID.
type: bool
type: dict
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"authMode\": \"string\",\n \"defaultVlanId\": 0,\n \"enabled\"\
: true,\n \"encryptionMode\": \"string\",\n \"name\": \"string\",\n \"number\"\
: 0,\n \"radiusServers\": [\n {\n \"host\": \"string\",\n \"port\"\
: 0\n }\n ],\n \"visible\": true,\n \"wpaEncryptionMode\": \"string\"\n\
}\n"
type: dict