fortios_wireless_controller_hotspot20_hs_profile – Configure hotspot profile in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_wireless_controller_hotspot20_hs_profile | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_hotspot20_hs_profile - Configure hotspot profile. type: dict more...
- plmn_3gpp - 3GPP PLMN name. Source wireless-controller.hotspot20.anqp-3gpp-cellular.name. type: str more...
- access_network_asra - Enable/disable additional step required for access (ASRA). type: str choices: enable, disable more...
- access_network_esr - Enable/disable emergency services reachable (ESR). type: str choices: enable, disable more...
- access_network_internet - Enable/disable connectivity to the Internet. type: str choices: enable, disable more...
- access_network_type - Access network type. type: str 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 more...
- access_network_uesa - Enable/disable unauthenticated emergency service accessible (UESA). type: str choices: enable, disable more...
- advice_of_charge - Advice of charge. Source wireless-controller.hotspot20.h2qp-advice-of-charge.name. type: str more...
- anqp_domain_id - ANQP Domain ID (0-65535). type: int more...
- bss_transition - Enable/disable basic service set (BSS) transition Support. type: str choices: enable, disable more...
- conn_cap - Connection capability name. Source wireless-controller.hotspot20.h2qp-conn-capability.name. type: str more...
- deauth_request_timeout - Deauthentication request timeout (in seconds). type: int more...
- dgaf - Enable/disable downstream group-addressed forwarding (DGAF). type: str choices: enable, disable more...
- domain_name - Domain name. type: str more...
- gas_comeback_delay - GAS comeback delay (0 or 100 - 10000 milliseconds). type: int more...
- gas_fragmentation_limit - GAS fragmentation limit (512 - 4096). type: int more...
- hessid - Homogeneous extended service set identifier (HESSID). type: str more...
- ip_addr_type - IP address type name. Source wireless-controller.hotspot20.anqp-ip-address-type.name. type: str more...
- l2tif - Enable/disable Layer 2 traffic inspection and filtering. type: str choices: enable, disable more...
- nai_realm - NAI realm list name. Source wireless-controller.hotspot20.anqp-nai-realm.name. type: str more...
- name - Hotspot profile name. type: str required: true more...
- network_auth - Network authentication name. Source wireless-controller.hotspot20.anqp-network-auth-type.name. type: str more...
- oper_friendly_name - Operator friendly name. Source wireless-controller.hotspot20.h2qp-operator-name.name. type: str more...
- oper_icon - Operator icon. Source wireless-controller.hotspot20.icon.name. type: str more...
- osu_provider - Manually selected list of OSU provider(s). type: list member_path: osu_provider:name more...
- name - OSU provider name. Source wireless-controller.hotspot20.h2qp-osu-provider.name. type: str required: true more...
- osu_provider_nai - OSU Provider NAI. Source wireless-controller.hotspot20.h2qp-osu-provider-nai.name. type: str more...
- osu_ssid - Online sign up (OSU) SSID. type: str more...
- pame_bi - Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). type: str choices: disable, enable more...
- proxy_arp - Enable/disable Proxy ARP. type: str choices: enable, disable more...
- qos_map - QoS MAP set ID. Source wireless-controller.hotspot20.qos-map.name. type: str more...
- release - Hotspot 2.0 Release number (1, 2, 3). type: int more...
- roaming_consortium - Roaming consortium list name. Source wireless-controller.hotspot20.anqp-roaming-consortium.name. type: str more...
- terms_and_conditions - Terms and conditions. Source wireless-controller.hotspot20.h2qp-terms-and-conditions.name. type: str more...
- venue_group - Venue group. type: str choices: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor more...
- venue_name - Venue name. Source wireless-controller.hotspot20.anqp-venue-name.name. type: str more...
- venue_type - Venue type. type: str 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 more...
- venue_url - Venue name. Source wireless-controller.hotspot20.anqp-venue-url.name. type: str more...
- wan_metrics - WAN metric name. Source wireless-controller.hotspot20.h2qp-wan-metric.name. type: str more...
- wnm_sleep_mode - Enable/disable wireless network management (WNM) sleep mode. type: str choices: enable, disable more...
Examples¶
- 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"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3