fmgr_extendercontroller_simprofile¶
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
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
- extendercontroller_simprofile - no description type: dict
- auto-switch_profile type: dict
- dataplan - Dataplan. type: str choices: [disable, enable] default: disable more...
- disconnect - Disconnect. type: str choices: [disable, enable] default: disable more...
- disconnect-period - Disconnect-Period. type: int default: 600 more...
- disconnect-threshold - Disconnect-Threshold. type: int default: 3 more...
- signal - Signal. type: str choices: [disable, enable] default: disable more...
- status - Status. type: str choices: [disable, enable] default: enable more...
- switch-back - Switch-Back. type: array choices: [time, timer] more...
- switch-back-time - Switch-Back-Time. type: str default: 00:01 more...
- switch-back-timer - Switch-Back-Timer. type: int default: 86400 more...
- conn-status - Conn-Status. type: int default: 0 more...
- default-sim - Default-Sim. type: str choices: [sim1, sim2, carrier, cost] default: sim1 more...
- description - Description. type: str more...
- gps - Gps. type: str choices: [disable, enable] default: enable more...
- modem-id - Modem-Id. type: int default: 0 more...
- name - Name. type: str more...
- preferred-carrier - Preferred-Carrier. type: str more...
- redundant-intf - Redundant-Intf. type: str more...
- redundant-mode - Redundant-Mode. type: str choices: [disable, enable] default: disable more...
- sim1-pin - Sim1-Pin. type: str choices: [disable, enable] default: disable more...
- sim1-pin-code - Sim1-Pin-Code. type: str more...
- sim2-pin - Sim2-Pin. type: str choices: [disable, enable] default: disable more...
- sim2-pin-code - Sim2-Pin-Code. type: str more...
- status - Status. type: str choices: [disable, enable] default: enable 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_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: <value in [present, absent]>
extendercontroller_simprofile:
auto-switch_profile:
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]>
status: <value in [disable, enable]>
switch-back:
- time
- timer
switch-back-time: <value of string>
switch-back-timer: <value of integer>
conn-status: <value of integer>
default-sim: <value in [sim1, sim2, carrier, ...]>
description: <value of string>
gps: <value in [disable, enable]>
modem-id: <value of integer>
name: <value of string>
preferred-carrier: <value of string>
redundant-intf: <value of string>
redundant-mode: <value in [disable, enable]>
sim1-pin: <value in [disable, enable]>
sim1-pin-code: <value of string>
sim2-pin: <value in [disable, enable]>
sim2-pin-code: <value of string>
status: <value in [disable, enable]>
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