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

Note

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

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

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

Control management access to the managed extender.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

bandwidth_limit

aliases: bandwidth-limit

integer

FortiExtender LAN extension bandwidth limit

cellular

dictionary

Cellular.

controller_report

aliases: controller-report

dictionary

Controller report.

interval

integer

Controller report interval.

signal_threshold

aliases: signal-threshold

integer

Controller report signal threshold.

status

string

FortiExtender controller report status.

Choices:

  • "disable"

  • "enable"

dataplan

any

(list or str) Dataplan names.

modem1

dictionary

Modem1.

auto_switch

aliases: auto-switch

dictionary

Auto switch.

dataplan

string

Automatically switch based on data usage.

Choices:

  • "disable"

  • "enable"

disconnect

string

Auto switch by disconnect.

Choices:

  • "disable"

  • "enable"

disconnect_period

aliases: disconnect-period

integer

Automatically switch based on disconnect period.

disconnect_threshold

aliases: disconnect-threshold

integer

Automatically switch based on disconnect threshold.

signal

string

Automatically switch based on signal strength.

Choices:

  • "disable"

  • "enable"

switch_back

aliases: switch-back

list / elements=string

Auto switch with switch back multi-options.

Choices:

  • "time"

  • "timer"

switch_back_time

aliases: switch-back-time

string

Automatically switch over to preferred SIM/carrier at a specified time in UTC

switch_back_timer

aliases: switch-back-timer

integer

Automatically switch over to preferred SIM/carrier after the given time

conn_status

aliases: conn-status

integer

Conn status.

default_sim

aliases: default-sim

string

Default SIM selection.

Choices:

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

string

FortiExtender GPS enable/disable.

Choices:

  • "disable"

  • "enable"

modem_id

aliases: modem-id

integer

Modem ID.

preferred_carrier

aliases: preferred-carrier

string

Preferred carrier.

redundant_intf

aliases: redundant-intf

string

Redundant interface.

redundant_mode

aliases: redundant-mode

string

FortiExtender mode.

Choices:

  • "disable"

  • "enable"

sim1_pin

aliases: sim1-pin

string

SIM

Choices:

  • "disable"

  • "enable"

sim1_pin_code

aliases: sim1-pin-code

any

(list) SIM

sim2_pin

aliases: sim2-pin

string

SIM

Choices:

  • "disable"

  • "enable"

sim2_pin_code

aliases: sim2-pin-code

any

(list) SIM

modem2

dictionary

Modem2.

auto_switch

aliases: auto-switch

dictionary

Auto switch.

dataplan

string

Automatically switch based on data usage.

Choices:

  • "disable"

  • "enable"

disconnect

string

Auto switch by disconnect.

Choices:

  • "disable"

  • "enable"

disconnect_period

aliases: disconnect-period

integer

Automatically switch based on disconnect period.

disconnect_threshold

aliases: disconnect-threshold

integer

Automatically switch based on disconnect threshold.

signal

string

Automatically switch based on signal strength.

Choices:

  • "disable"

  • "enable"

switch_back

aliases: switch-back

list / elements=string

Auto switch with switch back multi-options.

Choices:

  • "time"

  • "timer"

switch_back_time

aliases: switch-back-time

string

Automatically switch over to preferred SIM/carrier at a specified time in UTC

switch_back_timer

aliases: switch-back-timer

integer

Automatically switch over to preferred SIM/carrier after the given time

conn_status

aliases: conn-status

integer

Conn status.

default_sim

aliases: default-sim

string

Default SIM selection.

Choices:

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

string

FortiExtender GPS enable/disable.

Choices:

  • "disable"

  • "enable"

modem_id

aliases: modem-id

integer

Modem ID.

preferred_carrier

aliases: preferred-carrier

string

Preferred carrier.

redundant_intf

aliases: redundant-intf

string

Redundant interface.

redundant_mode

aliases: redundant-mode

string

FortiExtender mode.

Choices:

  • "disable"

  • "enable"

sim1_pin

aliases: sim1-pin

string

SIM

Choices:

  • "disable"

  • "enable"

sim1_pin_code

aliases: sim1-pin-code

any

(list) SIM

sim2_pin

aliases: sim2-pin

string

SIM

Choices:

  • "disable"

  • "enable"

sim2_pin_code

aliases: sim2-pin-code

any

(list) SIM

sms_notification

aliases: sms-notification

dictionary

Sms notification.

alert

dictionary

Alert.

data_exhausted

aliases: data-exhausted

string

