fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile module – Configure hotspot profile in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.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 fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile
.
New in fortinet.fortios 2.0.0
Synopsis
This 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
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
|
Configure hotspot profile. |
|
Enable/disable additional step required for access (ASRA). Choices:
|
|
Enable/disable emergency services reachable (ESR). Choices:
|
|
Enable/disable connectivity to the Internet. Choices:
|
|
Access network type. Choices:
|
|
Enable/disable unauthenticated emergency service accessible (UESA). Choices:
|
|
Advice of charge. Source wireless-controller.hotspot20.h2qp-advice-of-charge.name. |
|
ANQP Domain ID (0-65535). |
|
Enable/disable basic service set (BSS) transition Support. Choices:
|
|
Connection capability name. Source wireless-controller.hotspot20.h2qp-conn-capability.name. |
|
Deauthentication request timeout (in seconds). |
|
Enable/disable downstream group-addressed forwarding (DGAF). Choices:
|
|
Domain name. |
|
GAS comeback delay (0 or 100 - 10000 milliseconds). |
|
GAS fragmentation limit (512 - 4096). |
|
Homogeneous extended service set identifier (HESSID). |
|
IP address type name. Source wireless-controller.hotspot20.anqp-ip-address-type.name. |
|
Enable/disable Layer 2 traffic inspection and filtering. Choices:
|
|
NAI realm list name. Source wireless-controller.hotspot20.anqp-nai-realm.name. |
|
Hotspot profile name. |
|
Network authentication name. Source wireless-controller.hotspot20.anqp-network-auth-type.name. |
|
Operator friendly name. Source wireless-controller.hotspot20.h2qp-operator-name.name. |
|
Operator icon. Source wireless-controller.hotspot20.icon.name. |
|
Manually selected list of OSU provider(s). |
|
OSU provider name. Source wireless-controller.hotspot20.h2qp-osu-provider.name. |
|
OSU Provider NAI. Source wireless-controller.hotspot20.h2qp-osu-provider-nai.name. |
|
Online sign up (OSU) SSID. |
|
Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Choices:
|
|
3GPP PLMN name. Source wireless-controller.hotspot20.anqp-3gpp-cellular.name. |
|
Enable/disable Proxy ARP. Choices:
|
|
QoS MAP set ID. Source wireless-controller.hotspot20.qos-map.name. |
|
Hotspot 2.0 Release number (1, 2, 3). |
|
Roaming consortium list name. Source wireless-controller.hotspot20.anqp-roaming-consortium.name. |
|
Terms and conditions. Source wireless-controller.hotspot20.h2qp-terms-and-conditions.name. |
|
Venue group. Choices:
|
|
Venue name. Source wireless-controller.hotspot20.anqp-venue-name.name. |
|
Venue type. Choices:
|
|
Venue name. Source wireless-controller.hotspot20.anqp-venue-url.name. |
|
WAN metric name. Source wireless-controller.hotspot20.h2qp-wan-metric.name. |
|
Three letter currency code. |
|
Number of currency units per kilobyte. |
|
WBA ID of data clearing provider. |
|
WBA ID of financial clearing provider. |
|
Enable/disable WBA open roaming support. Choices:
|
|
Enable/disable wireless network management (WNM) sleep mode. Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure hotspot profile.
fortinet.fortios.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)"
wba_charging_currency: "<your_own_value>"
wba_charging_rate: "0"
wba_data_clearing_provider: "<your_own_value>"
wba_financial_clearing_provider: "<your_own_value>"
wba_open_roaming: "disable"
wnm_sleep_mode: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |