fmgr_extendercontroller_extenderprofile_cellular – FortiExtender cellular configuration.

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


7.2.0
extendercontroller_extenderprofile_cellular yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • extender-profile - The parameter in requested url type: str required: true
  • extendercontroller_extenderprofile_cellular - no description type: dict
    • controller-report type: dict
      • interval - Controller report interval. type: int more...
      • signal-threshold - Controller report signal threshold. type: int more...
      • status - FortiExtender controller report status. type: str choices: [disable, enable] more...
    • dataplan - No description for the parameter type: str more...
    • modem1 type: dict
      • auto-switch type: dict
        • dataplan - Automatically switch based on data usage. type: str choices: [disable, enable] more...
        • disconnect - Auto switch by disconnect. type: str choices: [disable, enable] more...
        • disconnect-period - Automatically switch based on disconnect period. type: int more...
        • disconnect-threshold - Automatically switch based on disconnect threshold. type: int more...
        • signal - Automatically switch based on signal strength. type: str choices: [disable, enable] more...
        • switch-back - No description for the parameter type: array choices: [time, timer] more...
        • switch-back-time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str more...
        • switch-back-timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int more...
      • conn-status - No description for the parameter type: int more...
      • default-sim - Default SIM selection. type: str choices: [sim1, sim2, carrier, cost] more...
      • gps - FortiExtender GPS enable/disable. type: str choices: [disable, enable] more...
      • modem-id - Modem ID. type: int more...
      • preferred-carrier - Preferred carrier. type: str more...
      • redundant-intf - Redundant interface. type: str more...
      • redundant-mode - FortiExtender mode. type: str choices: [disable, enable] more...
      • sim1-pin - SIM #1 PIN status. type: str choices: [disable, enable] more...
      • sim1-pin-code - No description for the parameter type: str more...
      • sim2-pin - SIM #2 PIN status. type: str choices: [disable, enable] more...
      • sim2-pin-code - No description for the parameter type: str more...
    • modem2 type: dict
      • auto-switch type: dict
        • dataplan - Automatically switch based on data usage. type: str choices: [disable, enable] more...
        • disconnect - Auto switch by disconnect. type: str choices: [disable, enable] more...
        • disconnect-period - Automatically switch based on disconnect period. type: int more...
        • disconnect-threshold - Automatically switch based on disconnect threshold. type: int more...
        • signal - Automatically switch based on signal strength. type: str choices: [disable, enable] more...
        • switch-back - No description for the parameter type: array choices: [time, timer] more...
        • switch-back-time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str more...
        • switch-back-timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int more...
      • conn-status - No description for the parameter type: int more...
      • default-sim - Default SIM selection. type: str choices: [sim1, sim2, carrier, cost] more...
      • gps - FortiExtender GPS enable/disable. type: str choices: [disable, enable] more...
      • modem-id - Modem ID. type: int more...
      • preferred-carrier - Preferred carrier. type: str more...
      • redundant-intf - Redundant interface. type: str more...
      • redundant-mode - FortiExtender mode. type: str choices: [disable, enable] more...
      • sim1-pin - SIM #1 PIN status. type: str choices: [disable, enable] more...
      • sim1-pin-code - No description for the parameter type: str more...
      • sim2-pin - SIM #2 PIN status. type: str choices: [disable, enable] more...
      • sim2-pin-code - No description for the parameter type: str more...
    • sms-notification type: dict
      • alert type: dict
        • data-exhausted - Display string when data exhausted. type: str more...
        • fgt-backup-mode-switch - Display string when FortiGate backup mode switched. type: str more...
        • low-signal-strength - Display string when signal strength is low. type: str more...
        • mode-switch - Display string when mode is switched. type: str more...
        • os-image-fallback - Display string when falling back to a previous OS image. type: str more...
        • session-disconnect - Display string when session disconnected. type: str more...
        • system-reboot - Display string when system rebooted. type: str more...
      • receiver - No description for the parameter type: array more...
        • 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...
        • name - FortiExtender SMS notification receiver name. type: str more...
        • phone-number - Receiver phone number. type: str more...
        • status - SMS notification receiver status. type: str choices: [disable, enable] more...
      • status - FortiExtender SMS notification status. type: str choices: [disable, enable] more...

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: no description
     fmgr_extendercontroller_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>
        extendercontroller_extenderprofile_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]>

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • 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.