fortinet.fortimanager.fmgr_hotspot20_hsprofile module – Configure hotspot profile.

Note

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

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

string

Deprecated, please rename it to 3gpp_plmn. 3GPP PLMN name.

access-network-asra

string

Deprecated, please rename it to access_network_asra. Enable/disable additional step required for access

Choices:

  • "disable"

  • "enable"

access-network-esr

string

Deprecated, please rename it to access_network_esr. Enable/disable emergency services reachable

Choices:

  • "disable"

  • "enable"

access-network-internet

string

Deprecated, please rename it to access_network_internet. Enable/disable connectivity to the Internet.

Choices:

  • "disable"

  • "enable"

access-network-type

string

Deprecated, please rename it to access_network_type. 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

string

Deprecated, please rename it to access_network_uesa. Enable/disable unauthenticated emergency service accessible

Choices:

  • "disable"

  • "enable"

advice-of-charge

string

Deprecated, please rename it to advice_of_charge. Advice of charge.

anqp-domain-id

integer

Deprecated, please rename it to anqp_domain_id. ANQP Domain ID

bss-transition

string

Deprecated, please rename it to bss_transition. Enable/disable basic service set

Choices:

  • "disable"

  • "enable"

conn-cap

string

Deprecated, please rename it to conn_cap. Connection capability name.

deauth-request-timeout

integer

Deprecated, please rename it to deauth_request_timeout. Deauthentication request timeout

dgaf

string

Enable/disable downstream group-addressed forwarding

Choices:

  • "disable"

  • "enable"

domain-name

string

Deprecated, please rename it to domain_name. Domain name.

gas-comeback-delay

integer

Deprecated, please rename it to gas_comeback_delay. GAS comeback delay

gas-fragmentation-limit

integer

Deprecated, please rename it to gas_fragmentation_limit. GAS fragmentation limit

hessid

string

Homogeneous extended service set identifier

ip-addr-type

string

Deprecated, please rename it to ip_addr_type. IP address type name.

l2tif

string

Enable/disable Layer 2 traffic inspection and filtering.

Choices:

  • "disable"

  • "enable"

nai-realm

string

Deprecated, please rename it to nai_realm. NAI realm list name.

name

string / required

Hotspot profile name.

network-auth

string

Deprecated, please rename it to network_auth. Network authentication name.

oper-friendly-name

string

Deprecated, please rename it to oper_friendly_name. Operator friendly name.

oper-icon

string

Deprecated, please rename it to oper_icon. Operator icon.

osu-provider

any

(list or str) Deprecated, please rename it to osu_provider. Manually selected list of OSU provider

osu-provider-nai

string

Deprecated, please rename it to osu_provider_nai. OSU Provider NAI.

osu-ssid

string

Deprecated, please rename it to osu_ssid. Online sign up

pame-bi

string

Deprecated, please rename it to pame_bi. Enable/disable Pre-Association Message Exchange BSSID Independent

Choices:

  • "disable"

  • "enable"

proxy-arp

string

Deprecated, please rename it to proxy_arp. Enable/disable Proxy ARP.

Choices:

  • "disable"

  • "enable"

qos-map

string

Deprecated, please rename it to qos_map. QoS MAP set ID.

release

integer

Hotspot 2.

roaming-consortium

string

Deprecated, please rename it to roaming_consortium. Roaming consortium list name.

terms-and-conditions

string

Deprecated, please rename it to terms_and_conditions. Terms and conditions.

venue-group

string

Deprecated, please rename it to venue_group. Venue group.

Choices:

  • "unspecified"

  • "assembly"

  • "business"

  • "educational"

  • "factory"

  • "institutional"

  • "mercantile"

  • "residential"

  • "storage"

  • "utility"

  • "vehicular"

  • "outdoor"

venue-name

string

Deprecated, please rename it to venue_name. Venue name.

venue-type

string

Deprecated, please rename it to venue_type. 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

string

Deprecated, please rename it to venue_url. Venue name.

wan-metrics

string

Deprecated, please rename it to wan_metrics. WAN metric name.

wba-charging-currency

string

Deprecated, please rename it to wba_charging_currency. Three letter currency code.

wba-charging-rate

integer

Deprecated, please rename it to wba_charging_rate. Number of currency units per kilobyte.

wba-data-clearing-provider

string

Deprecated, please rename it to wba_data_clearing_provider. WBA ID of data clearing provider.

wba-financial-clearing-provider

string

Deprecated, please rename it to wba_financial_clearing_provider. WBA ID of financial clearing provider.

wba-open-roaming

string

Deprecated, please rename it to wba_open_roaming. Enable/disable WBA open roaming support.

Choices:

  • "disable"

  • "enable"

wnm-sleep-mode

string

Deprecated, please rename it to wnm_sleep_mode. 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)