fortios_extender_controller_extender.rst

source:	fortios_extender_controller_extender.py
orphan:

fortios_extender_controller_extender -- Extender controller 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 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

Tips

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

FortiOS Version Compatibility

v6.0.0

v6.0.5

v6.0.11

v6.2.0

v6.2.3

v6.2.5

v6.2.7

v6.4.0

v6.4.1

v6.4.4

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.0.12

v7.2.0

fortios_extender_controller_extender

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

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
• extender_controller_extender - Extender controller configuration. type: dict more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  extender_controller_extender

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• aaa_shared_secret - AAA shared secret. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  aaa_shared_secret	yes	yes	yes	yes	yes	yes	yes	no	yes

• access_point_name - Access point name(APN). type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  access_point_name	yes	yes	yes	yes	yes	yes	yes	no	yes

• admin - FortiExtender Administration (enable or disable). type: str choices: disable, discovered, enable more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  admin	yes	yes	yes	yes	yes	yes	yes	no	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [discovered]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  allowaccess

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [ping]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [telnet]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [http]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [https]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [ssh]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [snmp]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• at_dial_script - Initialization AT commands specific to the MODEM. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  at_dial_script	yes	yes	yes	yes	yes	yes	yes	no	yes

• authorized - FortiExtender Administration (enable or disable). type: str choices: disable, enable more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  authorized

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  bandwidth_limit

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• billing_start_day - Billing start day. type: int more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  billing_start_day	yes	yes	yes	yes	yes	yes	yes	no	yes

• cdma_aaa_spi - CDMA AAA SPI. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  cdma_aaa_spi	yes	yes	yes	yes	yes	yes	yes	no	yes

• cdma_ha_spi - CDMA HA SPI. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  cdma_ha_spi	yes	yes	yes	yes	yes	yes	yes	no	yes

• cdma_nai - NAI for CDMA MODEMS. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  cdma_nai	yes	yes	yes	yes	yes	yes	yes	no	yes

• conn_status - Connection status. type: int more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  conn_status	yes	yes	yes	yes	yes	yes	yes	no	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  controller_report

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  interval	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  signal_threshold	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  status	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• description - Description. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  description

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• device_id - Device ID. type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  device_id

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• dial_mode - Dial mode (dial-on-demand or always-connect). type: str choices: dial-on-demand, always-connect more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  dial_mode	yes	yes	yes	yes	yes	yes	yes	no	yes
  [dial-on-demand]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [always-connect]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• dial_status - Dial status. type: int more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  dial_status	yes	yes	yes	yes	yes	yes	yes	no	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  enforce_bandwidth

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ext_name - FortiExtender name. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  ext_name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• extension_type - Extension type for this FortiExtender. type: str choices: wan-extension, lan-extension more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  extension_type

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [wan-extension]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [lan-extension]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ha_shared_secret - HA shared secret. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  ha_shared_secret	yes	yes	yes	yes	yes	yes	yes	no	yes

• id - FortiExtender serial number. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  id

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ifname - FortiExtender interface name. Source system.interface.name. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  ifname	yes	yes	yes	yes	yes	yes	yes	no	yes

• initiated_update - Allow/disallow network initiated updates to the MODEM. type: str choices: enable, disable more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  initiated_update	yes	yes	yes	yes	yes	yes	yes	no	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  login_password

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  login_password_change

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [yes]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [default]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [no]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• mode - FortiExtender mode. type: str choices: standalone, redundant more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  mode	yes	yes	yes	yes	yes	yes	yes	no	yes
  [standalone]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [redundant]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• modem_passwd - MODEM password. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  modem_passwd	yes	yes	yes	yes	yes	yes	yes	no	yes

• modem_type - MODEM type (CDMA, GSM/LTE or WIMAX). type: str choices: cdma, gsm/lte, wimax more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  modem_type	yes	yes	yes	yes	yes	yes	yes	no	yes
  [cdma]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [gsm/lte]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [wimax]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  modem1

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  auto_switch	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  disconnect_period	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  disconnect_threshold	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  switch_back_timer	yes	yes	yes	yes

• conn_status - Connection status. type: int more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  conn_status	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  gps	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• ifname - FortiExtender interface name. Source system.interface.name. type: str more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  ifname	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  preferred_carrier	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  redundant_intf	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim1_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim1_pin_code - SIM type: str more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim1_pin_code	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim2_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim2_pin_code - SIM type: str more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim2_pin_code	yes	yes	yes	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  modem2

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  auto_switch	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  disconnect_period	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  disconnect_threshold	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  switch_back_timer	yes	yes	yes	yes

• conn_status - Connection status. type: int more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  conn_status	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  gps	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• ifname - FortiExtender interface name. Source system.interface.name. type: str more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  ifname	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  preferred_carrier	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  redundant_intf	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  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...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim1_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim1_pin_code - SIM type: str more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim1_pin_code	yes	yes	yes	yes

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

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim2_pin	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes

• sim2_pin_code - SIM type: str more...

  	v6.4.0	v6.4.4	v7.0.0	v7.0.1
  sim2_pin_code	yes	yes	yes	yes

