cisco.meraki.networks_wireless_ssids_hotspot20 module – Resource module for networks _wireless _ssids _hotspot20
Note
This module is part of the cisco.meraki collection (version 2.18.3).
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_wireless_ssids_hotspot20.
New in cisco.meraki 2.16.0
Synopsis
Manage operation update of the resource networks _wireless _ssids _hotspot20.
Update the Hotspot 2.0 settings of an 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 |
|---|---|
An array of domain names. |
|
Whether or not Hotspot 2.0 for this SSID is enabled. Choices:
|
|
An array of MCC/MNC pairs. |
|
MCC value. |
|
MNC value. |
|
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_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER 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:
|
|
An array of NAI realms. |
|
The format for the realm (‘1’ or ‘0’). |
|
An array of EAP methods for the realm. |
|
The authentication types for the method. These should be formatted as an object with the EAP method category in camelcase as the key and the list of types as the value (nonEapInnerAuthentication Reserved, PAP, CHAP, MSCHAP, MSCHAPV2; eapInnerAuthentication EAP-TLS, EAP-SIM, EAP-AKA, EAP-TTLS with MSCHAPv2; credentials SIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, none, Reserved, Vendor Specific; tunneledEapMethodCredentials SIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, Reserved, Anonymous, Vendor Specific). |
|
ID of method. |
|
The name of the realm. |
|
The network type of this SSID (‘Private network’, ‘Private network with guest access’, ‘Chargeable public network’, ‘Free public network’, ‘Personal device network’, ‘Emergency services only network’, ‘Test or experimental’, ‘Wildcard’). |
|
NetworkId path parameter. Network ID. |
|
Number path parameter. |
|
Operator settings for this SSID. |
|
Operator name. |
|
An array of roaming consortium OIs (hexadecimal number 3-5 octets in length). |
|
Venue settings for this SSID. |
|
Venue name. |
|
Venue type (‘Unspecified’, ‘Unspecified Assembly’, ‘Arena’, ‘Stadium’, ‘Passenger Terminal’, ‘Amphitheater’, ‘Amusement Park’, ‘Place of Worship’, ‘Convention Center’, ‘Library’, ‘Museum’, ‘Restaurant’, ‘Theater’, ‘Bar’, ‘Coffee Shop’, ‘Zoo or Aquarium’, ‘Emergency Coordination Center’, ‘Unspecified Business’, ‘Doctor or Dentist office’, ‘Bank’, ‘Fire Station’, ‘Police Station’, ‘Post Office’, ‘Professional Office’, ‘Research and Development Facility’, ‘Attorney Office’, ‘Unspecified Educational’, ‘School, Primary’, ‘School, Secondary’, ‘University or College’, ‘Unspecified Factory and Industrial’, ‘Factory’, ‘Unspecified Institutional’, ‘Hospital’, ‘Long-Term Care Facility’, ‘Alcohol and Drug Rehabilitation Center’, ‘Group Home’, ‘Prison or Jail’, ‘Unspecified Mercantile’, ‘Retail Store’, ‘Grocery Market’, ‘Automotive Service Station’, ‘Shopping Mall’, ‘Gas Station’, ‘Unspecified Residential’, ‘Private Residence’, ‘Hotel or Motel’, ‘Dormitory’, ‘Boarding House’, ‘Unspecified Storage’, ‘Unspecified Utility and Miscellaneous’, ‘Unspecified Vehicular’, ‘Automobile or Truck’, ‘Airplane’, ‘Bus’, ‘Ferry’, ‘Ship or Boat’, ‘Train’, ‘Motor Bike’, ‘Unspecified Outdoor’, ‘Muni-mesh Network’, ‘City Park’, ‘Rest Area’, ‘Traffic Control’, ‘Bus Stop’, ‘Kiosk’). |
Notes
Note
SDK Method used are wireless.Wireless.update_network_wireless_ssid_hotspot20,
Paths used are put /networks/{networkId}/wireless/ssids/{number}/hotspot20,
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 DNAC 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 wireless updateNetworkWirelessSsidHotspot20
Complete reference of the updateNetworkWirelessSsidHotspot20 API.
Examples
- name: Update all
cisco.meraki.networks_wireless_ssids_hotspot20:
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
domains:
- meraki.local
- domain2.com
enabled: true
mccMncs:
- mcc: '123'
mnc: '456'
- mcc: '563'
mnc: '232'
naiRealms:
- format: '1'
methods:
- authenticationTypes:
credentials: []
eapInnerAuthentication:
- EAP-TTLS with MSCHAPv2
nonEapInnerAuthentication:
- MSCHAP
tunneledEapMethodCredentials: []
id: '1'
name: Realm 1
networkAccessType: Private network
networkId: string
number: string
operator:
name: Meraki Product Management
roamConsortOis:
- ABC123
- 456EFG
venue:
name: SF Branch
type: Unspecified Assembly
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: |