Display string when data exhausted.

fgt_backup_mode_switch

aliases: fgt-backup-mode-switch

string

Display string when FortiGate backup mode switched.

low_signal_strength

aliases: low-signal-strength

string

Display string when signal strength is low.

mode_switch

aliases: mode-switch

string

Display string when mode is switched.

os_image_fallback

aliases: os-image-fallback

string

Display string when falling back to a previous OS image.

session_disconnect

aliases: session-disconnect

string

Display string when session disconnected.

system_reboot

aliases: system-reboot

string

Display string when system rebooted.

receiver

list / elements=dictionary

Receiver.

alert

list / elements=string

Alert multi-options.

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

aliases: 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

aliases: 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 / required

ID.

lan_extension

aliases: lan-extension

dictionary

Lan extension.

backhaul

list / elements=dictionary

Backhaul.

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

aliases: backhaul-interface

string

IPsec phase1 interface.

backhaul_ip

aliases: backhaul-ip

string

IPsec phase1 IPv4/FQDN.

ipsec_tunnel

aliases: ipsec-tunnel

string

IPsec tunnel name.

link_loadbalance

aliases: link-loadbalance

string

LAN extension link load balance strategy.

Choices:

  • "activebackup"

  • "loadbalance"

login_password

aliases: login-password

any

(list) Set the managed extenders administrator password.

login_password_change

aliases: 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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: FortiExtender extender profile configuration.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        extendercontroller_extenderprofile:
          allowaccess:
            - "https"
            - "ping"
            - "ssh"
            - "snmp"
            - "http"
            - "telnet"
          bandwidth_limit: <integer>
          cellular:
            controller_report:
              interval: <integer>
              signal_threshold: <integer>
              status: <value in [disable, enable]>
            dataplan: <list or string>
            modem1:
              auto_switch:
                dataplan: <value in [disable, enable]>
                disconnect: <value in [disable, enable]>
                disconnect_period: <integer>
                disconnect_threshold: <integer>
                signal: <value in [disable, enable]>
                switch_back:
                  - "time"
                  - "timer"
                switch_back_time: <string>
                switch_back_timer: <integer>
              conn_status: <integer>
              default_sim: <value in [sim1, sim2, carrier, ...]>
              gps: <value in [disable, enable]>
              modem_id: <integer>
              preferred_carrier: <string>
              redundant_intf: <string>
              redundant_mode: <value in [disable, enable]>
              sim1_pin: <value in [disable, enable]>
              sim1_pin_code: <list or string>
              sim2_pin: <value in [disable, enable]>
              sim2_pin_code: <list or string>
            modem2:
              auto_switch:
                dataplan: <value in [disable, enable]>
                disconnect: <value in [disable, enable]>
                disconnect_period: <integer>
                disconnect_threshold: <integer>
                signal: <value in [disable, enable]>
                switch_back:
                  - "time"
                  - "timer"
                switch_back_time: <string>
                switch_back_timer: <integer>
              conn_status: <integer>
              default_sim: <value in [sim1, sim2, carrier, ...]>
              gps: <value in [disable, enable]>
              modem_id: <integer>
              preferred_carrier: <string>
              redundant_intf: <string>
              redundant_mode: <value in [disable, enable]>
              sim1_pin: <value in [disable, enable]>
              sim1_pin_code: <list or string>
              sim2_pin: <value in [disable, enable]>
              sim2_pin_code: <list or string>
            sms_notification:
              alert:
                data_exhausted: <string>
                fgt_backup_mode_switch: <string>
                low_signal_strength: <string>
                mode_switch: <string>
                os_image_fallback: <string>
                session_disconnect: <string>
                system_reboot: <string>
              receiver:
                -
                  alert:
                    - "system-reboot"
                    - "data-exhausted"
                    - "session-disconnect"
                    - "low-signal-strength"
                    - "mode-switch"
                    - "os-image-fallback"
                    - "fgt-backup-mode-switch"
                  name: <string>
                  phone_number: <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: <integer>
          lan_extension:
            backhaul:
              -
                name: <string>
                port: <value in [wan, lte1, lte2, ...]>
                role: <value in [primary, secondary]>
                weight: <integer>
            backhaul_interface: <string>
            backhaul_ip: <string>
            ipsec_tunnel: <string>
            link_loadbalance: <value in [activebackup, loadbalance]>
          login_password: <list or string>
          login_password_change: <value in [no, yes, default]>
          model: <value in [FX201E, FX211E, FX200F, ...]>
          name: <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)