Try SpotterFortiExtender extender profile configuration.
| "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 community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This 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: 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>
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_extenderprofile:
description: The top level parameters set.
required: false
suboptions:
allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
description: No description.
elements: str
type: list
bandwidth-limit:
description: Deprecated, please rename it to bandwidth_limit. FortiExtender LAN
extension bandwidth limit
type: int
cellular:
description: No description.
suboptions:
controller-report:
description: Deprecated, please rename it to controller_report.
suboptions:
interval:
description: Controller report interval.
type: int
signal-threshold:
description: Deprecated, please rename it to signal_threshold. Controller
report signal threshold.
type: int
status:
choices:
- disable
- enable
description: FortiExtender controller report status.
type: str
type: dict
dataplan:
description: (list or str) No description.
type: raw
modem1:
description: No description.
suboptions:
auto-switch:
description: Deprecated, please rename it to auto_switch.
suboptions:
dataplan:
choices:
- disable
- enable
description: Automatically switch based on data usage.
type: str
disconnect:
choices:
- disable
- enable
description: Auto switch by disconnect.
type: str
disconnect-period:
description: Deprecated, please rename it to disconnect_period. Automatically
switch based on disconnect period.
type: int
disconnect-threshold:
description: Deprecated, please rename it to disconnect_threshold.
Automatically switch based on disconnect thr...
type: int
signal:
choices:
- disable
- enable
description: Automatically switch based on signal strength.
type: str
switch-back:
choices:
- time
- timer
description: Deprecated, please rename it to switch_back.
elements: str
type: list
switch-back-time:
description: Deprecated, please rename it to switch_back_time. Automatically
switch over to preferred SIM/carri...
type: str
switch-back-timer:
description: Deprecated, please rename it to switch_back_timer. Automatically
switch over to preferred SIM/carr...
type: int
type: dict
conn-status:
description: Deprecated, please rename it to conn_status.
type: int
default-sim:
choices:
- sim1
- sim2
- carrier
- cost
description: Deprecated, please rename it to default_sim. Default SIM
selection.
type: str
gps:
choices:
- disable
- enable
description: FortiExtender GPS enable/disable.
type: str
modem-id:
description: Deprecated, please rename it to modem_id. Modem ID.
type: int
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
interface.
type: str
redundant-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to redundant_mode. FortiExtender
mode.
type: str
sim1-pin:
choices:
- disable
- enable
description: Deprecated, please rename it to sim1_pin. SIM
type: str
sim1-pin-code:
description: (list) Deprecated, please rename it to sim1_pin_code.
type: raw
sim2-pin:
choices:
- disable
- enable
description: Deprecated, please rename it to sim2_pin. SIM
type: str
sim2-pin-code:
description: (list) Deprecated, please rename it to sim2_pin_code.
type: raw
type: dict
modem2:
description: No description.
suboptions:
auto-switch:
description: Deprecated, please rename it to auto_switch.
suboptions:
dataplan:
choices:
- disable
- enable
description: Automatically switch based on data usage.
type: str
disconnect:
choices:
- disable
- enable
description: Auto switch by disconnect.
type: str
disconnect-period:
description: Deprecated, please rename it to disconnect_period. Automatically
switch based on disconnect period.
type: int
disconnect-threshold:
description: Deprecated, please rename it to disconnect_threshold.
Automatically switch based on disconnect thr...
type: int
signal:
choices:
- disable
- enable
description: Automatically switch based on signal strength.
type: str
switch-back:
choices:
- time
- timer
description: Deprecated, please rename it to switch_back.
elements: str
type: list
switch-back-time:
description: Deprecated, please rename it to switch_back_time. Automatically
switch over to preferred SIM/carri...
type: str
switch-back-timer:
description: Deprecated, please rename it to switch_back_timer. Automatically
switch over to preferred SIM/carr...
type: int
type: dict
conn-status:
description: Deprecated, please rename it to conn_status.
type: int
default-sim:
choices:
- sim1
- sim2
- carrier
- cost
description: Deprecated, please rename it to default_sim. Default SIM
selection.
type: str
gps:
choices:
- disable
- enable
description: FortiExtender GPS enable/disable.
type: str
modem-id:
description: Deprecated, please rename it to modem_id. Modem ID.
type: int
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
interface.
type: str
redundant-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to redundant_mode. FortiExtender
mode.
type: str
sim1-pin:
choices:
- disable
- enable
description: Deprecated, please rename it to sim1_pin. SIM
type: str
sim1-pin-code:
description: (list) Deprecated, please rename it to sim1_pin_code.
type: raw
sim2-pin:
choices:
- disable
- enable
description: Deprecated, please rename it to sim2_pin. SIM
type: str
sim2-pin-code:
description: (list) Deprecated, please rename it to sim2_pin_code.
type: raw
type: dict
sms-notification:
description: Deprecated, please rename it to sms_notification.
suboptions:
alert:
description: No description.
suboptions:
data-exhausted:
description: Deprecated, please rename it to data_exhausted. Display
string when data exhausted.
type: str
fgt-backup-mode-switch:
description: Deprecated, please rename it to fgt_backup_mode_switch.
Display string when FortiGate backup mode ...
type: str
low-signal-strength:
description: Deprecated, please rename it to low_signal_strength.
Display string when signal strength is low.
type: str
mode-switch:
description: Deprecated, please rename it to mode_switch. Display
string when mode is switched.
type: str
os-image-fallback:
description: Deprecated, please rename it to os_image_fallback. Display
string when falling back to a previous ...
type: str
session-disconnect:
description: Deprecated, please rename it to session_disconnect. Display
string when session disconnected.
type: str
system-reboot:
description: Deprecated, please rename it to system_reboot. Display
string when system rebooted.
type: str
type: dict
receiver:
description: No description.
elements: dict
suboptions:
alert:
choices:
- system-reboot
- data-exhausted
- session-disconnect
- low-signal-strength
- mode-switch
- os-image-fallback
- fgt-backup-mode-switch
description: No description.
elements: str
type: list
name:
description: FortiExtender SMS notification receiver name.
type: str
phone-number:
description: Deprecated, please rename it to phone_number. Receiver
phone number.
type: str
status:
choices:
- disable
- enable
description: SMS notification receiver status.
type: str
type: list
status:
choices:
- disable
- enable
description: FortiExtender SMS notification status.
type: str
type: dict
type: dict
enforce-bandwidth:
choices:
- disable
- enable
description: Deprecated, please rename it to enforce_bandwidth. Enable/disable
enforcement of bandwidth on LAN extension interface.
type: str
extension:
choices:
- wan-extension
- lan-extension
description: Extension option.
type: str
id:
description: ID.
required: true
type: int
lan-extension:
description: Deprecated, please rename it to lan_extension.
suboptions:
backhaul:
description: No description.
elements: dict
suboptions:
name:
description: FortiExtender LAN extension backhaul name.
type: str
port:
choices:
- wan
- lte1
- lte2
- port1
- port2
- port3
- port4
- port5
- sfp
description: FortiExtender uplink port.
type: str
role:
choices:
- primary
- secondary
description: FortiExtender uplink port.
type: str
weight:
description: WRR weight parameter.
type: int
type: list
backhaul-interface:
description: Deprecated, please rename it to backhaul_interface. IPsec phase1
interface.
type: str
backhaul-ip:
description: Deprecated, please rename it to backhaul_ip. IPsec phase1 IPv4/FQDN.
type: str
ipsec-tunnel:
description: Deprecated, please rename it to ipsec_tunnel. IPsec tunnel name.
type: str
link-loadbalance:
choices:
- activebackup
- loadbalance
description: Deprecated, please rename it to link_loadbalance. LAN extension
link load balance strategy.
type: str
type: dict
login-password:
description: (list) Deprecated, please rename it to login_password.
type: raw
login-password-change:
choices:
- 'no'
- 'yes'
- default
description: Deprecated, please rename it to login_password_change. Change or
reset the administrator password of a managed extender
type: str
model:
choices:
- FX201E
- FX211E
- FX200F
- FXA11F
- FXE11F
- FXA21F
- FXE21F
- FXA22F
- FXE22F
- FX212F
- FX311F
- FX312F
- FX511F
- FVG21F
- FVA21F
- FVG22F
- FVA22F
- FX04DA
- FX04DN
- FX04DI
description: Model.
type: str
name:
description: FortiExtender profile name.
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