fortinet.fortios.fortios_extender_controller_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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
.
To use it in a playbook, specify: fortinet.fortios.fortios_extender_controller_extender
.
New in version 2.10: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||||
enable_log boolean |
| Enable/Disable logging for task. | |||
extender_controller_extender dictionary | Extender controller configuration. | ||||
aaa_shared_secret string | AAA shared secret. | ||||
access_point_name string | Access point name(APN). | ||||
admin string |
| FortiExtender Administration (enable or disable). | |||
at_dial_script string | Initialization AT commands specific to the MODEM. | ||||
authorized string |
| FortiExtender Administration (enable or disable). | |||
billing_start_day integer | Billing start day. | ||||
cdma_aaa_spi string | CDMA AAA SPI. | ||||
cdma_ha_spi string | CDMA HA SPI. | ||||
cdma_nai string | NAI for CDMA MODEMS. | ||||
conn_status integer | Connection status. | ||||
controller_report dictionary | FortiExtender controller report configuration. | ||||
interval integer | Controller report interval. | ||||
signal_threshold integer | Controller report signal threshold. | ||||
status string |
| FortiExtender controller report status. | |||
description string | Description. | ||||
dial_mode string |
| Dial mode (dial-on-demand or always-connect). | |||
dial_status integer | Dial status. | ||||
ext_name string | FortiExtender name. | ||||
ha_shared_secret string | HA shared secret. | ||||
id string / required | FortiExtender serial number. | ||||
ifname string | FortiExtender interface name. Source system.interface.name. | ||||
initiated_update string |
| Allow/disallow network initiated updates to the MODEM. | |||
login_password string | FortiExtender login password. | ||||
mode string |
| FortiExtender mode. | |||
modem1 dictionary | Configuration options for modem 1. | ||||
auto_switch dictionary | FortiExtender auto switch configuration. | ||||
dataplan string |
| Automatically switch based on data usage. | |||
disconnect string |
| Auto switch by disconnect. | |||
disconnect_period integer | Automatically switch based on disconnect period. | ||||
disconnect_threshold integer | Automatically switch based on disconnect threshold. | ||||
signal string |
| Automatically switch based on signal strength. | |||
switch_back string |
| Auto switch with switch back multi-options. | |||
switch_back_time string | Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). | ||||
switch_back_timer integer | Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). | ||||
conn_status integer | Connection status. | ||||
default_sim string |
| Default SIM selection. | |||
gps string |
| FortiExtender GPS enable/disable. | |||
ifname string | FortiExtender interface name. Source system.interface.name. | ||||
preferred_carrier string | Preferred carrier. | ||||
redundant_intf string | Redundant interface. | ||||
redundant_mode string |
| FortiExtender mode. | |||
sim1_pin string |
| SIM | |||
sim1_pin_code string | SIM | ||||
sim2_pin string |
| SIM | |||
sim2_pin_code string | SIM | ||||
modem2 dictionary | Configuration options for modem 2. | ||||
auto_switch dictionary | FortiExtender auto switch configuration. | ||||
dataplan string |
| Automatically switch based on data usage. | |||
disconnect string |
| Auto switch by disconnect. | |||
disconnect_period integer | Automatically switch based on disconnect period. | ||||
disconnect_threshold integer | Automatically switch based on disconnect threshold. | ||||
signal string |
| Automatically switch based on signal strength. | |||
switch_back string |
| Auto switch with switch back multi-options. | |||
switch_back_time string | Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). | ||||
switch_back_timer integer | Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). | ||||
conn_status integer | Connection status. | ||||
default_sim string |
| Default SIM selection. | |||
gps string |
| FortiExtender GPS enable/disable. | |||
ifname string | FortiExtender interface name. Source system.interface.name. | ||||
preferred_carrier string | Preferred carrier. | ||||
redundant_intf string | Redundant interface. | ||||
redundant_mode string |
| FortiExtender mode. | |||
sim1_pin string |
| SIM | |||
sim1_pin_code string | SIM | ||||
sim2_pin string |
| SIM | |||
sim2_pin_code string | SIM | ||||
modem_passwd string | MODEM password. | ||||
modem_type string |
| MODEM type (CDMA, GSM/LTE or WIMAX). | |||
multi_mode string |
| MODEM mode of operation(3G,LTE,etc). | |||
name string | FortiExtender entry name. | ||||
ppp_auth_protocol string |
| PPP authentication protocol (PAP,CHAP or auto). | |||
ppp_echo_request string |
| Enable/disable PPP echo request. | |||
ppp_password string | PPP password. | ||||
ppp_username string | PPP username. | ||||
primary_ha string | Primary HA. | ||||
quota_limit_mb integer | Monthly quota limit (MB). | ||||
redial string |
| Number of redials allowed based on failed attempts. | |||
redundant_intf string | Redundant interface. | ||||
roaming string |
| Enable/disable MODEM roaming. | |||
role string |
| FortiExtender work role(Primary, Secondary, None). | |||
secondary_ha string | Secondary HA. | ||||
sim_pin string | SIM PIN. | ||||
vdom integer | VDOM | ||||
wimax_auth_protocol string |
| WiMax authentication protocol(TLS or TTLS). | |||
wimax_carrier string | WiMax carrier. | ||||
wimax_realm string | WiMax realm. | ||||
state string / required |
| Indicates whether to create or remove the object. | |||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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" at_dial_script: "<your_own_value>" authorized: "disable" billing_start_day: "8" cdma_aaa_spi: "<your_own_value>" cdma_ha_spi: "<your_own_value>" cdma_nai: "<your_own_value>" conn_status: "12" controller_report: interval: "14" signal_threshold: "15" status: "disable" description: "<your_own_value>" dial_mode: "dial-on-demand" dial_status: "19" ext_name: "<your_own_value>" ha_shared_secret: "<your_own_value>" id: "22" ifname: "<your_own_value> (source system.interface.name)" initiated_update: "enable" login_password: "<your_own_value>" mode: "standalone" modem_passwd: "<your_own_value>" modem_type: "cdma" modem1: auto_switch: dataplan: "disable" disconnect: "disable" disconnect_period: "33" disconnect_threshold: "34" signal: "disable" switch_back: "time" switch_back_time: "<your_own_value>" switch_back_timer: "38" conn_status: "39" 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: "54" disconnect_threshold: "55" signal: "disable" switch_back: "time" switch_back_time: "<your_own_value>" switch_back_timer: "59" conn_status: "60" 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_72" ppp_auth_protocol: "auto" ppp_echo_request: "enable" ppp_password: "<your_own_value>" ppp_username: "<your_own_value>" primary_ha: "<your_own_value>" quota_limit_mb: "78" redial: "none" redundant_intf: "<your_own_value>" roaming: "enable" role: "none" secondary_ha: "<your_own_value>" sim_pin: "<your_own_value>" vdom: "85" 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 | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_extender_controller_extender_module.html