W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_hotspot20_hsprofile – Configure hotspot profile.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

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

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
hotspot20_hsprofile dictionary			the top level parameters set
	3gpp-plmn string		3GPP PLMN name.
	access-network-asra string	Choices: disable enable	Enable/disable additional step required for access (ASRA).
	access-network-esr string	Choices: disable enable	Enable/disable emergency services reachable (ESR).
	access-network-internet string	Choices: disable enable	Enable/disable connectivity to the Internet.
	access-network-type string	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 type.
	access-network-uesa string	Choices: disable enable	Enable/disable unauthenticated emergency service accessible (UESA).
	anqp-domain-id integer		ANQP Domain ID (0-65535).
	bss-transition string	Choices: disable enable	Enable/disable basic service set (BSS) transition Support.
	conn-cap string		Connection capability name.
	deauth-request-timeout integer		Deauthentication request timeout (in seconds).
	dgaf string	Choices: disable enable	Enable/disable downstream group-addressed forwarding (DGAF).
	domain-name string		Domain name.
	gas-comeback-delay integer		GAS comeback delay (0 or 100 - 4000 milliseconds, default = 500).
	gas-fragmentation-limit integer		GAS fragmentation limit (512 - 4096, default = 1024).
	hessid string		Homogeneous extended service set identifier (HESSID).
	ip-addr-type string		IP address type name.
	l2tif string	Choices: disable enable	Enable/disable Layer 2 traffic inspection and filtering.
	nai-realm string		NAI realm list name.
	name string		Hotspot profile name.
	network-auth string		Network authentication name.
	oper-friendly-name string		Operator friendly name.
	osu-provider string		Manually selected list of OSU provider(s).
	osu-ssid string		Online sign up (OSU) SSID.
	pame-bi string	Choices: disable enable	Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
	proxy-arp string	Choices: disable enable	Enable/disable Proxy ARP.
	qos-map string		QoS MAP set ID.
	roaming-consortium string		Roaming consortium list name.
	venue-group string	Choices: unspecified assembly business educational factory institutional mercantile residential storage utility vehicular outdoor	Venue group.
	venue-name string		Venue name.
	venue-type string	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 type.
	wan-metrics string		WAN metric name.
	wnm-sleep-mode string	Choices: disable enable	Enable/disable wireless network management (WNM) sleep mode.
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
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		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure hotspot profile.
     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: <value in [present, absent]>
        hotspot20_hsprofile:
           3gpp-plmn: <value of 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: <value of integer>
           bss-transition: <value in [disable, enable]>
           conn-cap: <value of string>
           deauth-request-timeout: <value of integer>
           dgaf: <value in [disable, enable]>
           domain-name: <value of string>
           gas-comeback-delay: <value of integer>
           gas-fragmentation-limit: <value of integer>
           hessid: <value of string>
           ip-addr-type: <value of string>
           l2tif: <value in [disable, enable]>
           nai-realm: <value of string>
           name: <value of string>
           network-auth: <value of string>
           oper-friendly-name: <value of string>
           osu-provider: <value of string>
           osu-ssid: <value of string>
           pame-bi: <value in [disable, enable]>
           proxy-arp: <value in [disable, enable]>
           qos-map: <value of string>
           roaming-consortium: <value of string>
           venue-group: <value in [unspecified, assembly, business, ...]>
           venue-name: <value of string>
           venue-type: <value in [unspecified, arena, stadium, ...]>
           wan-metrics: <value of string>
           wnm-sleep-mode: <value in [disable, enable]>

Return Values

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

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_hotspot20_hsprofile_module.html