fortios_extender_controller_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- extender_controller_extender - Extender controller configuration. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- aaa_shared_secret - AAA shared secret. type: str
- access_point_name - Access point name(APN). type: str
- admin - FortiExtender Administration (enable or disable). type: str choices: disable, discovered, enable
- at_dial_script - Initialization AT commands specific to the MODEM. type: str
- billing_start_day - Billing start day. type: int
- cdma_aaa_spi - CDMA AAA SPI. type: str
- cdma_ha_spi - CDMA HA SPI. type: str
- cdma_nai - NAI for CDMA MODEMS. type: str
- conn_status - Connection status. type: int
- description - Description. type: str
- dial_mode - Dial mode (dial-on-demand or always-connect). type: str choices: dial-on-demand, always-connect
- dial_status - Dial status. type: int
- ext_name - FortiExtender name. type: str
- ha_shared_secret - HA shared secret. type: str
- id - FortiExtender serial number. type: str required: True
- ifname - FortiExtender interface name. type: str
- initiated_update - Allow/disallow network initiated updates to the MODEM. type: str choices: enable, disable
- mode - FortiExtender mode. type: str choices: standalone, redundant
- modem_passwd - MODEM password. type: str
- modem_type - MODEM type (CDMA, GSM/LTE or WIMAX). type: str choices: cdma, gsm/lte, wimax
- multi_mode - MODEM mode of operation(3G,LTE,etc). type: str choices: auto, auto-3g, force-lte, force-3g, force-2g
- ppp_auth_protocol - PPP authentication protocol (PAP,CHAP or auto). type: str choices: auto, pap, chap
- ppp_echo_request - Enable/disable PPP echo request. type: str choices: enable, disable
- ppp_password - PPP password. type: str
- ppp_username - PPP username. type: str
- primary_ha - Primary HA. type: str
- quota_limit_mb - Monthly quota limit (MB). type: int
- redial - Number of redials allowed based on failed attempts. type: str choices: none, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
- redundant_intf - Redundant interface. type: str
- roaming - Enable/disable MODEM roaming. type: str choices: enable, disable
- role - FortiExtender work role(Primary, Secondary, None). type: str choices: none, primary, secondary
- secondary_ha - Secondary HA. type: str
- sim_pin - SIM PIN. type: str
- vdom - VDOM type: int
- wimax_auth_protocol - WiMax authentication protocol(TLS or TTLS). type: str choices: tls, ttls
- wimax_carrier - WiMax carrier. type: str
- wimax_realm - WiMax realm. type: str
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>"
billing_start_day: "7"
cdma_aaa_spi: "<your_own_value>"
cdma_ha_spi: "<your_own_value>"
cdma_nai: "<your_own_value>"
conn_status: "11"
description: "<your_own_value>"
dial_mode: "dial-on-demand"
dial_status: "14"
ext_name: "<your_own_value>"
ha_shared_secret: "<your_own_value>"
id: "17"
ifname: "<your_own_value>"
initiated_update: "enable"
mode: "standalone"
modem_passwd: "<your_own_value>"
modem_type: "cdma"
multi_mode: "auto"
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: "29"
redial: "none"
redundant_intf: "<your_own_value>"
roaming: "enable"
role: "none"
secondary_ha: "<your_own_value>"
sim_pin: "<your_own_value>"
vdom: "36"
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