You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_extendercontroller_extenderprofile module – FortiExtender extender profile configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_extendercontroller_extenderprofile.

New in fortinet.fortimanager 2.1.6

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	the parameter (adom) in requested url
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
extendercontroller_extenderprofile dictionary	the top level parameters set
allowaccess list / elements=string	description Choices: "https" "ping" "ssh" "snmp" "http" "telnet"
bandwidth-limit integer	FortiExtender LAN extension bandwidth limit
cellular dictionary	no description
controller-report dictionary	no description
interval integer	Controller report interval.
signal-threshold integer	Controller report signal threshold.
status string	FortiExtender controller report status. Choices: "disable" "enable"
dataplan string	description
modem1 dictionary	no description
auto-switch dictionary	no description
dataplan string	Automatically switch based on data usage. Choices: "disable" "enable"
disconnect string	Auto switch by disconnect. Choices: "disable" "enable"
disconnect-period integer	Automatically switch based on disconnect period.
disconnect-threshold integer	Automatically switch based on disconnect threshold.
signal string	Automatically switch based on signal strength. Choices: "disable" "enable"
switch-back list / elements=string	description Choices: "time" "timer"
switch-back-time string	Automatically switch over to preferred SIM/carrier at a specified time in UTC
switch-back-timer integer	Automatically switch over to preferred SIM/carrier after the given time
conn-status integer	no description
default-sim string	Default SIM selection. Choices: "sim1" "sim2" "carrier" "cost"
gps string	FortiExtender GPS enable/disable. Choices: "disable" "enable"
modem-id integer	Modem ID.
preferred-carrier string	Preferred carrier.
redundant-intf string	Redundant interface.
redundant-mode string	FortiExtender mode. Choices: "disable" "enable"
sim1-pin string	SIM Choices: "disable" "enable"
sim1-pin-code string	description
sim2-pin string	SIM Choices: "disable" "enable"
sim2-pin-code string	description
modem2 dictionary	no description
auto-switch dictionary	no description
dataplan string	Automatically switch based on data usage. Choices: "disable" "enable"
disconnect string	Auto switch by disconnect. Choices: "disable" "enable"
disconnect-period integer	Automatically switch based on disconnect period.
disconnect-threshold integer	Automatically switch based on disconnect threshold.
signal string	Automatically switch based on signal strength. Choices: "disable" "enable"
switch-back list / elements=string	description Choices: "time" "timer"
switch-back-time string	Automatically switch over to preferred SIM/carrier at a specified time in UTC
switch-back-timer integer	Automatically switch over to preferred SIM/carrier after the given time
conn-status integer	no description
default-sim string	Default SIM selection. Choices: "sim1" "sim2" "carrier" "cost"
gps string	FortiExtender GPS enable/disable. Choices: "disable" "enable"
modem-id integer	Modem ID.
preferred-carrier string	Preferred carrier.
redundant-intf string	Redundant interface.
redundant-mode string	FortiExtender mode. Choices: "disable" "enable"
sim1-pin string	SIM Choices: "disable" "enable"
sim1-pin-code string	description
sim2-pin string	SIM Choices: "disable" "enable"
sim2-pin-code string	description
sms-notification dictionary	no description
alert dictionary	no description
data-exhausted string	Display string when data exhausted.
fgt-backup-mode-switch string	Display string when FortiGate backup mode switched.
low-signal-strength string	Display string when signal strength is low.
mode-switch string	Display string when mode is switched.
os-image-fallback string	Display string when falling back to a previous OS image.
session-disconnect string	Display string when session disconnected.
system-reboot string	Display string when system rebooted.
receiver list / elements=dictionary	description
alert list / elements=string	description Choices: "system-reboot" "data-exhausted" "session-disconnect" "low-signal-strength" "mode-switch" "os-image-fallback" "fgt-backup-mode-switch"
name string	FortiExtender SMS notification receiver name.
phone-number string	Receiver phone number.
status string	SMS notification receiver status. Choices: "disable" "enable"
status string	FortiExtender SMS notification status. Choices: "disable" "enable"
enforce-bandwidth string	Enable/disable enforcement of bandwidth on LAN extension interface. Choices: "disable" "enable"
extension string	Extension option. Choices: "wan-extension" "lan-extension"
id integer	ID.
lan-extension dictionary	no description
backhaul list / elements=dictionary	description
name string	FortiExtender LAN extension backhaul name.
port string	FortiExtender uplink port. Choices: "wan" "lte1" "lte2" "port1" "port2" "port3" "port4" "port5" "sfp"
role string	FortiExtender uplink port. Choices: "primary" "secondary"
weight integer	WRR weight parameter.
backhaul-interface string	IPsec phase1 interface.
backhaul-ip string	IPsec phase1 IPv4/FQDN.
ipsec-tunnel string	IPsec tunnel name.
link-loadbalance string	LAN extension link load balance strategy. Choices: "activebackup" "loadbalance"
login-password string	description
login-password-change string	Change or reset the administrator password of a managed extender Choices: "no" "yes" "default"
model string	Model. Choices: "FX201E" "FX211E" "FX200F" "FXA11F" "FXE11F" "FXA21F" "FXE21F" "FXA22F" "FXE22F" "FX212F" "FX311F" "FX312F" "FX511F" "FVG21F" "FVA21F" "FVG22F" "FVA22F" "FX04DA" "FX04DN" "FX04DI"
name string	FortiExtender profile name.
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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_extendercontroller_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]>
        extendercontroller_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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)