fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular module – FortiExtender cellular configuration.

Note

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

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

New in fortinet.fortimanager 2.2.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

extender-profile

string / required

the parameter (extender-profile) in requested url

extensioncontroller_extenderprofile_cellular

dictionary

the top level parameters set

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

any

(list) no 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

no 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

any

(list) no description

sim2-pin

string

SIM

Choices:

  • "disable"

  • "enable"

sim2-pin-code

any

(list) no 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

no 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

any

(list) no description

sim2-pin

string

SIM

Choices:

  • "disable"

  • "enable"

sim2-pin-code

any

(list) no 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

no description

alert

list / elements=string

no 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"

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.

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 cellular configuration.
      fmgr_extensioncontroller_extenderprofile_cellular:
        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>
        extender-profile: <your own value>
        extensioncontroller_extenderprofile_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]>

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)