fmgr_hotspot20_hsprofile – Configure hotspot profile.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
hotspot20_hsprofile yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • hotspot20_hsprofile - no description type: dict
    • 3gpp-plmn - 3GPP PLMN name. type: str more...
    • access-network-asra - Enable/disable additional step required for access (ASRA). type: str choices: [disable, enable] more...
    • access-network-esr - Enable/disable emergency services reachable (ESR). type: str choices: [disable, enable] more...
    • access-network-internet - Enable/disable connectivity to the Internet. type: str choices: [disable, enable] more...
    • access-network-type - Access network type. type: str 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] more...
    • access-network-uesa - Enable/disable unauthenticated emergency service accessible (UESA). type: str choices: [disable, enable] more...
    • anqp-domain-id - ANQP Domain ID (0-65535). type: int more...
    • bss-transition - Enable/disable basic service set (BSS) transition Support. type: str choices: [disable, enable] more...
    • conn-cap - Connection capability name. type: str more...
    • deauth-request-timeout - Deauthentication request timeout (in seconds). type: int more...
    • dgaf - Enable/disable downstream group-addressed forwarding (DGAF). type: str choices: [disable, enable] more...
    • domain-name - Domain name. type: str more...
    • gas-comeback-delay - GAS comeback delay (0 or 100 - 4000 milliseconds, default = 500). type: int more...
    • gas-fragmentation-limit - GAS fragmentation limit (512 - 4096, default = 1024). type: int more...
    • hessid - Homogeneous extended service set identifier (HESSID). type: str more...
    • ip-addr-type - IP address type name. type: str more...
    • l2tif - Enable/disable Layer 2 traffic inspection and filtering. type: str choices: [disable, enable] more...
    • nai-realm - NAI realm list name. type: str more...
    • name - Hotspot profile name. type: str more...
    • network-auth - Network authentication name. type: str more...
    • oper-friendly-name - Operator friendly name. type: str more...
    • osu-provider - Manually selected list of OSU provider(s). type: str more...
    • osu-ssid - Online sign up (OSU) SSID. type: str more...
    • pame-bi - Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). type: str choices: [disable, enable] more...
    • proxy-arp - Enable/disable Proxy ARP. type: str choices: [disable, enable] more...
    • qos-map - QoS MAP set ID. type: str more...
    • roaming-consortium - Roaming consortium list name. type: str more...
    • venue-group - Venue group. type: str choices: [unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor] more...
    • venue-name - Venue name. type: str more...
    • venue-type - Venue type. type: str 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] more...
    • wan-metrics - WAN metric name. type: str more...
    • wnm-sleep-mode - Enable/disable wireless network management (WNM) sleep mode. type: str choices: [disable, enable] more...
    • advice-of-charge - Advice of charge. type: str more...
    • oper-icon - Operator icon. type: str more...
    • osu-provider-nai - OSU Provider NAI. type: str more...
    • release - Hotspot 2. type: int more...
    • terms-and-conditions - Terms and conditions. type: str more...
    • venue-url - Venue name. type: str more...

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: no description
     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]>
           advice-of-charge: <value of string>
           oper-icon: <value of string>
           osu-provider-nai: <value of string>
           release: <value of integer>
           terms-and-conditions: <value of string>
           venue-url: <value of string>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.