fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_extendercontroller_simprofile no description | "added in version" 2.1.0 of fortinet.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 communityfortinet.fortimanager.fmgr_extendercontroller_simprofile (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: No description fortinet.fortimanager.fmgr_extendercontroller_simprofile: # 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: present # <value in [present, absent]> extendercontroller_simprofile: auto_switch_profile: dataplan: <value in [disable, enable]> disconnect: <value in [disable, enable]> disconnect_period: <integer> disconnect_threshold: <integer> signal: <value in [disable, enable]> status: <value in [disable, enable]> switch_back: - time - timer switch_back_time: <string> switch_back_timer: <integer> conn_status: <integer> default_sim: <value in [sim1, sim2, carrier, ...]> description: <string> gps: <value in [disable, enable]> modem_id: <integer> name: <string> preferred_carrier: <string> redundant_intf: <string> redundant_mode: <value in [disable, enable]> sim1_pin: <value in [disable, enable]> sim1_pin_code: <list or string> sim2_pin: <value in [disable, enable]> sim2_pin_code: <list or string> status: <value in [disable, enable]>
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 type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. 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. 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. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int extendercontroller_simprofile: description: The top level parameters set. required: false suboptions: auto-switch_profile: description: Deprecated, please rename it to auto_switch_profile. suboptions: dataplan: choices: - disable - enable description: Dataplan. type: str disconnect: choices: - disable - enable description: Disconnect. type: str disconnect-period: description: Deprecated, please rename it to disconnect_period. Disconnect-Period. type: int disconnect-threshold: description: Deprecated, please rename it to disconnect_threshold. Disconnect-Threshold. type: int signal: choices: - disable - enable description: Signal. type: str status: choices: - disable - enable description: Status. type: str switch-back: choices: - time - timer description: Deprecated, please rename it to switch_back. Switch-Back. elements: str type: list switch-back-time: description: Deprecated, please rename it to switch_back_time. Switch-Back-Time. type: str switch-back-timer: description: Deprecated, please rename it to switch_back_timer. Switch-Back-Timer. type: int type: dict conn-status: description: Deprecated, please rename it to conn_status. Conn-Status. type: int default-sim: choices: - sim1 - sim2 - carrier - cost description: Deprecated, please rename it to default_sim. Default-Sim. type: str description: description: Description. type: str gps: choices: - disable - enable description: Gps. type: str modem-id: description: Deprecated, please rename it to modem_id. Modem-Id. type: int name: description: Name. required: true type: str preferred-carrier: description: Deprecated, please rename it to preferred_carrier. Preferred-Carrier. type: str redundant-intf: description: Deprecated, please rename it to redundant_intf. Redundant-Intf. type: str redundant-mode: choices: - disable - enable description: Deprecated, please rename it to redundant_mode. Redundant-Mode. type: str sim1-pin: choices: - disable - enable description: Deprecated, please rename it to sim1_pin. Sim1-Pin. type: str sim1-pin-code: description: (list) Deprecated, please rename it to sim1_pin_code. Sim1-Pin-Code. type: raw sim2-pin: choices: - disable - enable description: Deprecated, please rename it to sim2_pin. Sim2-Pin. type: str sim2-pin-code: description: (list) Deprecated, please rename it to sim2_pin_code. Sim2-Pin-Code. type: raw status: choices: - disable - enable description: Status. type: str 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