W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider – Configure online sign up (OSU) provider list.

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_h2qposuprovider.

New in version 2.10: of fortinet.fortimanager

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_h2qposuprovider
dictionary
the top level parameters set
friendly-name
list / elements=string
no description
friendly-name
string
OSU provider friendly name.
index
integer
OSU provider friendly name index.
lang
string
Language code.
icon
string
OSU provider icon.
name
string
OSU provider ID.
osu-method
list / elements=string
    Choices:
  • oma-dm
  • soap-xml-spp
  • reserved
no description
osu-nai
string
OSU NAI.
server-uri
string
Server URI.
service-description
list / elements=string
no description
lang
string
Language code.
service-description
string
Service description.
service-id
integer
OSU service ID.
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 online sign up (OSU) provider list.
     fmgr_hotspot20_h2qposuprovider:
        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_h2qposuprovider:
           friendly-name:
             -
                 friendly-name: <value of string>
                 index: <value of integer>
                 lang: <value of string>
           icon: <value of string>
           name: <value of string>
           osu-method:
             - oma-dm
             - soap-xml-spp
             - reserved
           osu-nai: <value of string>
           server-uri: <value of string>
           service-description:
             -
                 lang: <value of string>
                 service-description: <value of string>
                 service-id: <value of integer>

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_h2qposuprovider_module.html