• multi_mode - MODEM mode of operation(3G,LTE,etc). type: str choices: auto, auto-3g, force-lte, force-3g, force-2g more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  multi_mode	yes	yes	yes	yes	yes	yes	yes	no	yes
  [auto]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [auto-3g]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [force-lte]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [force-3g]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [force-2g]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

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

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  name

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• override_allowaccess - Enable to override the extender profile management access configuration. type: str choices: enable, disable more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  override_allowaccess

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• override_enforce_bandwidth - Enable to override the extender profile enforce-bandwidth setting. type: str choices: enable, disable more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  override_enforce_bandwidth

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• override_login_password_change - Enable to override the extender profile login-password (administrator password) setting. type: str choices: enable, disable more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  override_login_password_change

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ppp_auth_protocol - PPP authentication protocol (PAP,CHAP or auto). type: str choices: auto, pap, chap more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  ppp_auth_protocol	yes	yes	yes	yes	yes	yes	yes	no	yes
  [auto]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [pap]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [chap]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• ppp_echo_request - Enable/disable PPP echo request. type: str choices: enable, disable more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  ppp_echo_request	yes	yes	yes	yes	yes	yes	yes	no	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• ppp_password - PPP password. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  ppp_password	yes	yes	yes	yes	yes	yes	yes	no	yes

• ppp_username - PPP username. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  ppp_username	yes	yes	yes	yes	yes	yes	yes	no	yes

• primary_ha - Primary HA. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  primary_ha	yes	yes	yes	yes	yes	yes	yes	no	yes

• profile - FortiExtender profile configuration. Source extender-controller.extender-profile.name. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  profile

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• quota_limit_mb - Monthly quota limit (MB). type: int more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  quota_limit_mb	yes	yes	yes	yes	yes	yes	yes	no	yes

• redial - Number of redials allowed based on failed attempts. type: str choices: none, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  redial	yes	yes	yes	yes	yes	yes	yes	no	yes
  [none]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [1]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [2]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [3]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [4]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [5]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [6]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [7]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [8]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [9]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [10]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

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

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  redundant_intf	yes	yes	yes	yes	yes	yes	yes	no	yes

• roaming - Enable/disable MODEM roaming. type: str choices: enable, disable more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  roaming	yes	yes	yes	yes	yes	yes	yes	no	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• role - FortiExtender work role(Primary, Secondary, None). type: str choices: none, primary, secondary more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  role	yes	yes	yes	yes	yes	yes	yes	no	yes
  [none]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [primary]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [secondary]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• secondary_ha - Secondary HA. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  secondary_ha	yes	yes	yes	yes	yes	yes	yes	no	yes

• sim_pin - SIM PIN. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  sim_pin	yes	yes	yes	yes	yes	yes	yes	no	yes

• vdom - VDOM. type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.2.0

  vdom

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• wan_extension - FortiExtender wan extension configuration. type: dict more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  wan_extension

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• modem1_extension - FortiExtender interface name. Source system.interface.name. type: str more...

  	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.0.12	v7.2.0
  modem1_extension	yes	yes	yes	yes	yes	yes	yes	yes	yes

• modem2_extension - FortiExtender interface name. Source system.interface.name. type: str more...

  	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.0.12	v7.2.0
  modem2_extension	yes	yes	yes	yes	yes	yes	yes	yes	yes

• wimax_auth_protocol - WiMax authentication protocol(TLS or TTLS). type: str choices: tls, ttls more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  wimax_auth_protocol	yes	yes	yes	yes	yes	yes	yes	no	yes
  [tls]	yes	yes	yes	yes	yes	yes	yes	n/a	yes
  [ttls]	yes	yes	yes	yes	yes	yes	yes	n/a	yes

• wimax_carrier - WiMax carrier. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  wimax_carrier	yes	yes	yes	yes	yes	yes	yes	no	yes

• wimax_realm - WiMax realm. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  wimax_realm	yes	yes	yes	yes	yes	yes	yes	no	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: 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"
        allowaccess: "ping"
        at_dial_script: "<your_own_value>"
        authorized: "disable"
        bandwidth_limit: "1024"
        billing_start_day: "14"
        cdma_aaa_spi: "<your_own_value>"
        cdma_ha_spi: "<your_own_value>"
        cdma_nai: "<your_own_value>"
        conn_status: "2147483647"
        controller_report:
            interval: "300"
            signal_threshold: "10"
            status: "disable"
        description: "<your_own_value>"
        device_id: "1024"
        dial_mode: "dial-on-demand"
        dial_status: "2147483647"
        enforce_bandwidth: "enable"
        ext_name: "<your_own_value>"
        extension_type: "wan-extension"
        ha_shared_secret: "<your_own_value>"
        id:  "27"
        ifname: "<your_own_value> (source system.interface.name)"
        initiated_update: "enable"
        login_password: "<your_own_value>"
        login_password_change: "yes"
        mode: "standalone"
        modem_passwd: "<your_own_value>"
        modem_type: "cdma"
        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"
            conn_status: "0"
            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: "600"
                disconnect_threshold: "3"
                signal: "disable"
                switch_back: "time"
                switch_back_time: "<your_own_value>"
                switch_back_timer: "86400"
            conn_status: "0"
            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_78"
        override_allowaccess: "enable"
        override_enforce_bandwidth: "enable"
        override_login_password_change: "enable"
        ppp_auth_protocol: "auto"
        ppp_echo_request: "enable"
        ppp_password: "<your_own_value>"
        ppp_username: "<your_own_value>"
        primary_ha: "<your_own_value>"
        profile: "<your_own_value> (source extender-controller.extender-profile.name)"
        quota_limit_mb: "5242880"
        redial: "none"
        redundant_intf: "<your_own_value>"
        roaming: "enable"
        role: "none"
        secondary_ha: "<your_own_value>"
        sim_pin: "<your_own_value>"
        vdom: "0"
        wan_extension:
            modem1_extension: "<your_own_value> (source system.interface.name)"
            modem2_extension: "<your_own_value> (source system.interface.name)"
        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

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.