Try SpotterResource module for networks _wireless _ssids _hotspot20
| "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 _wireless _ssids _hotspot20.
Update the Hotspot 2.0 settings of an SSID.
- 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
venue:
description: Venue settings for this SSID.
suboptions:
name:
description: Venue name.
type: str
type:
description: 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').
type: str
type: dict
number:
description: Number path parameter.
type: str
domains:
description: An array of domain names.
elements: str
type: list
enabled:
description: Whether or not Hotspot 2.0 for this SSID is enabled.
type: bool
mccMncs:
description: An array of MCC/MNC pairs.
elements: dict
suboptions:
mcc:
description: MCC value.
type: str
mnc:
description: MNC value.
type: str
type: list
operator:
description: Operator settings for this SSID.
suboptions:
name:
description: Operator name.
type: str
type: dict
naiRealms:
description: An array of NAI realms.
elements: dict
suboptions:
format:
description: The format for the realm ('1' or '0').
type: str
methods:
description: An array of EAP methods for the realm.
elements: dict
suboptions:
authenticationTypes:
description: 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).
type: dict
id:
description: ID of method.
type: str
type: list
realm:
description: The name of the realm.
type: str
type: list
networkId:
description: NetworkId path parameter. Network ID.
type: str
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
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
roamConsortOis:
description: An array of roaming consortium OIs (hexadecimal number 3-5 octets in
length).
elements: str
type: list
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
networkAccessType:
description: 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').
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
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: '{}
'
type: dict