fortios_extension_controller_extender_profile.rst

source:	fortios_extension_controller_extender_profile.py
orphan:

fortios_extension_controller_extender_profile -- FortiExtender extender profile configuration in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	v7.2.1	v7.2.2	v7.2.4	v7.4.0
fortios_extension_controller_extender_profile	yes	yes	yes	yes

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: 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
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• extension_controller_extender_profile - FortiExtender extender profile configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  extension_controller_extender_profile	yes	yes	yes	yes

• allowaccess - Control management access to the managed extender. Separate entries with a space. type: list choices: ping, telnet, http, https, ssh, snmp more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  allowaccess	yes	yes	yes	yes
  [ping]	yes	yes	yes	yes
  [telnet]	yes	yes	yes	yes
  [http]	yes	yes	yes	yes
  [https]	yes	yes	yes	yes
  [ssh]	yes	yes	yes	yes
  [snmp]	yes	yes	yes	yes

• bandwidth_limit - FortiExtender LAN extension bandwidth limit (Mbps). type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  bandwidth_limit	yes	yes	yes	yes

• cellular - FortiExtender cellular configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  cellular	yes	yes	yes	yes

• controller_report - FortiExtender controller report configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  controller_report	yes	yes	yes	yes

• interval - Controller report interval. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  interval	yes	yes	yes	yes

• signal_threshold - Controller report signal threshold. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  signal_threshold	yes	yes	yes	yes

• status - FortiExtender controller report status. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  status	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• dataplan - Dataplan names. type: list member_path: cellular/dataplan:name more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dataplan	yes	yes	yes	yes

• name - Dataplan name. Source extension-controller.dataplan.name. type: str required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes

• modem1 - Configuration options for modem 1. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  modem1	yes	yes	yes	yes

• auto_switch - FortiExtender auto switch configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  auto_switch	yes	yes	yes	yes

• dataplan - Automatically switch based on data usage. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dataplan	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• disconnect - Auto switch by disconnect. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  disconnect	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• disconnect_period - Automatically switch based on disconnect period. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  disconnect_period	yes	yes	yes	yes

• disconnect_threshold - Automatically switch based on disconnect threshold. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  disconnect_threshold	yes	yes	yes	yes

• signal - Automatically switch based on signal strength. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  signal	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• switch_back - Auto switch with switch back multi-options. type: list choices: time, timer more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  switch_back	yes	yes	yes	yes
  [time]	yes	yes	yes	yes
  [timer]	yes	yes	yes	yes

• switch_back_time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  switch_back_time	yes	yes	yes	yes

• switch_back_timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  switch_back_timer	yes	yes	yes	yes

• default_sim - Default SIM selection. type: str choices: sim1, sim2, carrier, cost more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  default_sim	yes	yes	yes	yes
  [sim1]	yes	yes	yes	yes
  [sim2]	yes	yes	yes	yes
  [carrier]	yes	yes	yes	yes
  [cost]	yes	yes	yes	yes

• gps - FortiExtender GPS enable/disable. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  gps	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• preferred_carrier - Preferred carrier. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  preferred_carrier	yes	yes	yes	yes

• redundant_intf - Redundant interface. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  redundant_intf	yes	yes	yes	yes

• redundant_mode - FortiExtender mode. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  redundant_mode	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim1_pin - SIM type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim1_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim1_pin_code - SIM type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim1_pin_code	yes	yes	yes	yes

• sim2_pin - SIM type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim2_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim2_pin_code - SIM type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim2_pin_code	yes	yes	yes	yes

• modem2 - Configuration options for modem 2. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  modem2	yes	yes	yes	yes

• auto_switch - FortiExtender auto switch configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  auto_switch	yes	yes	yes	yes

• dataplan - Automatically switch based on data usage. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dataplan	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• disconnect - Auto switch by disconnect. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  disconnect	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• disconnect_period - Automatically switch based on disconnect period. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  disconnect_period	yes	yes	yes	yes

• disconnect_threshold - Automatically switch based on disconnect threshold. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  disconnect_threshold	yes	yes	yes	yes

• signal - Automatically switch based on signal strength. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  signal	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• switch_back - Auto switch with switch back multi-options. type: list choices: time, timer more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  switch_back	yes	yes	yes	yes
  [time]	yes	yes	yes	yes
  [timer]	yes	yes	yes	yes

