fmgr_extensioncontroller_extenderprofile – FortiExtender extender profile configuration.

New in version 2.2.0.

Synopsis

• This module is able to configure a FortiManager device.
• Examples include all parameters and values need to be adjusted to data sources before usage.
• Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

FortiManager Version Compatibility

6.0.0
False
6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
False	False	False	False	False	False	False	False	False	False	False
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
False	False	False	False	False	False	False	False	False	False	False	False	False
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
False	False	False	False	False	False	False	False	False
7.2.0	7.2.1	7.2.2	7.2.3
False	True	True	True
7.4.0
True

Parameters

• access_token -The token to access FortiManager without using username and password. type: str required: false
• bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
• proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
• rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
• rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
• state - The directive to create, update or delete an object type: str required: true choices: present, absent
• workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
• workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
• adom - The parameter in requested url type: str required: true
• extensioncontroller_extenderprofile - FortiExtender extender profile configuration. type: dict
• allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• cellular type: dict
• controller-report type: dict
• interval - Controller report interval. type: int more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• dataplan - No description for the parameter type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• modem1 type: dict
• auto-switch type: dict
• dataplan - Automatically switch based on data usage. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• switch-back - No description for the parameter type: array choices: [time, timer] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• conn-status - No description for the parameter type: int more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• default-sim - Default SIM selection. type: str choices: [sim1, sim2, carrier, cost] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• redundant-intf - Redundant interface. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• redundant-mode - FortiExtender mode. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim1-pin - SIM #1 PIN status. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim1-pin-code - No description for the parameter type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim2-pin - SIM #2 PIN status. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim2-pin-code - No description for the parameter type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• modem2 type: dict
• auto-switch type: dict
• dataplan - Automatically switch based on data usage. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• switch-back - No description for the parameter type: array choices: [time, timer] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• conn-status - No description for the parameter type: int more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• default-sim - Default SIM selection. type: str choices: [sim1, sim2, carrier, cost] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• redundant-intf - Redundant interface. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• redundant-mode - FortiExtender mode. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim1-pin - SIM #1 PIN status. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim1-pin-code - No description for the parameter type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim2-pin - SIM #2 PIN status. type: str choices: [disable, enable] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sim2-pin-code - No description for the parameter type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• sms-notification type: dict
• alert type: dict
• data-exhausted - Display string when data exhausted. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• receiver - No description for the parameter type: array more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

  • alert - No description for the parameter type: array choices: [system-reboot, data-exhausted, session-disconnect, low-signal-strength, mode-switch, os-image-fallback, fgt-backup-mode-switch] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

  • phone-number - Receiver phone number. type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• lan-extension type: dict
• backhaul - No description for the parameter type: array more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
    False	False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
    False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
    False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3
    False	True	True	True
    7.4.0
    True

• backhaul-interface - IPsec phase1 interface. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• backhaul-ip - IPsec phase1 IPv4/FQDN. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• login-password - No description for the parameter type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

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

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	True	True	True
  7.4.0
  True

• _is_factory_setting - No description for the parameter type: str choices: [disable, enable, ext] default: disable more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  False	False	False	False
  7.4.0
  True

Notes

Note

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
• To create or update an object, use state: present directive.
• To delete an object, use state: absent directive
• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: FortiExtender extender profile configuration.
     fmgr_extensioncontroller_extenderprofile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        extensioncontroller_extenderprofile:
           allowaccess:
             - https
             - ping
             - ssh
             - snmp
             - http
             - telnet
           bandwidth-limit: <value of integer>
           cellular:
              controller-report:
                 interval: <value of integer>
                 signal-threshold: <value of integer>
                 status: <value in [disable, enable]>
              dataplan: <value of string>
              modem1:
                 auto-switch:
                    dataplan: <value in [disable, enable]>
                    disconnect: <value in [disable, enable]>
                    disconnect-period: <value of integer>
                    disconnect-threshold: <value of integer>
                    signal: <value in [disable, enable]>
                    switch-back:
                      - time
                      - timer
                    switch-back-time: <value of string>
                    switch-back-timer: <value of integer>
                 conn-status: <value of integer>
                 default-sim: <value in [sim1, sim2, carrier, ...]>
                 gps: <value in [disable, enable]>
                 modem-id: <value of integer>
                 preferred-carrier: <value of string>
                 redundant-intf: <value of string>
                 redundant-mode: <value in [disable, enable]>
                 sim1-pin: <value in [disable, enable]>
                 sim1-pin-code: <value of string>
                 sim2-pin: <value in [disable, enable]>
                 sim2-pin-code: <value of string>
              modem2:
                 auto-switch:
                    dataplan: <value in [disable, enable]>
                    disconnect: <value in [disable, enable]>
                    disconnect-period: <value of integer>
                    disconnect-threshold: <value of integer>
                    signal: <value in [disable, enable]>
                    switch-back:
                      - time
                      - timer
                    switch-back-time: <value of string>
                    switch-back-timer: <value of integer>
                 conn-status: <value of integer>
                 default-sim: <value in [sim1, sim2, carrier, ...]>
                 gps: <value in [disable, enable]>
                 modem-id: <value of integer>
                 preferred-carrier: <value of string>
                 redundant-intf: <value of string>
                 redundant-mode: <value in [disable, enable]>
                 sim1-pin: <value in [disable, enable]>
                 sim1-pin-code: <value of string>
                 sim2-pin: <value in [disable, enable]>
                 sim2-pin-code: <value of string>
              sms-notification:
                 alert:
                    data-exhausted: <value of string>
                    fgt-backup-mode-switch: <value of string>
                    low-signal-strength: <value of string>
                    mode-switch: <value of string>
                    os-image-fallback: <value of string>
                    session-disconnect: <value of string>
                    system-reboot: <value of string>
                 receiver:
                   -
                       alert:
                         - system-reboot
                         - data-exhausted
                         - session-disconnect
                         - low-signal-strength
                         - mode-switch
                         - os-image-fallback
                         - fgt-backup-mode-switch
                       name: <value of string>
                       phone-number: <value of string>
                       status: <value in [disable, enable]>
                 status: <value in [disable, enable]>
           enforce-bandwidth: <value in [disable, enable]>
           extension: <value in [wan-extension, lan-extension]>
           id: <value of integer>
           lan-extension:
              backhaul:
                -
                    name: <value of string>
                    port: <value in [wan, lte1, lte2, ...]>
                    role: <value in [primary, secondary]>
                    weight: <value of integer>
              backhaul-interface: <value of string>
              backhaul-ip: <value of string>
              ipsec-tunnel: <value of string>
              link-loadbalance: <value in [activebackup, loadbalance]>
           login-password: <value of string>
           login-password-change: <value in [no, yes, default]>
           model: <value in [FX201E, FX211E, FX200F, ...]>
           name: <value of string>
           _is_factory_setting: <value in [disable, enable, ext]>

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:

• meta - The result of the request.returned: always type: dict
• request_url - The full url requested. returned: always type: str sample: /sys/login/user
• response_code - The status of api request. returned: always type: int sample: 0
• response_data - The data body of the api response. returned: optional type: list or dict
• response_message - The descriptive message of the api response. returned: always type: str sample: OK
• system_information - The information of the target system. returned: always type: dict
• rc - The status the request. returned: always type: int 0
• version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Xinwei Du (@dux-fortinet)
• Xing Li (@lix-fortinet)
• Jie Xue (@JieX19)
• Link Zheng (@chillancezen)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.