Try SpotterFortiExtender extender profile configuration in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extension_controller feature and extender_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
- name: FortiExtender extender profile configuration.
fortinet.fortios.fortios_extension_controller_extender_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extension_controller_extender_profile:
allowaccess: "ping"
bandwidth_limit: "1024"
cellular:
controller_report:
interval: "300"
signal_threshold: "10"
status: "disable"
dataplan:
-
name: "default_name_11 (source extension-controller.dataplan.name)"
modem1:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "600"
disconnect_threshold: "3"
signal: "disable"
switch_back: "time"
switch_back_time: "<your_own_value>"
switch_back_timer: "86400"
default_sim: "sim1"
gps: "disable"
preferred_carrier: "<your_own_value>"
redundant_intf: "<your_own_value>"
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: "<your_own_value>"
sim2_pin: "disable"
sim2_pin_code: "<your_own_value>"
modem2:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "600"
disconnect_threshold: "3"
signal: "disable"
switch_back: "time"
switch_back_time: "<your_own_value>"
switch_back_timer: "86400"
default_sim: "sim1"
gps: "disable"
preferred_carrier: "<your_own_value>"
redundant_intf: "<your_own_value>"
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: "<your_own_value>"
sim2_pin: "disable"
sim2_pin_code: "<your_own_value>"
sms_notification:
alert:
data_exhausted: "<your_own_value>"
fgt_backup_mode_switch: "<your_own_value>"
low_signal_strength: "<your_own_value>"
mode_switch: "<your_own_value>"
os_image_fallback: "<your_own_value>"
session_disconnect: "<your_own_value>"
system_reboot: "<your_own_value>"
receiver:
-
alert: "system-reboot"
name: "default_name_61"
phone_number: "<your_own_value>"
status: "disable"
status: "disable"
enforce_bandwidth: "enable"
extension: "wan-extension"
id: "67"
lan_extension:
backhaul:
-
name: "default_name_70"
port: "wan"
role: "primary"
weight: "1"
backhaul_interface: "<your_own_value> (source system.interface.name)"
backhaul_ip: "<your_own_value>"
ipsec_tunnel: "<your_own_value>"
link_loadbalance: "activebackup"
login_password: "<your_own_value>"
login_password_change: "yes"
model: "FX201E"
name: "default_name_81"
vdom:
default: root
description:
- Virtual domain, among those defined previously. A vdom is a virtual instance of
the FortiGate that can be configured and used as a different unit.
type: str
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
extension_controller_extender_profile:
default: null
description:
- FortiExtender extender profile configuration.
suboptions:
allowaccess:
choices:
- ping
- telnet
- http
- https
- ssh
- snmp
description:
- Control management access to the managed extender. Separate entries with a space.
elements: str
type: list
bandwidth_limit:
description:
- FortiExtender LAN extension bandwidth limit (Mbps).
type: int
cellular:
description:
- FortiExtender cellular configuration.
suboptions:
controller_report:
description:
- FortiExtender controller report configuration.
suboptions:
interval:
description:
- Controller report interval.
type: int
signal_threshold:
description:
- Controller report signal threshold.
type: int
status:
choices:
- disable
- enable
description:
- FortiExtender controller report status.
type: str
type: dict
dataplan:
description:
- Dataplan names.
elements: dict
suboptions:
name:
description:
- Dataplan name. Source extension-controller.dataplan.name.
required: true
type: str
type: list
modem1:
description:
- Configuration options for modem 1.
suboptions:
auto_switch:
description:
- FortiExtender auto switch configuration.
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:
- Automatically switch based on disconnect period.
type: int
disconnect_threshold:
description:
- Automatically switch based on disconnect threshold.
type: int
signal:
choices:
- disable
- enable
description:
- Automatically switch based on signal strength.
type: str
switch_back:
choices:
- time
- timer
description:
- Auto switch with switch back multi-options.
elements: str
type: list
switch_back_time:
description:
- Automatically switch over to preferred SIM/carrier at a specified
time in UTC (HH:MM).
type: str
switch_back_timer:
description:
- Automatically switch over to preferred SIM/carrier after the given
time (3600 - 2147483647 sec).
type: int
type: dict
default_sim:
choices:
- sim1
- sim2
- carrier
- cost
description:
- Default SIM selection.
type: str
gps:
choices:
- disable
- enable
description:
- FortiExtender GPS enable/disable.
type: str
preferred_carrier:
description:
- Preferred carrier.
type: str
redundant_intf:
description:
- Redundant interface.
type: str
redundant_mode:
choices:
- disable
- enable
description:
- FortiExtender mode.
type: str
sim1_pin:
choices:
- disable
- enable
description:
- SIM
type: str
sim1_pin_code:
description:
- SIM
type: str
sim2_pin:
choices:
- disable
- enable
description:
- SIM
type: str
sim2_pin_code:
description:
- SIM
type: str
type: dict
modem2:
description:
- Configuration options for modem 2.
suboptions:
auto_switch:
description:
- FortiExtender auto switch configuration.
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:
- Automatically switch based on disconnect period.
type: int
disconnect_threshold:
description:
- Automatically switch based on disconnect threshold.
type: int
signal:
choices:
- disable
- enable
description:
- Automatically switch based on signal strength.
type: str
switch_back:
choices:
- time
- timer
description:
- Auto switch with switch back multi-options.
elements: str
type: list
switch_back_time:
description:
- Automatically switch over to preferred SIM/carrier at a specified
time in UTC (HH:MM).
type: str
switch_back_timer:
description:
- Automatically switch over to preferred SIM/carrier after the given
time (3600 - 2147483647 sec).
type: int
type: dict
default_sim:
choices:
- sim1
- sim2
- carrier
- cost
description:
- Default SIM selection.
type: str
gps:
choices:
- disable
- enable
description:
- FortiExtender GPS enable/disable.
type: str
preferred_carrier:
description:
- Preferred carrier.
type: str
redundant_intf:
description:
- Redundant interface.
type: str
redundant_mode:
choices:
- disable
- enable
description:
- FortiExtender mode.
type: str
sim1_pin:
choices:
- disable
- enable
description:
- SIM
type: str
sim1_pin_code:
description:
- SIM
type: str
sim2_pin:
choices:
- disable
- enable
description:
- SIM
type: str
sim2_pin_code:
description:
- SIM
type: str
type: dict
sms_notification:
description:
- FortiExtender cellular SMS notification configuration.
suboptions:
alert:
description:
- SMS alert list.
suboptions:
data_exhausted:
description:
- Display string when data exhausted.
type: str
fgt_backup_mode_switch:
description:
- Display string when FortiGate backup mode switched.
type: str
low_signal_strength:
description:
- Display string when signal strength is low.
type: str
mode_switch:
description:
- Display string when mode is switched.
type: str
os_image_fallback:
description:
- Display string when falling back to a previous OS image.
type: str
session_disconnect:
description:
- Display string when session disconnected.
type: str
system_reboot:
description:
- Display string when system rebooted.
type: str
type: dict
receiver:
description:
- SMS notification receiver list.
elements: dict
suboptions:
alert:
choices:
- system-reboot
- data-exhausted
- session-disconnect
- low-signal-strength
- mode-switch
- os-image-fallback
- fgt-backup-mode-switch
description:
- Alert multi-options.
elements: str
type: list
name:
description:
- FortiExtender SMS notification receiver name.
required: true
type: str
phone_number:
description:
- 'Receiver phone number. Format: [+][country code][area code][local
phone number]. For example, +16501234567.'
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:
- enable
- disable
description:
- 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.
type: int
lan_extension:
description:
- FortiExtender lan extension configuration.
suboptions:
backhaul:
description:
- LAN extension backhaul tunnel configuration.
elements: dict
suboptions:
name:
description:
- FortiExtender LAN extension backhaul name.
required: true
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:
- IPsec phase1 interface. Source system.interface.name.
type: str
backhaul_ip:
description:
- IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate
unit is behind a NAT device.
type: str
ipsec_tunnel:
description:
- IPsec tunnel name.
type: str
link_loadbalance:
choices:
- activebackup
- loadbalance
description:
- LAN extension link load balance strategy.
type: str
type: dict
login_password:
description:
- Set the managed extender"s administrator password.
type: str
login_password_change:
choices:
- 'yes'
- default
- 'no'
description:
- Change or reset the administrator password of a managed extender (yes, default,
or no).
type: str
model:
choices:
- FX201E
- FX211E
- FX200F
- FXA11F
- FXE11F
- FXA21F
- FXE21F
- FXA22F
- FXE22F
- FX212F
- FX311F
- FX312F
- FX511F
- FVG21F
- FVA21F
- FVG22F
- FVA22F
- FX04DA
description:
- Model.
type: str
name:
description:
- FortiExtender profile name.
required: true
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str