fortios_extender_controller_extender_profile – FortiExtender extender profile configuration in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender_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
FortiOS Version Compatibility¶
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
|
fortios_extender_controller_extender_profile | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- extender_controller_extender_profile - FortiExtender extender profile configuration. type: dict more...
- allowaccess - Control management access to the managed extender. Separate entries with a space. type: list choices: ping, telnet, http, https, ssh, snmp more...
- bandwidth_limit - FortiExtender LAN extension bandwidth limit (Mbps). type: int more...
- cellular - FortiExtender cellular configuration. type: dict more...
- controller_report - FortiExtender controller report configuration. type: dict more...
- interval - Controller report interval. type: int more...
- signal_threshold - Controller report signal threshold. type: int more...
- status - FortiExtender controller report status. type: str choices: disable, enable more...
- dataplan - Dataplan names. type: list more...
- name - Dataplan name. Source extender-controller.dataplan.name. type: str more...
- modem1 - Configuration options for modem 1. type: dict more...
- auto_switch - FortiExtender auto switch configuration. type: dict more...
- dataplan - Automatically switch based on data usage. type: str choices: disable, enable more...
- disconnect - Auto switch by disconnect. type: str choices: disable, enable more...
- disconnect_period - Automatically switch based on disconnect period. type: int more...
- disconnect_threshold - Automatically switch based on disconnect threshold. type: int more...
- signal - Automatically switch based on signal strength. type: str choices: disable, enable more...
- switch_back - Auto switch with switch back multi-options. type: list choices: time, timer more...
- switch_back_time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str more...
- switch_back_timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int more...
- conn_status - Connection status. type: int more...
- default_sim - Default SIM selection. type: str choices: sim1, sim2, carrier, cost more...
- gps - FortiExtender GPS enable/disable. type: str choices: disable, enable more...
- preferred_carrier - Preferred carrier. type: str more...
- redundant_intf - Redundant interface. type: str more...
- redundant_mode - FortiExtender mode. type: str choices: disable, enable more...
- sim1_pin - SIM type: str choices: disable, enable more...
- sim1_pin_code - SIM type: str more...
- sim2_pin - SIM type: str choices: disable, enable more...
- sim2_pin_code - SIM type: str more...
- modem2 - Configuration options for modem 2. type: dict more...
- auto_switch - FortiExtender auto switch configuration. type: dict more...
- dataplan - Automatically switch based on data usage. type: str choices: disable, enable more...
- disconnect - Auto switch by disconnect. type: str choices: disable, enable more...
- disconnect_period - Automatically switch based on disconnect period. type: int more...
- disconnect_threshold - Automatically switch based on disconnect threshold. type: int more...
- signal - Automatically switch based on signal strength. type: str choices: disable, enable more...
- switch_back - Auto switch with switch back multi-options. type: list choices: time, timer more...
- switch_back_time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str more...
- switch_back_timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int more...
- conn_status - Connection status. type: int more...
- default_sim - Default SIM selection. type: str choices: sim1, sim2, carrier, cost more...
- gps - FortiExtender GPS enable/disable. type: str choices: disable, enable more...
- preferred_carrier - Preferred carrier. type: str more...
- redundant_intf - Redundant interface. type: str more...
- redundant_mode - FortiExtender mode. type: str choices: disable, enable more...
- sim1_pin - SIM type: str choices: disable, enable more...
- sim1_pin_code - SIM type: str more...
- sim2_pin - SIM type: str choices: disable, enable more...
- sim2_pin_code - SIM type: str more...
- sms_notification - FortiExtender cellular SMS notification configuration. type: dict more...
- alert - SMS alert list. type: dict more...
- data_exhausted - Display string when data exhausted. type: str more...
- fgt_backup_mode_switch - Display string when FortiGate backup mode switched. type: str more...
- low_signal_strength - Display string when signal strength is low. type: str more...
- mode_switch - Display string when mode is switched. type: str more...
- os_image_fallback - Display string when falling back to a previous OS image. type: str more...
- session_disconnect - Display string when session disconnected. type: str more...
- system_reboot - Display string when system rebooted. type: str more...
- receiver - SMS notification receiver list. type: list more...
- alert - Alert multi-options. type: list choices: system-reboot, data-exhausted, session-disconnect, low-signal-strength, mode-switch, os-image-fallback, fgt-backup-mode-switch more...
- name - FortiExtender SMS notification receiver name. type: str more...
- phone_number - Receiver phone number. Format: [+][country code][area code][local phone number]. For example, +16501234567. type: str more...
- status - SMS notification receiver status. type: str choices: disable, enable more...
- status - FortiExtender SMS notification status. type: str choices: disable, enable more...
- enforce_bandwidth - Enable/disable enforcement of bandwidth on LAN extension interface. type: str choices: enable, disable more...
- extension - Extension option. type: str choices: wan-extension, lan-extension more...
- id - ID. type: int more...
- lan_extension - FortiExtender lan extension configuration. type: dict more...
- backhaul - LAN extension backhaul tunnel configuration. type: list more...
- name - FortiExtender LAN extension backhaul name. type: str more...
- port - FortiExtender uplink port. type: str choices: wan, lte1, lte2, port1, port2, port3, port4, port5, sfp more...
- role - FortiExtender uplink port. type: str choices: primary, secondary more...
- weight - WRR weight parameter. type: int more...
- backhaul_interface - IPsec phase1 interface. Source system.interface.name. type: str more...
- backhaul_ip - IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device. type: str more...
- ipsec_tunnel - IPsec tunnel name. type: str more...
- link_loadbalance - LAN extension link load balance strategy. type: str choices: activebackup, loadbalance more...
- login_password - Set the managed extender"s administrator password. type: str more...
- login_password_change - Change or reset the administrator password of a managed extender (yes, default, or no). type: str choices: yes, default, no more...
- model - Model. type: str choices: FX201E, FX211E, FX200F, FXA11F, FXE11F, FXA21F, FXE21F, FXA22F, FXE22F, FX212F, FX311F, FX312F, FX511F, FVG21F, FVA21F, FVG22F, FVA22F, FX04DA, FX04DN, FX04DI more...
- name - FortiExtender profile name. type: str required: true more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: FortiExtender extender profile configuration.
fortios_extender_controller_extender_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extender_controller_extender_profile:
allowaccess: "ping"
bandwidth_limit: "1024"
cellular:
controller_report:
interval: "300"
signal_threshold: "10"
status: "disable"
dataplan:
-
name: "default_name_11 (source extender-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"
conn_status: "0"
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"
conn_status: "0"
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_63"
phone_number: "<your_own_value>"
status: "disable"
status: "disable"
enforce_bandwidth: "enable"
extension: "wan-extension"
id: "69"
lan_extension:
backhaul:
-
name: "default_name_72"
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_83"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3