fortinet.fortimanager.fmgr_hotspot20_hsprofile module – Configure hotspot profile.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
3GPP PLMN name. |
|
Enable/disable additional step required for access Choices:
|
|
Enable/disable emergency services reachable Choices:
|
|
Enable/disable connectivity to the Internet. Choices:
|
|
Access network type. Choices:
|
|
Enable/disable unauthenticated emergency service accessible Choices:
|
|
Advice of charge. |
|
ANQP Domain ID |
|
Enable/disable basic service set Choices:
|
|
Connection capability name. |
|
Deauthentication request timeout |
|
Enable/disable downstream group-addressed forwarding Choices:
|
|
Domain name. |
|
GAS comeback delay |
|
GAS fragmentation limit |
|
Homogeneous extended service set identifier |
|
IP address type name. |
|
Enable/disable Layer 2 traffic inspection and filtering. Choices:
|
|
NAI realm list name. |
|
Hotspot profile name. |
|
Network authentication name. |
|
Operator friendly name. |
|
Operator icon. |
|
(list or str) Manually selected list of OSU provider |
|
OSU Provider NAI. |
|
Online sign up |
|
Enable/disable Pre-Association Message Exchange BSSID Independent Choices:
|
|
Enable/disable Proxy ARP. Choices:
|
|
QoS MAP set ID. |
|
Hotspot 2. |
|
Roaming consortium list name. |
|
Terms and conditions. |
|
Venue group. Choices:
|
|
Venue name. |
|
Venue type. Choices:
|
|
Venue name. |
|
WAN metric name. |
|
Three letter currency code. |
|
Number of currency units per kilobyte. |
|
WBA ID of data clearing provider. |
|
WBA ID of financial clearing provider. |
|
Enable/disable WBA open roaming support. Choices:
|
|
Enable/disable wireless network management Choices:
|
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |