fortinet.fortimanager.fmgr_hotspot20_hsprofile module – Configure hotspot profile.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_hotspot20_hsprofile.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

hotspot20_hsprofile

dictionary

The top level parameters set.

3gpp_plmn

aliases: 3gpp-plmn

string

3GPP PLMN name.

access_network_asra

aliases: access-network-asra

string

Enable/disable additional step required for access

Choices:

  • "disable"

  • "enable"

access_network_esr

aliases: access-network-esr

string

Enable/disable emergency services reachable

Choices:

  • "disable"

  • "enable"

access_network_internet

aliases: access-network-internet

string

Enable/disable connectivity to the Internet.

Choices:

  • "disable"

  • "enable"

access_network_type

aliases: access-network-type

string

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"

access_network_uesa

aliases: access-network-uesa

string

Enable/disable unauthenticated emergency service accessible

Choices:

  • "disable"

  • "enable"

advice_of_charge

aliases: advice-of-charge

string

Advice of charge.

anqp_domain_id

aliases: anqp-domain-id

integer

ANQP Domain ID

bss_transition

aliases: bss-transition

string

Enable/disable basic service set

Choices:

  • "disable"

  • "enable"

conn_cap

aliases: conn-cap

string

Connection capability name.

deauth_request_timeout

aliases: deauth-request-timeout

integer

Deauthentication request timeout

dgaf

string

Enable/disable downstream group-addressed forwarding

Choices:

  • "disable"

  • "enable"

domain_name

aliases: domain-name

string

Domain name.

gas_comeback_delay

aliases: gas-comeback-delay

integer

GAS comeback delay

gas_fragmentation_limit

aliases: gas-fragmentation-limit

integer

GAS fragmentation limit

hessid

string

Homogeneous extended service set identifier

ip_addr_type

aliases: ip-addr-type

string

IP address type name.

l2tif

string

Enable/disable Layer 2 traffic inspection and filtering.

Choices:

  • "disable"

  • "enable"

nai_realm

aliases: nai-realm

string

NAI realm list name.

name

string / required

Hotspot profile name.

network_auth

aliases: network-auth

string

Network authentication name.

oper_friendly_name

aliases: oper-friendly-name

string

Operator friendly name.

oper_icon

aliases: oper-icon

string

Operator icon.

osu_provider

aliases: osu-provider

any

(list or str) Manually selected list of OSU provider

osu_provider_nai

aliases: osu-provider-nai

string

OSU Provider NAI.

osu_ssid

aliases: osu-ssid

string

Online sign up

pame_bi

aliases: pame-bi

string

Enable/disable Pre-Association Message Exchange BSSID Independent

Choices:

  • "disable"

  • "enable"

proxy_arp

aliases: proxy-arp

string

Enable/disable Proxy ARP.

Choices:

  • "disable"

  • "enable"

qos_map

aliases: qos-map

string

QoS MAP set ID.

release

integer

Hotspot 2.

roaming_consortium

aliases: roaming-consortium

string

Roaming consortium list name.

terms_and_conditions

aliases: terms-and-conditions

string

Terms and conditions.

venue_group

aliases: venue-group

string

Venue group.

Choices:

  • "unspecified"

  • "assembly"

  • "business"

  • "educational"

  • "factory"

  • "institutional"

  • "mercantile"

  • "residential"

  • "storage"

  • "utility"

  • "vehicular"

  • "outdoor"

venue_name

aliases: venue-name

string

Venue name.

venue_type

aliases: venue-type

string

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"

venue_url

aliases: venue-url

string

Venue name.

wan_metrics

aliases: wan-metrics

string

WAN metric name.

wba_charging_currency

aliases: wba-charging-currency

string

Three letter currency code.

wba_charging_rate

aliases: wba-charging-rate

integer

Number of currency units per kilobyte.

wba_data_clearing_provider

aliases: wba-data-clearing-provider

string

WBA ID of data clearing provider.

wba_financial_clearing_provider

aliases: wba-financial-clearing-provider

string

WBA ID of financial clearing provider.

wba_open_roaming

aliases: wba-open-roaming

string

Enable/disable WBA open roaming support.

Choices:

  • "disable"

  • "enable"

wnm_sleep_mode

aliases: wnm-sleep-mode

string

Enable/disable wireless network management

Choices:

  • "disable"

  • "enable"

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure hotspot profile.
      fortinet.fortimanager.fmgr_hotspot20_hsprofile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_hsprofile:
          3gpp_plmn: <string>
          access_network_asra: <value in [disable, enable]>
          access_network_esr: <value in [disable, enable]>
          access_network_internet: <value in [disable, enable]>
          access_network_type: <value in [private-network, private-network-with-guest-access, chargeable-public-network, ...]>
          access_network_uesa: <value in [disable, enable]>
          anqp_domain_id: <integer>
          bss_transition: <value in [disable, enable]>
          conn_cap: <string>
          deauth_request_timeout: <integer>
          dgaf: <value in [disable, enable]>
          domain_name: <string>
          gas_comeback_delay: <integer>
          gas_fragmentation_limit: <integer>
          hessid: <string>
          ip_addr_type: <string>
          l2tif: <value in [disable, enable]>
          nai_realm: <string>
          name: <string>
          network_auth: <string>
          oper_friendly_name: <string>
          osu_provider: <list or string>
          osu_ssid: <string>
          pame_bi: <value in [disable, enable]>
          proxy_arp: <value in [disable, enable]>
          qos_map: <string>
          roaming_consortium: <string>
          venue_group: <value in [unspecified, assembly, business, ...]>
          venue_name: <string>
          venue_type: <value in [unspecified, arena, stadium, ...]>
          wan_metrics: <string>
          wnm_sleep_mode: <value in [disable, enable]>
          advice_of_charge: <string>
          oper_icon: <string>
          osu_provider_nai: <string>
          release: <integer>
          terms_and_conditions: <string>
          venue_url: <string>
          wba_charging_currency: <string>
          wba_charging_rate: <integer>
          wba_data_clearing_provider: <string>
          wba_financial_clearing_provider: <string>
          wba_open_roaming: <value in [disable, enable]>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)