• switch_back_time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  switch_back_time	yes	yes	yes	yes

• switch_back_timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  switch_back_timer	yes	yes	yes	yes

• default_sim - Default SIM selection. type: str choices: sim1, sim2, carrier, cost more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  default_sim	yes	yes	yes	yes
  [sim1]	yes	yes	yes	yes
  [sim2]	yes	yes	yes	yes
  [carrier]	yes	yes	yes	yes
  [cost]	yes	yes	yes	yes

• gps - FortiExtender GPS enable/disable. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  gps	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• preferred_carrier - Preferred carrier. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  preferred_carrier	yes	yes	yes	yes

• redundant_intf - Redundant interface. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  redundant_intf	yes	yes	yes	yes

• redundant_mode - FortiExtender mode. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  redundant_mode	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim1_pin - SIM type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim1_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim1_pin_code - SIM type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim1_pin_code	yes	yes	yes	yes

• sim2_pin - SIM type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim2_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim2_pin_code - SIM type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sim2_pin_code	yes	yes	yes	yes

• sms_notification - FortiExtender cellular SMS notification configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sms_notification	yes	yes	yes	yes

• alert - SMS alert list. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  alert	yes	yes	yes	yes

• data_exhausted - Display string when data exhausted. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  data_exhausted	yes	yes	yes	yes

• fgt_backup_mode_switch - Display string when FortiGate backup mode switched. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  fgt_backup_mode_switch	yes	yes	yes	yes

• low_signal_strength - Display string when signal strength is low. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  low_signal_strength	yes	yes	yes	yes

• mode_switch - Display string when mode is switched. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  mode_switch	yes	yes	yes	yes

• os_image_fallback - Display string when falling back to a previous OS image. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  os_image_fallback	yes	yes	yes	yes

• session_disconnect - Display string when session disconnected. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  session_disconnect	yes	yes	yes	yes

• system_reboot - Display string when system rebooted. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  system_reboot	yes	yes	yes	yes

• receiver - SMS notification receiver list. type: list member_path: cellular/sms_notification/receiver:name more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  receiver	yes	yes	yes	yes

• alert - Alert multi-options. type: list choices: system-reboot, data-exhausted, session-disconnect, low-signal-strength, mode-switch, os-image-fallback, fgt-backup-mode-switch more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  alert	yes	yes	yes	yes
  [system-reboot]	yes	yes	yes	yes
  [data-exhausted]	yes	yes	yes	yes
  [session-disconnect]	yes	yes	yes	yes
  [low-signal-strength]	yes	yes	yes	yes
  [mode-switch]	yes	yes	yes	yes
  [os-image-fallback]	yes	yes	yes	yes
  [fgt-backup-mode-switch]	yes	yes	yes	yes

• name - FortiExtender SMS notification receiver name. type: str required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes

• phone_number - Receiver phone number. Format: [+][country code][area code][local phone number]. For example, +16501234567. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  phone_number	yes	yes	yes	yes

• status - SMS notification receiver status. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  status	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• status - FortiExtender SMS notification status. type: str choices: disable, enable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  status	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• enforce_bandwidth - Enable/disable enforcement of bandwidth on LAN extension interface. type: str choices: enable, disable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  enforce_bandwidth	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes

• extension - Extension option. type: str choices: wan-extension, lan-extension more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  extension	yes	yes	yes	yes
  [wan-extension]	yes	yes	yes	yes
  [lan-extension]	yes	yes	yes	yes

• id - ID. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  id	yes	yes	yes	yes

• lan_extension - FortiExtender lan extension configuration. type: dict more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  lan_extension	yes	yes	yes	yes

• backhaul - LAN extension backhaul tunnel configuration. type: list member_path: lan_extension/backhaul:name more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  backhaul	yes	yes	yes	yes

• name - FortiExtender LAN extension backhaul name. type: str required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes

• port - FortiExtender uplink port. type: str choices: wan, lte1, lte2, port1, port2, port3, port4, port5, sfp more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  port	yes	yes	yes	yes
  [wan]	yes	yes	yes	yes
  [lte1]	yes	yes	yes	yes
  [lte2]	yes	yes	yes	yes
  [port1]	yes	yes	yes	yes
  [port2]	yes	yes	yes	yes
  [port3]	yes	yes	yes	yes
  [port4]	yes	yes	yes	yes
  [port5]	yes	yes	yes	yes
  [sfp]	yes	yes	yes	yes

