New in version 2.9.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
|   host    string    |    FortiOS or FortiGate IP address.   |  |||
|   https    boolean    |   
  |    Indicates if the requests towards FortiGate must use HTTPS protocol.   |  ||
|   password    string    |   Default: ""   |    FortiOS or FortiGate password.   |  ||
|   ssl_verify    boolean    |   
  |    Ensures FortiGate certificate must be verified by a proper CA.   |  ||
|   state    string / required    |   
  |    Indicates whether to create or remove the object.   |  ||
|   username    string    |    FortiOS or FortiGate username.   |  |||
|   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    |   Default: null   |    Configure hotspot profile.   |  ||
|   access_network_asra    string    |   
  |    Enable/disable additional step required for access (ASRA).   |  ||
|   access_network_esr    string    |   
  |    Enable/disable emergency services reachable (ESR).   |  ||
|   access_network_internet    string    |   
  |    Enable/disable connectivity to the Internet.   |  ||
|   access_network_type    string    |   
  |    Access network type.   |  ||
|   access_network_uesa    string    |   
  |    Enable/disable unauthenticated emergency service accessible (UESA).   |  ||
|   anqp_domain_id    integer    |    ANQP Domain ID (0-65535).   |  |||
|   bss_transition    string    |   
  |    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    |   
  |    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    |   
  |    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    |    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    |   
  |    Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).   |  ||
|   proxy_arp    string    |   
  |    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    |   
  |    Venue group.   |  ||
|   venue_name    string    |    Venue name. Source wireless-controller.hotspot20.anqp-venue-name.name.   |  |||
|   venue_type    string    |   
  |    Venue type.   |  ||
|   wan_metrics    string    |    WAN metric name. Source wireless-controller.hotspot20.h2qp-wan-metric.name.   |  |||
|   wnm_sleep_mode    string    |   
  |    Enable/disable wireless network management (WNM) sleep mode.   |  ||
Note
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure hotspot profile.
    fortios_wireless_controller_hotspot20_hs_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      wireless_controller_hotspot20_hs_profile:
        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"
   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   |  
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.9/modules/fortios_wireless_controller_hotspot20_hs_profile_module.html