fortinet.fortimanager.fmgr_extendercontroller_extenderprofile module – FortiExtender extender profile configuration.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.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_extenderprofile.
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. |
|
No description. Choices:
|
|
Deprecated, please rename it to bandwidth_limit. FortiExtender LAN extension bandwidth limit |
|
No description. |
|
Deprecated, please rename it to controller_report. |
|
Controller report interval. |
|
Deprecated, please rename it to signal_threshold. Controller report signal threshold. |
|
FortiExtender controller report status. Choices:
|
|
(list or str) No description. |
|
No description. |
|
Deprecated, please rename it to auto_switch. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Deprecated, please rename it to disconnect_period. Automatically switch based on disconnect period. |
|
Deprecated, please rename it to disconnect_threshold. Automatically switch based on disconnect thr… |
|
Automatically switch based on signal strength. Choices:
|
|
Deprecated, please rename it to switch_back. Choices:
|
|
Deprecated, please rename it to switch_back_time. Automatically switch over to preferred SIM/carri… |
|
Deprecated, please rename it to switch_back_timer. Automatically switch over to preferred SIM/carr… |
|
Deprecated, please rename it to conn_status. |
|
Deprecated, please rename it to default_sim. Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
Deprecated, please rename it to modem_id. Modem ID. |
|
Deprecated, please rename it to preferred_carrier. Preferred carrier. |
|
Deprecated, please rename it to redundant_intf. Redundant interface. |
|
Deprecated, please rename it to redundant_mode. FortiExtender mode. Choices:
|
|
Deprecated, please rename it to sim1_pin. SIM Choices:
|
|
(list) Deprecated, please rename it to sim1_pin_code. |
|
Deprecated, please rename it to sim2_pin. SIM Choices:
|
|
(list) Deprecated, please rename it to sim2_pin_code. |
|
No description. |
|
Deprecated, please rename it to auto_switch. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Deprecated, please rename it to disconnect_period. Automatically switch based on disconnect period. |
|
Deprecated, please rename it to disconnect_threshold. Automatically switch based on disconnect thr… |
|
Automatically switch based on signal strength. Choices:
|
|
Deprecated, please rename it to switch_back. Choices:
|
|
Deprecated, please rename it to switch_back_time. Automatically switch over to preferred SIM/carri… |
|
Deprecated, please rename it to switch_back_timer. Automatically switch over to preferred SIM/carr… |
|
Deprecated, please rename it to conn_status. |
|
Deprecated, please rename it to default_sim. Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
Deprecated, please rename it to modem_id. Modem ID. |
|
Deprecated, please rename it to preferred_carrier. Preferred carrier. |
|
Deprecated, please rename it to redundant_intf. Redundant interface. |
|
Deprecated, please rename it to redundant_mode. FortiExtender mode. Choices:
|
|
Deprecated, please rename it to sim1_pin. SIM Choices:
|
|
(list) Deprecated, please rename it to sim1_pin_code. |
|
Deprecated, please rename it to sim2_pin. SIM Choices:
|
|
(list) Deprecated, please rename it to sim2_pin_code. |
|
Deprecated, please rename it to sms_notification. |
|
No description. |
|
Deprecated, please rename it to data_exhausted. Display string when data exhausted. |
|
Deprecated, please rename it to fgt_backup_mode_switch. Display string when FortiGate backup mode … |
|
Deprecated, please rename it to low_signal_strength. Display string when signal strength is low. |
|
Deprecated, please rename it to mode_switch. Display string when mode is switched. |
|
Deprecated, please rename it to os_image_fallback. Display string when falling back to a previous … |
|
Deprecated, please rename it to session_disconnect. Display string when session disconnected. |
|
Deprecated, please rename it to system_reboot. Display string when system rebooted. |
|
No description. |
|
No description. Choices:
|
|
FortiExtender SMS notification receiver name. |
|
Deprecated, please rename it to phone_number. Receiver phone number. |
|
SMS notification receiver status. Choices:
|
|
FortiExtender SMS notification status. Choices:
|
|
Deprecated, please rename it to enforce_bandwidth. Enable/disable enforcement of bandwidth on LAN extension interface. Choices:
|
|
Extension option. Choices:
|
|
ID. |
|
Deprecated, please rename it to lan_extension. |
|
No description. |
|
FortiExtender LAN extension backhaul name. |
|
FortiExtender uplink port. Choices:
|
|
FortiExtender uplink port. Choices:
|
|
WRR weight parameter. |
|
Deprecated, please rename it to backhaul_interface. IPsec phase1 interface. |
|
Deprecated, please rename it to backhaul_ip. IPsec phase1 IPv4/FQDN. |
|
Deprecated, please rename it to ipsec_tunnel. IPsec tunnel name. |
|
Deprecated, please rename it to link_loadbalance. LAN extension link load balance strategy. Choices:
|
|
(list) Deprecated, please rename it to login_password. |
|
Deprecated, please rename it to login_password_change. Change or reset the administrator password of a managed extender Choices:
|
|
Model. Choices:
|
|
FortiExtender profile name. |
|
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: FortiExtender extender profile configuration.
fortinet.fortimanager.fmgr_extendercontroller_extenderprofile:
# 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_extenderprofile:
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
bandwidth_limit: <integer>
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]>
enforce_bandwidth: <value in [disable, enable]>
extension: <value in [wan-extension, lan-extension]>
id: <integer>
lan_extension:
backhaul:
-
name: <string>
port: <value in [wan, lte1, lte2, ...]>
role: <value in [primary, secondary]>
weight: <integer>
backhaul_interface: <string>
backhaul_ip: <string>
ipsec_tunnel: <string>
link_loadbalance: <value in [activebackup, loadbalance]>
login_password: <list or string>
login_password_change: <value in [no, yes, default]>
model: <value in [FX201E, FX211E, FX200F, ...]>
name: <string>
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 |