fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile – Configure hotspot profile in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile.

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
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.
wireless_controller_hotspot20_hs_profile
dictionary
Configure hotspot profile.
access_network_asra
string
    Choices:
  • enable
  • disable
Enable/disable additional step required for access (ASRA).
access_network_esr
string
    Choices:
  • enable
  • disable
Enable/disable emergency services reachable (ESR).
access_network_internet
string
    Choices:
  • enable
  • disable
Enable/disable connectivity to the Internet.
access_network_type
string
    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
Access network type.
access_network_uesa
string
    Choices:
  • enable
  • disable
Enable/disable unauthenticated emergency service accessible (UESA).
anqp_domain_id
integer
ANQP Domain ID (0-65535).
bss_transition
string
    Choices:
  • enable
  • disable
Enable/disable basic service set (BSS) transition Support.
conn_cap
string
Connection capability name. Source wireless-controller.hotspot20.h2qp-conn-capability.name.
deauth_request_timeout
integer
Deauthentication request timeout (in seconds).
dgaf
string
    Choices:
  • enable
  • disable
Enable/disable downstream group-addressed forwarding (DGAF).
domain_name
string
Domain name.
gas_comeback_delay
integer
GAS comeback delay (0 or 100 - 4000 milliseconds).
gas_fragmentation_limit
integer
GAS fragmentation limit (512 - 4096).
hessid
string
Homogeneous extended service set identifier (HESSID).
ip_addr_type
string
IP address type name. Source wireless-controller.hotspot20.anqp-ip-address-type.name.
l2tif
string
    Choices:
  • enable
  • disable
Enable/disable Layer 2 traffic inspection and filtering.
nai_realm
string
NAI realm list name. Source wireless-controller.hotspot20.anqp-nai-realm.name.
name
string / required
Hotspot profile name.
network_auth
string
Network authentication name. Source wireless-controller.hotspot20.anqp-network-auth-type.name.
oper_friendly_name
string
Operator friendly name. Source wireless-controller.hotspot20.h2qp-operator-name.name.
osu_provider
list / elements=string
Manually selected list of OSU provider(s).
name
string / required
OSU provider name. Source wireless-controller.hotspot20.h2qp-osu-provider.name.
osu_ssid
string
Online sign up (OSU) SSID.
pame_bi
string
    Choices:
  • disable
  • enable
Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
plmn_3gpp
string
3GPP PLMN name. Source wireless-controller.hotspot20.anqp-3gpp-cellular.name.
proxy_arp
string
    Choices:
  • enable
  • disable
Enable/disable Proxy ARP.
qos_map
string
QoS MAP set ID. Source wireless-controller.hotspot20.qos-map.name.
roaming_consortium
string
Roaming consortium list name. Source wireless-controller.hotspot20.anqp-roaming-consortium.name.
venue_group
string
    Choices:
  • unspecified
  • assembly
  • business
  • educational
  • factory
  • institutional
  • mercantile
  • residential
  • storage
  • utility
  • vehicular
  • outdoor
Venue group.
venue_name
string
Venue name. Source wireless-controller.hotspot20.anqp-venue-name.name.
venue_type
string
    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
Venue type.
wan_metrics
string
WAN metric name. Source wireless-controller.hotspot20.h2qp-wan-metric.name.
wnm_sleep_mode
string
    Choices:
  • enable
  • disable
Enable/disable wireless network management (WNM) sleep mode.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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"
        anqp_domain_id: "9"
        bss_transition: "enable"
        conn_cap: "<your_own_value> (source wireless-controller.hotspot20.h2qp-conn-capability.name)"
        deauth_request_timeout: "12"
        dgaf: "enable"
        domain_name: "<your_own_value>"
        gas_comeback_delay: "15"
        gas_fragmentation_limit: "16"
        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_21"
        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)"
        osu_provider:
         -
            name: "default_name_25 (source wireless-controller.hotspot20.h2qp-osu-provider.name)"
        osu_ssid: "<your_own_value>"
        pame_bi: "disable"
        proxy_arp: "enable"
        qos_map: "<your_own_value> (source wireless-controller.hotspot20.qos-map.name)"
        roaming_consortium: "<your_own_value> (source wireless-controller.hotspot20.anqp-roaming-consortium.name)"
        venue_group: "unspecified"
        venue_name: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-name.name)"
        venue_type: "unspecified"
        wan_metrics: "<your_own_value> (source wireless-controller.hotspot20.h2qp-wan-metric.name)"
        wnm_sleep_mode: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)