fmgd_system_ltemodem – Configure USB LTE/WIMAX devices.

Added in version 1.0.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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

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
  • 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
  • device - The parameter in requested url type: str required: true
  • system_ltemodem - Configure USB LTE/WIMAX devices. type: dict
    • allow_modify_mtu_size (Alias name: allow-modify-mtu-size) Allow fortigate to modify the wireless wan interface mtu size. type: str choices: [disable, enable] more...
    • allow_modify_wireless_profile_table (Alias name: allow-modify-wireless-profile-table) Allow fortigate to modify the wireless profile table if the internal lte modem is running the generic modem firmware. type: str choices: [disable, enable] more...
    • apn Login apn string for pdp-ip packet data calls. type: str more...
    • authtype Authentication type for pdp-ip packet data calls. type: str choices: [none, pap, chap, both] more...
    • auto_connect (Alias name: auto-connect) Enable/disable modem auto connect. type: str choices: [disable, enable] more...
    • band_restrictions (Alias name: band-restrictions) Bitmaps for the allowed 3g and lte bands. type: str more...
    • data_plan (Alias name: data-plan) Data plan. type: list more...
      • billing_date (Alias name: billing-date) Lte modem billing date (1 - 31). type: int more...
      • billing_hour (Alias name: billing-hour) Lte modem billing hour (0 - 23). type: int more...
      • billing_period (Alias name: billing-period) type: str choices: [daily, weekly, monthly] more...
      • billing_weekday (Alias name: billing-weekday) Lte modem billing weekday (mon - sun). type: str choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
      • data_limit (Alias name: data-limit) Lte modem data limit in megabytes (0 - 100000, use zero for unlimited data). type: int more...
      • data_limit_alert (Alias name: data-limit-alert) Lte modem data usage percentage at which to trigger log. type: int more...
      • delay_switch_time (Alias name: delay-switch-time) Instead of sim switching shortly after data limit is reached, schedule a delay switch time in format hh:mm. type: str more...
      • iccid Dedicated data plan to specific iccid. type: str more...
      • name Data plan name. type: str more...
      • overage Enable/disable allowance of data overage as configured by data-limit (default = enable). type: str choices: [disable, enable] more...
      • target_sim_slot (Alias name: target-sim-slot) Target sim slot <1 or 2> type: str choices: [SIM-slot-1, SIM-slot-2] more...
    • data_usage_tracking (Alias name: data-usage-tracking) Enable/disable data usage tracking. type: str choices: [disable, enable] more...
    • dhcp_relay (Alias name: dhcp-relay) Enable/disable dhcp relay over modem. type: str choices: [disable, enable] more...
    • extra_init (Alias name: extra-init) Extra initialization string for usb lte/wimax devices. type: str more...
    • force_wireless_profile (Alias name: force-wireless-profile) Force to use wireless profile index (1 - 16), 0 if dont force. type: int more...
    • gps_port (Alias name: gps-port) Modem gps port index (0 - 20). type: int more...
    • gps_service (Alias name: gps-service) Enable/disable gps daemon. type: str choices: [disable, enable] more...
    • holddown_timer (Alias name: holddown-timer) Hold down timer (10 - 60 sec). type: int more...
    • image_preference (Alias name: image-preference) Modem image preference. type: str choices: [auto-sim, generic, att, verizon, telus, docomo, softbank, sprint, no-change] more...
    • interface The interface that the modem is acting as a redundant interface for. type: list more...
    • manual_handover (Alias name: manual-handover) Enable/disable manual handover from 3g to lte network. type: str choices: [disable, enable] more...
    • mode Modem operation mode. type: str choices: [standalone, redundant] more...
    • modem_port (Alias name: modem-port) Modem port index (0 - 20). type: int more...
    • network_type (Alias name: network-type) Wireless network type. type: str choices: [auto, umts-3g, lte, cdma-hrpd] more...
    • override_gateway (Alias name: override-gateway) Enable/disable lte gateway override (default = disable). type: str choices: [disable, enable] more...
    • passwd Authentication password for pdp-ip packet data calls. type: list more...
    • pdptype Packet data protocol (pdp) context type. type: str choices: [IPv4, IPv6, IPv4v6] more...
    • sim_switch (Alias name: sim-switch) Sim switch. type: dict more...
      • by_connection_state (Alias name: by-connection-state) Enable/disable automatic switch of sim by modem connection state (mobile data usage charges not incurred). type: str choices: [disable, enable] more...
      • by_data_plan (Alias name: by-data-plan) Enable/disable sim auto switch by data-plan config. type: str choices: [disable, enable] more...
      • by_link_monitor (Alias name: by-link-monitor) Enable/disable automatic switch of sim by link monitor (mobile data usage charges incurred). type: str choices: [disable, enable] more...
      • by_sim_state (Alias name: by-sim-state) Enable/disable automatic switch of sim when modem sim state is empty or in error. type: str choices: [disable, enable] more...
      • link_monitor (Alias name: link-monitor) Set link monitor name. type: list more...
      • modem_disconnection_time (Alias name: modem-disconnection-time) Configure connection-based automatic switch of sim time interval in seconds (30 - 86400). type: int more...
      • sim_slot (Alias name: sim-slot) Sim card slot (1 - 2). type: int more...
      • sim_switch_log_alert_interval (Alias name: sim-switch-log-alert-interval) When sim-switch > x threshold within y interval, trigger log event (y:1 - 99999 min, default = 15). type: int more...
      • sim_switch_log_alert_threshold (Alias name: sim-switch-log-alert-threshold) When sim-switch > x threshold within y interval, trigger log event (x:1 - 1000 times, default = 5). type: int more...
    • sim1_pin (Alias name: sim1-pin) Pin code for sim #1 (if applicable). type: list more...
    • sim2_pin (Alias name: sim2-pin) Pin code for sim #2 (if applicable). type: list more...
    • status Enable/disable usb lte/wimax device. type: str choices: [disable, enable] more...
    • username Authentication username for pdp-ip packet data calls. type: str more...
    • data_limit (Alias name: data-limit) Lte modem data limit (0 - 100000) mega bytes, 0 for unlimited data. type: int more...
    • sim_slot (Alias name: sim-slot) Sim card slot (1 - 2). type: int more...
    • billing_date (Alias name: billing-date) Lte modem billing date (1 - 31). type: int more...
    • connection_hot_swap (Alias name: connection-hot-swap) Set connection-based sim card hot swap time interval. type: str choices: [never, 5-minutes, 10-minutes] more...
    • sim_hot_swap (Alias name: sim-hot-swap) Enable/disable sim card auto detection and hot swap. type: str choices: [disable, enable] more...
    • connection_auto_switch (Alias name: connection-auto-switch) Connection auto switch. type: str choices: [disable, enable] more...
    • sim_auto_switch (Alias name: sim-auto-switch) Sim auto switch. type: str choices: [disable, enable] more...
    • gpsd_enabled (Alias name: gpsd-enabled) Gpsd enabled. 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure USB LTE/WIMAX devices.
      fortinet.fmgdevice.fmgd_system_ltemodem:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        system_ltemodem:
          # allow_modify_mtu_size: <value in [disable, enable]>
          # allow_modify_wireless_profile_table: <value in [disable, enable]>
          # apn: <string>
          # authtype: <value in [none, pap, chap, ...]>
          # auto_connect: <value in [disable, enable]>
          # band_restrictions: <string>
          # data_plan:
          #   - billing_date: <integer>
          #     billing_hour: <integer>
          #     billing_period: <value in [daily, weekly, monthly]>
          #     billing_weekday: <value in [sunday, monday, tuesday, ...]>
          #     data_limit: <integer>
          #     data_limit_alert: <integer>
          #     delay_switch_time: <string>
          #     iccid: <string>
          #     name: <string>
          #     overage: <value in [disable, enable]>
          #     target_sim_slot: <value in [SIM-slot-1, SIM-slot-2]>
          # data_usage_tracking: <value in [disable, enable]>
          # dhcp_relay: <value in [disable, enable]>
          # extra_init: <string>
          # force_wireless_profile: <integer>
          # gps_port: <integer>
          # gps_service: <value in [disable, enable]>
          # holddown_timer: <integer>
          # image_preference: <value in [auto-sim, generic, att, ...]>
          # interface: <list or string>
          # manual_handover: <value in [disable, enable]>
          # mode: <value in [standalone, redundant]>
          # modem_port: <integer>
          # network_type: <value in [auto, umts-3g, lte, ...]>
          # override_gateway: <value in [disable, enable]>
          # passwd: <list or string>
          # pdptype: <value in [IPv4, IPv6, IPv4v6]>
          # sim_switch:
          #   by_connection_state: <value in [disable, enable]>
          #   by_data_plan: <value in [disable, enable]>
          #   by_link_monitor: <value in [disable, enable]>
          #   by_sim_state: <value in [disable, enable]>
          #   link_monitor: <list or string>
          #   modem_disconnection_time: <integer>
          #   sim_slot: <integer>
          #   sim_switch_log_alert_interval: <integer>
          #   sim_switch_log_alert_threshold: <integer>
          # sim1_pin: <list or string>
          # sim2_pin: <list or string>
          # status: <value in [disable, enable]>
          # username: <string>
          # data_limit: <integer>
          # sim_slot: <integer>
          # billing_date: <integer>
          # connection_hot_swap: <value in [never, 5-minutes, 10-minutes]>
          # sim_hot_swap: <value in [disable, enable]>
          # connection_auto_switch: <value in [disable, enable]>
          # sim_auto_switch: <value in [disable, enable]>
          # gpsd_enabled: <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:

  • 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 sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

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)