drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_extensioncontroller_extenderprofile_cellular_modem1_autoswitch FortiExtender auto switch configuration. | "added in version" 2.2.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_extensioncontroller_extenderprofile_cellular_modem1_autoswitch (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: FortiExtender auto switch configuration. fmgr_extensioncontroller_extenderprofile_cellular_modem1_autoswitch: 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> extender-profile: <your own value> extensioncontroller_extenderprofile_cellular_modem1_autoswitch: dataplan: <value in [disable, enable]> disconnect: <value in [disable, enable]> disconnect-period: <value of integer> disconnect-threshold: <value of integer> signal: <value in [disable, enable]> switch-back: - time - timer switch-back-time: <value of string> switch-back-timer: <value of integer>
adom: description: the parameter (adom) in requested url 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 extender-profile: description: the parameter (extender-profile) in requested url required: true 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 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 extensioncontroller_extenderprofile_cellular_modem1_autoswitch: description: the top level parameters set required: false suboptions: dataplan: choices: - disable - enable description: Automatically switch based on data usage. type: str disconnect: choices: - disable - enable description: Auto switch by disconnect. type: str disconnect-period: description: Automatically switch based on disconnect period. type: int disconnect-threshold: description: Automatically switch based on disconnect threshold. type: int signal: choices: - disable - enable description: Automatically switch based on signal strength. type: str switch-back: choices: - time - timer description: description elements: str type: list switch-back-time: description: Automatically switch over to preferred SIM/carrier at a specified time in UTC type: str switch-back-timer: description: Automatically switch over to preferred SIM/carrier after the given time type: int type: dict
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