Try SpotterConfigure hotspot profile in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of lix_fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and hs_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure hotspot profile.
fortios_wireless_controller_hotspot20_hs_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_hs_profile:
plmn_3gpp: "<your_own_value> (source wireless-controller.hotspot20.anqp-3gpp-cellular.name)"
access_network_asra: "enable"
access_network_esr: "enable"
access_network_internet: "enable"
access_network_type: "private-network"
access_network_uesa: "enable"
advice_of_charge: "<your_own_value> (source wireless-controller.hotspot20.h2qp-advice-of-charge.name)"
anqp_domain_id: "0"
bss_transition: "enable"
conn_cap: "<your_own_value> (source wireless-controller.hotspot20.h2qp-conn-capability.name)"
deauth_request_timeout: "60"
dgaf: "enable"
domain_name: "<your_own_value>"
gas_comeback_delay: "500"
gas_fragmentation_limit: "1024"
hessid: "<your_own_value>"
ip_addr_type: "<your_own_value> (source wireless-controller.hotspot20.anqp-ip-address-type.name)"
l2tif: "enable"
nai_realm: "<your_own_value> (source wireless-controller.hotspot20.anqp-nai-realm.name)"
name: "default_name_22"
network_auth: "<your_own_value> (source wireless-controller.hotspot20.anqp-network-auth-type.name)"
oper_friendly_name: "<your_own_value> (source wireless-controller.hotspot20.h2qp-operator-name.name)"
oper_icon: "<your_own_value> (source wireless-controller.hotspot20.icon.name)"
osu_provider:
-
name: "default_name_27 (source wireless-controller.hotspot20.h2qp-osu-provider.name)"
osu_provider_nai: "<your_own_value> (source wireless-controller.hotspot20.h2qp-osu-provider-nai.name)"
osu_ssid: "<your_own_value>"
pame_bi: "disable"
proxy_arp: "enable"
qos_map: "<your_own_value> (source wireless-controller.hotspot20.qos-map.name)"
release: "2"
roaming_consortium: "<your_own_value> (source wireless-controller.hotspot20.anqp-roaming-consortium.name)"
terms_and_conditions: "<your_own_value> (source wireless-controller.hotspot20.h2qp-terms-and-conditions.name)"
venue_group: "unspecified"
venue_name: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-name.name)"
venue_type: "unspecified"
venue_url: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-url.name)"
wan_metrics: "<your_own_value> (source wireless-controller.hotspot20.h2qp-wan-metric.name)"
wnm_sleep_mode: "enable"
vdom:
default: root
description:
- Virtual domain, among those defined previously. A vdom is a virtual instance of
the FortiGate that can be configured and used as a different unit.
type: str
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
wireless_controller_hotspot20_hs_profile:
default: null
description:
- Configure hotspot profile.
suboptions:
access_network_asra:
choices:
- enable
- disable
description:
- Enable/disable additional step required for access (ASRA).
type: str
access_network_esr:
choices:
- enable
- disable
description:
- Enable/disable emergency services reachable (ESR).
type: str
access_network_internet:
choices:
- enable
- disable
description:
- Enable/disable connectivity to the Internet.
type: str
access_network_type:
choices:
- private-network
- private-network-with-guest-access
- chargeable-public-network
- free-public-network
- personal-device-network
- emergency-services-only-network
- test-or-experimental
- wildcard
description:
- Access network type.
type: str
access_network_uesa:
choices:
- enable
- disable
description:
- Enable/disable unauthenticated emergency service accessible (UESA).
type: str
advice_of_charge:
description:
- Advice of charge. Source wireless-controller.hotspot20.h2qp-advice-of-charge.name.
type: str
anqp_domain_id:
description:
- ANQP Domain ID (0-65535).
type: int
bss_transition:
choices:
- enable
- disable
description:
- Enable/disable basic service set (BSS) transition Support.
type: str
conn_cap:
description:
- Connection capability name. Source wireless-controller.hotspot20.h2qp-conn-capability.name.
type: str
deauth_request_timeout:
description:
- Deauthentication request timeout (in seconds).
type: int
dgaf:
choices:
- enable
- disable
description:
- Enable/disable downstream group-addressed forwarding (DGAF).
type: str
domain_name:
description:
- Domain name.
type: str
gas_comeback_delay:
description:
- GAS comeback delay (0 or 100 - 10000 milliseconds).
type: int
gas_fragmentation_limit:
description:
- GAS fragmentation limit (512 - 4096).
type: int
hessid:
description:
- Homogeneous extended service set identifier (HESSID).
type: str
ip_addr_type:
description:
- IP address type name. Source wireless-controller.hotspot20.anqp-ip-address-type.name.
type: str
l2tif:
choices:
- enable
- disable
description:
- Enable/disable Layer 2 traffic inspection and filtering.
type: str
nai_realm:
description:
- NAI realm list name. Source wireless-controller.hotspot20.anqp-nai-realm.name.
type: str
name:
description:
- Hotspot profile name.
required: true
type: str
network_auth:
description:
- Network authentication name. Source wireless-controller.hotspot20.anqp-network-auth-type.name.
type: str
oper_friendly_name:
description:
- Operator friendly name. Source wireless-controller.hotspot20.h2qp-operator-name.name.
type: str
oper_icon:
description:
- Operator icon. Source wireless-controller.hotspot20.icon.name.
type: str
osu_provider:
description:
- Manually selected list of OSU provider(s).
elements: dict
suboptions:
name:
description:
- OSU provider name. Source wireless-controller.hotspot20.h2qp-osu-provider.name.
type: str
type: list
osu_provider_nai:
description:
- OSU Provider NAI. Source wireless-controller.hotspot20.h2qp-osu-provider-nai.name.
type: str
osu_ssid:
description:
- Online sign up (OSU) SSID.
type: str
pame_bi:
choices:
- disable
- enable
description:
- Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
type: str
plmn_3gpp:
description:
- 3GPP PLMN name. Source wireless-controller.hotspot20.anqp-3gpp-cellular.name.
type: str
proxy_arp:
choices:
- enable
- disable
description:
- Enable/disable Proxy ARP.
type: str
qos_map:
description:
- QoS MAP set ID. Source wireless-controller.hotspot20.qos-map.name.
type: str
release:
description:
- Hotspot 2.0 Release number (1, 2, 3).
type: int
roaming_consortium:
description:
- Roaming consortium list name. Source wireless-controller.hotspot20.anqp-roaming-consortium.name.
type: str
terms_and_conditions:
description:
- Terms and conditions. Source wireless-controller.hotspot20.h2qp-terms-and-conditions.name.
type: str
venue_group:
choices:
- unspecified
- assembly
- business
- educational
- factory
- institutional
- mercantile
- residential
- storage
- utility
- vehicular
- outdoor
description:
- Venue group.
type: str
venue_name:
description:
- Venue name. Source wireless-controller.hotspot20.anqp-venue-name.name.
type: str
venue_type:
choices:
- unspecified
- arena
- stadium
- passenger-terminal
- amphitheater
- amusement-park
- place-of-worship
- convention-center
- library
- museum
- restaurant
- theater
- bar
- coffee-shop
- zoo-or-aquarium
- emergency-center
- doctor-office
- bank
- fire-station
- police-station
- post-office
- professional-office
- research-facility
- attorney-office
- primary-school
- secondary-school
- university-or-college
- factory
- hospital
- long-term-care-facility
- rehab-center
- group-home
- prison-or-jail
- retail-store
- grocery-market
- auto-service-station
- shopping-mall
- gas-station
- private
- hotel-or-motel
- dormitory
- boarding-house
- automobile
- airplane
- bus
- ferry
- ship-or-boat
- train
- motor-bike
- muni-mesh-network
- city-park
- rest-area
- traffic-control
- bus-stop
- kiosk
description:
- Venue type.
type: str
venue_url:
description:
- Venue name. Source wireless-controller.hotspot20.anqp-venue-url.name.
type: str
wan_metrics:
description:
- WAN metric name. Source wireless-controller.hotspot20.h2qp-wan-metric.name.
type: str
wnm_sleep_mode:
choices:
- enable
- disable
description:
- Enable/disable wireless network management (WNM) sleep mode.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str