• role - FortiExtender uplink port. type: str choices: primary, secondary more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  role	yes	yes	yes	yes
  [primary]	yes	yes	yes	yes
  [secondary]	yes	yes	yes	yes

• weight - WRR weight parameter. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  weight	yes	yes	yes	yes

• backhaul_interface - IPsec phase1 interface. Source system.interface.name. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  backhaul_interface	yes	yes	yes	yes

• backhaul_ip - IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  backhaul_ip	yes	yes	yes	yes

• ipsec_tunnel - IPsec tunnel name. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  ipsec_tunnel	yes	yes	yes	yes

• link_loadbalance - LAN extension link load balance strategy. type: str choices: activebackup, loadbalance more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  link_loadbalance	yes	yes	yes	yes
  [activebackup]	yes	yes	yes	yes
  [loadbalance]	yes	yes	yes	yes

• login_password - Set the managed extender"s administrator password. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  login_password	yes	yes	yes	yes

• login_password_change - Change or reset the administrator password of a managed extender (yes, default, or no). type: str choices: yes, default, no more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  login_password_change	yes	yes	yes	yes
  [yes]	yes	yes	yes	yes
  [default]	yes	yes	yes	yes
  [no]	yes	yes	yes	yes

• model - Model. type: str choices: FX201E, FX211E, FX200F, FXA11F, FXE11F, FXA21F, FXE21F, FXA22F, FXE22F, FX212F, FX311F, FX312F, FX511F, FVG21F, FVA21F, FVG22F, FVA22F, FX04DA more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  model	yes	yes	yes	yes
  [FX201E]	yes	yes	yes	yes
  [FX211E]	yes	yes	yes	yes
  [FX200F]	yes	yes	yes	yes
  [FXA11F]	yes	yes	yes	yes
  [FXE11F]	yes	yes	yes	yes
  [FXA21F]	yes	yes	yes	yes
  [FXE21F]	yes	yes	yes	yes
  [FXA22F]	yes	yes	yes	yes
  [FXE22F]	yes	yes	yes	yes
  [FX212F]	yes	yes	yes	yes
  [FX311F]	yes	yes	yes	yes
  [FX312F]	yes	yes	yes	yes
  [FX511F]	yes	yes	yes	yes
  [FVG21F]	yes	yes	yes	yes
  [FVA21F]	yes	yes	yes	yes
  [FVG22F]	yes	yes	yes	yes
  [FVA22F]	yes	yes	yes	yes
  [FX04DA]	yes	yes	yes	yes

• name - FortiExtender profile name. type: str required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes

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: FortiExtender extender profile configuration.
    fortios_extension_controller_extender_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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: "<your_own_value>"
                    switch_back_timer: "86400"
                default_sim: "sim1"
                gps: "disable"
                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"
                default_sim: "sim1"
                gps: "disable"
                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>"
            sms_notification:
                alert:
                    data_exhausted: "<your_own_value>"
                    fgt_backup_mode_switch: "<your_own_value>"
                    low_signal_strength: "<your_own_value>"
                    mode_switch: "<your_own_value>"
                    os_image_fallback: "<your_own_value>"
                    session_disconnect: "<your_own_value>"
                    system_reboot: "<your_own_value>"
                receiver:
                 -
                    alert: "system-reboot"
                    name: "default_name_61"
                    phone_number: "<your_own_value>"
                    status: "disable"
                status: "disable"
        enforce_bandwidth: "enable"
        extension: "wan-extension"
        id:  "67"
        lan_extension:
            backhaul:
             -
                name: "default_name_70"
                port: "wan"
                role: "primary"
                weight: "1"
            backhaul_interface: "<your_own_value> (source system.interface.name)"
            backhaul_ip: "<your_own_value>"
            ipsec_tunnel: "<your_own_value>"
            link_loadbalance: "activebackup"
        login_password: "<your_own_value>"
        login_password_change: "yes"
        model: "FX201E"
        name: "default_name_81"

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

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.