:source: fortios_extender_controller_extender.py :orphan: .. fortios_extender_controller_extender: fortios_extender_controller_extender -- Extender controller configuration in Fortinet's FortiOS and FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 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 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v7.2.0 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Extender controller configuration. fortinet.fortios.fortios_extender_controller_extender: vdom: "{{ vdom }}" state: "present" access_token: "" extender_controller_extender: aaa_shared_secret: "" access_point_name: "" admin: "disable" allowaccess: "ping" at_dial_script: "" authorized: "disable" bandwidth_limit: "1024" billing_start_day: "14" cdma_aaa_spi: "" cdma_ha_spi: "" cdma_nai: "" conn_status: "2147483647" controller_report: interval: "300" signal_threshold: "10" status: "disable" description: "" device_id: "1024" dial_mode: "dial-on-demand" dial_status: "2147483647" enforce_bandwidth: "enable" ext_name: "" extension_type: "wan-extension" ha_shared_secret: "" id: "27" ifname: " (source system.interface.name)" initiated_update: "enable" login_password: "" login_password_change: "yes" mode: "standalone" modem_passwd: "" modem_type: "cdma" modem1: auto_switch: dataplan: "disable" disconnect: "disable" disconnect_period: "600" disconnect_threshold: "3" signal: "disable" switch_back: "time" switch_back_time: "" switch_back_timer: "86400" conn_status: "0" default_sim: "sim1" gps: "disable" ifname: " (source system.interface.name)" preferred_carrier: "" redundant_intf: "" redundant_mode: "disable" sim1_pin: "disable" sim1_pin_code: "" sim2_pin: "disable" sim2_pin_code: "" modem2: auto_switch: dataplan: "disable" disconnect: "disable" disconnect_period: "600" disconnect_threshold: "3" signal: "disable" switch_back: "time" switch_back_time: "" switch_back_timer: "86400" conn_status: "0" default_sim: "sim1" gps: "disable" ifname: " (source system.interface.name)" preferred_carrier: "" redundant_intf: "" redundant_mode: "disable" sim1_pin: "disable" sim1_pin_code: "" sim2_pin: "disable" sim2_pin_code: "" 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: "" ppp_username: "" primary_ha: "" profile: " (source extender-controller.extender-profile.name)" quota_limit_mb: "5242880" redial: "none" redundant_intf: "" roaming: "enable" role: "none" secondary_ha: "" sim_pin: "" vdom: "0" wan_extension: modem1_extension: " (source system.interface.name)" modem2_extension: " (source system.interface.name)" wimax_auth_protocol: "tls" wimax_carrier: "" wimax_realm: "" 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: .. raw:: html
  • 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
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.