fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular module – FortiExtender cellular configuration.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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_extensioncontroller_extenderprofile_cellular.
New in fortinet.fortimanager 2.2.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:
|
|
Deprecated, please use “extender_profile” |
|
The parameter (extender-profile) in requested url. |
|
The top level parameters set. |
|
Controller report. |
|
Controller report interval. |
|
Controller report signal threshold. |
|
FortiExtender controller report status. Choices:
|
|
(list) Dataplan names. |
|
Modem1. |
|
Auto switch. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Automatically switch based on disconnect period. |
|
Automatically switch based on disconnect threshold. |
|
Automatically switch based on signal strength. Choices:
|
|
Auto switch with switch back multi-options. Choices:
|
|
Automatically switch over to preferred SIM/carrier at a specified time in UTC |
|
Automatically switch over to preferred SIM/carrier after the given time |
|
Conn status. |
|
Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
Modem ID. |
|
Preferred carrier. |
|
Redundant interface. |
|
FortiExtender mode. Choices:
|
|
SIM Choices:
|
|
(list) SIM |
|
SIM Choices:
|
|
(list) SIM |
|
Modem2. |
|
Auto switch. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Automatically switch based on disconnect period. |
|
Automatically switch based on disconnect threshold. |
|
Automatically switch based on signal strength. Choices:
|
|
Auto switch with switch back multi-options. Choices:
|
|
Automatically switch over to preferred SIM/carrier at a specified time in UTC |
|
Automatically switch over to preferred SIM/carrier after the given time |
|
Conn status. |
|
Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
Modem ID. |
|
Preferred carrier. |
|
Redundant interface. |
|
FortiExtender mode. Choices:
|
|
SIM Choices:
|
|
(list) SIM |
|
SIM Choices:
|
|
(list) SIM |
|
Sms notification. |
|
Alert. |
|
Display string when data exhausted. |
|
Display string when FortiGate backup mode switched. |
|
Display string when signal strength is low. |
|
Display string when mode is switched. |
|
Display string when falling back to a previous OS image. |
|
Display string when session disconnected. |
|
Display string when system rebooted. |
|
Receiver. |
|
Alert multi-options. Choices:
|
|
FortiExtender SMS notification receiver name. |
|
Receiver phone number. |
|
SMS notification receiver status. Choices:
|
|
FortiExtender SMS notification 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 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.
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: FortiExtender cellular configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular:
# 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:
controller_report:
interval: <integer>
signal_threshold: <integer>
status: <value in [disable, enable]>
dataplan: <list or string>
modem1:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <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, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
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>
modem2:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <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, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
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>
sms_notification:
alert:
data_exhausted: <string>
fgt_backup_mode_switch: <string>
low_signal_strength: <string>
mode_switch: <string>
os_image_fallback: <string>
session_disconnect: <string>
system_reboot: <string>
receiver:
-
alert:
- "system-reboot"
- "data-exhausted"
- "session-disconnect"
- "low-signal-strength"
- "mode-switch"
- "os-image-fallback"
- "fgt-backup-mode-switch"
name: <string>
phone_number: <string>
status: <value in [disable, enable]>
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 |