:source: fortios_extension_controller_extender_profile.py :orphan: .. fortios_extension_controller_extender_profile: fortios_extension_controller_extender_profile -- FortiExtender extender profile 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 extension_controller feature and extender_profile 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.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v7.2.1 -> v7.6.6 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: FortiExtender extender profile configuration. fortinet.fortios.fortios_extension_controller_extender_profile: vdom: "{{ vdom }}" state: "present" access_token: "" extension_controller_extender_profile: allowaccess: "ping" bandwidth_limit: "1024" cellular: controller_report: interval: "300" signal_threshold: "10" status: "disable" dataplan: - name: "default_name_11 (source extension-controller.dataplan.name)" 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" default_sim: "sim1" gps: "disable" multiple_PDN: "disable" pdn1_dataplan: " (source extension-controller.dataplan.name)" pdn2_dataplan: " (source extension-controller.dataplan.name)" pdn3_dataplan: " (source extension-controller.dataplan.name)" pdn4_dataplan: " (source extension-controller.dataplan.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" default_sim: "sim1" gps: "disable" multiple_PDN: "disable" pdn1_dataplan: " (source extension-controller.dataplan.name)" pdn2_dataplan: " (source extension-controller.dataplan.name)" pdn3_dataplan: " (source extension-controller.dataplan.name)" pdn4_dataplan: " (source extension-controller.dataplan.name)" preferred_carrier: "" redundant_intf: "" redundant_mode: "disable" sim1_pin: "disable" sim1_pin_code: "" sim2_pin: "disable" sim2_pin_code: "" sms_notification: alert: data_exhausted: "" fgt_backup_mode_switch: "" low_signal_strength: "" mode_switch: "" os_image_fallback: "" session_disconnect: "" system_reboot: "" receiver: - alert: "system-reboot" name: "default_name_71" phone_number: "" status: "disable" status: "disable" enforce_bandwidth: "enable" extension: "wan-extension" id: "77" lan_extension: backhaul: - health_check_fail_cnt: "5" health_check_interval: "5" health_check_probe_cnt: "1" health_check_probe_tm: "2" health_check_recovery_cnt: "5" name: "default_name_85" port: "wan" role: "primary" weight: "1" backhaul_interface: " (source system.interface.name)" backhaul_ip: "" downlinks: - name: "default_name_92" port: "port1" pvid: "1" type: "port" vap: " (source extension-controller.extender-vap.name)" vids: - vid: "" ipsec_tunnel: "" link_loadbalance: "activebackup" traffic_split_services: - address: " (source firewall.address.name)" name: "default_name_103" service: " (source firewall.service.custom.name)" vsdb: "disable" login_password: "" login_password_change: "yes" model: "FX201E" name: "default_name_109" wifi: country: "--" radio_1: band: "2.4GHz" bandwidth: "auto" beacon_interval: "100" bss_color: "0" bss_color_mode: "auto" channel: "CH1" extension_channel: "auto" guard_interval: "auto" lan_ext_vap: " (source extension-controller.extender-vap.name)" local_vaps: - name: "default_name_123 (source extension-controller.extender-vap.name)" max_clients: "0" mode: "AP" operating_standard: "auto" power_level: "100" set_80211d: "disable" status: "disable" radio_2: band: "5GHz" bandwidth: "auto" beacon_interval: "100" bss_color: "0" bss_color_mode: "auto" channel: "CH36" extension_channel: "auto" guard_interval: "auto" lan_ext_vap: " (source extension-controller.extender-vap.name)" local_vaps: - name: "default_name_141 (source extension-controller.extender-vap.name)" max_clients: "0" mode: "AP" operating_standard: "auto" power_level: "100" set_80211d: "disable" status: "disable" 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.