fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_osu_provider – Configure online sign up (OSU) provider list in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.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.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_osu_provider.
New in version 2.10: of fortinet.fortios
Synopsis
- 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 h2qp_osu_provider category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| state
string / required
|
|
Indicates whether to create or remove the object.
|
||
| 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_h2qp_osu_provider
dictionary
|
Configure online sign up (OSU) provider list.
|
|||
| friendly_name
list / elements=string
|
OSU provider friendly name.
|
|||
| friendly_name
string
|
OSU provider friendly name.
|
|||
| index
integer / required
|
OSU provider friendly name index.
|
|||
| lang
string
|
Language code.
|
|||
| icon
string
|
OSU provider icon. Source wireless-controller.hotspot20.icon.name.
|
|||
| name
string / required
|
OSU provider ID.
|
|||
| osu_method
list / elements=string
|
|
OSU method list.
|
||
| osu_nai
string
|
OSU NAI.
|
|||
| server_uri
string
|
Server URI.
|
|||
| service_description
list / elements=string
|
OSU service name.
|
|||
| lang
string
|
Language code.
|
|||
| service_description
string
|
Service description.
|
|||
| service_id
integer
|
OSU service ID.
|
|||
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure online sign up (OSU) provider list.
fortios_wireless_controller_hotspot20_h2qp_osu_provider:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_h2qp_osu_provider:
friendly_name:
-
friendly_name: "<your_own_value>"
index: "5"
lang: "<your_own_value>"
icon: "<your_own_value> (source wireless-controller.hotspot20.icon.name)"
name: "default_name_8"
osu_method: "oma-dm"
osu_nai: "<your_own_value>"
server_uri: "<your_own_value>"
service_description:
-
lang: "<your_own_value>"
service_description: "<your_own_value>"
service_id: "15"
Return Values
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
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_hotspot20_h2qp_osu_provider_module.html