drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_hotspot20_h2qposuprovider Configure online sign up | "added in version" 2.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_hotspot20_h2qposuprovider (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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 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>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str hotspot20_h2qposuprovider: description: the top level parameters set required: false suboptions: friendly-name: description: Friendly-Name. elements: dict suboptions: friendly-name: description: OSU provider friendly name. type: str index: description: OSU provider friendly name index. type: int lang: description: Language code. type: str type: list icon: description: OSU provider icon. type: str name: description: OSU provider ID. type: str osu-method: choices: - oma-dm - soap-xml-spp - reserved description: OSU method list. elements: str type: list osu-nai: description: OSU NAI. type: str server-uri: description: Server URI. type: str service-description: description: Service-Description. elements: dict suboptions: lang: description: Language code. type: str service-description: description: Service description. type: str service-id: description: OSU service ID. type: int type: list type: dict workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list