fortios_extender_controller_extender – Extender controller 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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
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 | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | 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 - Extender controller configuration. type: dict more...
- aaa_shared_secret - AAA shared secret. type: str more...
- access_point_name - Access point name(APN). type: str more...
- admin - FortiExtender Administration (enable or disable). type: str choices: disable, discovered, enable more...
- allowaccess - Control management access to the managed extender. Separate entries with a space. type: list choices: ping, telnet, http, https, ssh, snmp more...
- at_dial_script - Initialization AT commands specific to the MODEM. type: str more...
- authorized - FortiExtender Administration (enable or disable). type: str choices: disable, enable more...
- bandwidth_limit - FortiExtender LAN extension bandwidth limit (Mbps). type: int more...
- billing_start_day - Billing start day. type: int more...
- cdma_aaa_spi - CDMA AAA SPI. type: str more...
- cdma_ha_spi - CDMA HA SPI. type: str more...
- cdma_nai - NAI for CDMA MODEMS. type: str more...
- conn_status - Connection status. type: int 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...
- description - Description. type: str more...
- device_id - Device ID. type: int more...
- dial_mode - Dial mode (dial-on-demand or always-connect). type: str choices: dial-on-demand, always-connect more...
- dial_status - Dial status. type: int more...
- enforce_bandwidth - Enable/disable enforcement of bandwidth on LAN extension interface. type: str choices: enable, disable more...
- ext_name - FortiExtender name. type: str more...
- extension_type - Extension type for this FortiExtender. type: str choices: wan-extension, lan-extension more...
- ha_shared_secret - HA shared secret. type: str more...
- id - FortiExtender serial number. type: str more...
- ifname - FortiExtender interface name. Source system.interface.name. type: str more...
- initiated_update - Allow/disallow network initiated updates to the MODEM. type: str choices: enable, disable 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...
- mode - FortiExtender mode. type: str choices: standalone, redundant more...
- modem_passwd - MODEM password. type: str more...
- modem_type - MODEM type (CDMA, GSM/LTE or WIMAX). type: str choices: cdma, gsm/lte, wimax 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...
- ifname - FortiExtender interface name. Source system.interface.name. type: str 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...
- ifname - FortiExtender interface name. Source system.interface.name. type: str 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...
- multi_mode - MODEM mode of operation(3G,LTE,etc). type: str choices: auto, auto-3g, force-lte, force-3g, force-2g more...
- name - FortiExtender entry name. type: str required: true more...
- override_allowaccess - Enable to override the extender profile management access configuration. type: str choices: enable, disable more...
- override_enforce_bandwidth - Enable to override the extender profile enforce-bandwidth setting. type: str choices: enable, disable more...
- override_login_password_change - Enable to override the extender profile login-password (administrator password) setting. type: str choices: enable, disable more...
- ppp_auth_protocol - PPP authentication protocol (PAP,CHAP or auto). type: str choices: auto, pap, chap more...
- ppp_echo_request - Enable/disable PPP echo request. type: str choices: enable, disable more...
- ppp_password - PPP password. type: str more...
- ppp_username - PPP username. type: str more...
- primary_ha - Primary HA. type: str more...
- profile - FortiExtender profile configuration. Source extender-controller.extender-profile.name. type: str more...
- quota_limit_mb - Monthly quota limit (MB). type: int more...
- redial - Number of redials allowed based on failed attempts. type: str choices: none, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 more...
- redundant_intf - Redundant interface. type: str more...
- roaming - Enable/disable MODEM roaming. type: str choices: enable, disable more...
- role - FortiExtender work role(Primary, Secondary, None). type: str choices: none, primary, secondary more...
- secondary_ha - Secondary HA. type: str more...
- sim_pin - SIM PIN. type: str more...
- vdom - VDOM. type: int more...
- wan_extension - FortiExtender wan extension configuration. type: dict more...
- modem1_extension - FortiExtender interface name. Source system.interface.name. type: str more...
- modem2_extension - FortiExtender interface name. Source system.interface.name. type: str more...
- wimax_auth_protocol - WiMax authentication protocol(TLS or TTLS). type: str choices: tls, ttls more...
- wimax_carrier - WiMax carrier. type: str more...
- wimax_realm - WiMax realm. type: str 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: Extender controller configuration.
fortios_extender_controller_extender:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extender_controller_extender:
aaa_shared_secret: "<your_own_value>"
access_point_name: "<your_own_value>"
admin: "disable"
allowaccess: "ping"
at_dial_script: "<your_own_value>"
authorized: "disable"
bandwidth_limit: "1024"
billing_start_day: "14"
cdma_aaa_spi: "<your_own_value>"
cdma_ha_spi: "<your_own_value>"
cdma_nai: "<your_own_value>"
conn_status: "2147483647"
controller_report:
interval: "300"
signal_threshold: "10"
status: "disable"
description: "<your_own_value>"
device_id: "1024"
dial_mode: "dial-on-demand"
dial_status: "2147483647"
enforce_bandwidth: "enable"
ext_name: "<your_own_value>"
extension_type: "wan-extension"
ha_shared_secret: "<your_own_value>"
id: "27"
ifname: "<your_own_value> (source system.interface.name)"
initiated_update: "enable"
login_password: "<your_own_value>"
login_password_change: "yes"
mode: "standalone"
modem_passwd: "<your_own_value>"
modem_type: "cdma"
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"
ifname: "<your_own_value> (source system.interface.name)"
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"
ifname: "<your_own_value> (source system.interface.name)"
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>"
multi_mode: "auto"
name: "default_name_78"
override_allowaccess: "enable"
override_enforce_bandwidth: "enable"
override_login_password_change: "enable"
ppp_auth_protocol: "auto"
ppp_echo_request: "enable"
ppp_password: "<your_own_value>"
ppp_username: "<your_own_value>"
primary_ha: "<your_own_value>"
profile: "<your_own_value> (source extender-controller.extender-profile.name)"
quota_limit_mb: "5242880"
redial: "none"
redundant_intf: "<your_own_value>"
roaming: "enable"
role: "none"
secondary_ha: "<your_own_value>"
sim_pin: "<your_own_value>"
vdom: "0"
wan_extension:
modem1_extension: "<your_own_value> (source system.interface.name)"
modem2_extension: "<your_own_value> (source system.interface.name)"
wimax_auth_protocol: "tls"
wimax_carrier: "<your_own_value>"
wimax_realm: "<your_own_value>"
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