ansible.builtin.fortios_wireless_controller_hotspot20_hs_profile (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

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
      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 - 4000 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
      osu_provider:
        description:
        - Manually selected list of OSU provider(s).
        suboptions:
          name:
            description:
            - OSU provider name. Source wireless-controller.hotspot20.h2qp-osu-provider.name.
            required: true
            type: str
        type: list
      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
      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
      roaming_consortium:
        description:
        - Roaming consortium list name. Source wireless-controller.hotspot20.anqp-roaming-consortium.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
      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

Outputs

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