fortinet.fortios.fortios_extender_controller_extender module – Extender controller configuration in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_extender_controller_extender
.
New in fortinet.fortios 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
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Extender controller configuration. |
|
AAA shared secret. |
|
Access point name(APN). |
|
FortiExtender Administration (enable or disable). Choices:
|
|
Control management access to the managed extender. Separate entries with a space. Choices:
|
|
Initialization AT commands specific to the MODEM. |
|
FortiExtender Administration (enable or disable). Choices:
|
|
FortiExtender LAN extension bandwidth limit (Mbps). |
|
Billing start day. |
|
CDMA AAA SPI. |
|
CDMA HA SPI. |
|
NAI for CDMA MODEMS. |
|
Connection status. |
|
FortiExtender controller report configuration. |
|
Controller report interval. |
|
Controller report signal threshold. |
|
FortiExtender controller report status. Choices:
|
|
Description. |
|
Device ID. |
|
Dial mode (dial-on-demand or always-connect). Choices:
|
|
Dial status. |
|
Enable/disable enforcement of bandwidth on LAN extension interface. Choices:
|
|
FortiExtender name. |
|
Extension type for this FortiExtender. Choices:
|
|
HA shared secret. |
|
FortiExtender serial number. |
|
FortiExtender interface name. Source system.interface.name. |
|
Allow/disallow network initiated updates to the MODEM. Choices:
|
|
Set the managed extender”s administrator password. |
|
Change or reset the administrator password of a managed extender (yes, default, or no). Choices:
|
|
FortiExtender mode. Choices:
|
|
Configuration options for modem 1. |
|
FortiExtender auto switch configuration. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Automatically switch based on disconnect period. |
|
Automatically switch based on disconnect threshold. |
|
Automatically switch based on signal strength. Choices:
|
|
Auto switch with switch back multi-options. Choices:
|
|
Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). |
|
Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). |
|
Connection status. |
|
Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
FortiExtender interface name. Source system.interface.name. |
|
Preferred carrier. |
|
Redundant interface. |
|
FortiExtender mode. Choices:
|
|
SIM Choices:
|
|
SIM |
|
SIM Choices:
|
|
SIM |
|
Configuration options for modem 2. |
|
FortiExtender auto switch configuration. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Automatically switch based on disconnect period. |
|
Automatically switch based on disconnect threshold. |
|
Automatically switch based on signal strength. Choices:
|
|
Auto switch with switch back multi-options. Choices:
|
|
Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). |
|
Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). |
|
Connection status. |
|
Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
FortiExtender interface name. Source system.interface.name. |
|
Preferred carrier. |
|
Redundant interface. |
|
FortiExtender mode. Choices:
|
|
SIM Choices:
|
|
SIM |
|
SIM Choices:
|
|
SIM |
|
MODEM password. |
|
MODEM type (CDMA, GSM/LTE or WIMAX). Choices:
|
|
MODEM mode of operation(3G,LTE,etc). Choices:
|
|
FortiExtender entry name. |
|
Enable to override the extender profile management access configuration. Choices:
|
|
Enable to override the extender profile enforce-bandwidth setting. Choices:
|
|
Enable to override the extender profile login-password (administrator password) setting. Choices:
|
|
PPP authentication protocol (PAP,CHAP or auto). Choices:
|
|
Enable/disable PPP echo request. Choices:
|
|
PPP password. |
|
PPP username. |
|
Primary HA. |
|
FortiExtender profile configuration. Source extender-controller.extender-profile.name. |
|
Monthly quota limit (MB). |
|
Number of redials allowed based on failed attempts. Choices:
|
|
Redundant interface. |
|
Enable/disable MODEM roaming. Choices:
|
|
FortiExtender work role(Primary, Secondary, None). Choices:
|
|
Secondary HA. |
|
SIM PIN. |
|
VDOM. |
|
FortiExtender wan extension configuration. |
|
FortiExtender interface name. Source system.interface.name. |
|
FortiExtender interface name. Source system.interface.name. |
|
WiMax authentication protocol(TLS or TTLS). Choices:
|
|
WiMax carrier. |
|
WiMax realm. |
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Extender controller configuration.
fortinet.fortios.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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |