fortinet.fortimanager.fmgr_extendercontroller_simprofile module – Extender controller sim profile
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_extendercontroller_simprofile.
New in fortinet.fortimanager 2.1.0
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 |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to auto_switch_profile. Auto switch profile. |
|
Dataplan. Choices:
|
|
Disconnect. Choices:
|
|
Deprecated, please rename it to disconnect_period. Disconnect period. |
|
Deprecated, please rename it to disconnect_threshold. Disconnect threshold. |
|
Signal. Choices:
|
|
Status. Choices:
|
|
Deprecated, please rename it to switch_back. Switch back. Choices:
|
|
Deprecated, please rename it to switch_back_time. Switch back time. |
|
Deprecated, please rename it to switch_back_timer. Switch back timer. |
|
Deprecated, please rename it to conn_status. Conn status. |
|
Deprecated, please rename it to default_sim. Default sim. Choices:
|
|
Description. |
|
Gps. Choices:
|
|
Deprecated, please rename it to modem_id. Modem id. |
|
Name. |
|
Deprecated, please rename it to preferred_carrier. Preferred carrier. |
|
Deprecated, please rename it to redundant_intf. Redundant intf. |
|
Deprecated, please rename it to redundant_mode. Redundant mode. Choices:
|
|
Deprecated, please rename it to sim1_pin. Sim1 pin. Choices:
|
|
(list) Deprecated, please rename it to sim1_pin_code. Sim1 pin code. |
|
Deprecated, please rename it to sim2_pin. Sim2 pin. Choices:
|
|
(list) Deprecated, please rename it to sim2_pin_code. Sim2 pin code. |
|
Status. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- 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: Extender controller sim profile
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]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |