Fortinet Document Library

Version:


Table of Contents

New Features

7.0.0
Download PDF
Copy Link

Add monitoring API to retrieve LTE modem statistics from 3G and 4G FortiGates 7.0.1

The REST API can retrieve dynamic information about LTE modems, such as RSSI signal strength, SIM information, data session, and usage levels from 3G and 4G FortiGates.

Sample LTE modem configuration
config system lte-modem
    set status enable
    set extra-init ''
    set manual-handover disable
    set force-wireless-profile 0
    set authtype none
    set apn "pda.bell.ca"
    set modem-port 255
    set billing-date 10
    set data-limit 200
    set network-type auto
    set auto-connect disable
    set gps-service enable
    set gps-port 255
    set data-usage-tracking enable
    set band-restrictions ''
    set image-preference auto-sim
    set allow-modify-wireless-profile-table enable
    set allow-modify-mtu-size enable
    set sim-hot-swap enable
    set connection-hot-swap 5-minutes
end

api/v2/monitor/system/lte-modem/status

The REST API from the sample LTE modem configuration has the following output:

{
  "http_method":"GET",
  "results":{
    "status":"enabled",
    "billing_date":10,
    "gps_status":true,
    "data_limit":200,
    "data_usage_tracking":true,
    "sim_auto_switch":true,
    "sim_auto_switch_time":"5-minutes",
    "manufacturer":"Sierra Wireless, Incorporated",
    "model":"EM7565",
    "revision":"SWI9X50C_01.14.02.00 2e210b jenkins 2020\/08\/19 14:18:39",
    "msisdn":"17782284617",
    "esn":"0",
    "imei":"353533100871675",
    "meid":"",
    "cell_id":"28373369",
    "hw_revision":"1.0",
    "sw_revision":"S.AT.2.5.1-00666-9655_GEN_PACK-1",
    "sku":"",
    "fsn":"UF01037177021047",
    "operating_mode":"QMI_DMS_OPERATING_MODE_ONLINE",
    "roaming":false,
    "signal":{
      "lte":{
        "rssi":-61,
        "rsrq":-13,
        "rsrp":-95,
        "snr":150
      }
    },
    "active_sim":{
      "slot":1,
      "status":"SIM_STATE_PRESENT",
      "iccid":"89302610104305638831",
      "imsi":"302610030602455",
      "carrier":"Bell Mobility",
      "country":"Canada"
    },
    "usage":{
      "rx":5001728,
      "tx":1311493
    },
    "connection_status":"QMI_WDS_CONNECTION_STATUS_CONNECTED",
    "ipv4":{
      "address":"100.114.242.233",
      "gateway":"100.114.242.234",
      "address_netmask":"255.255.255.252",
      "gateway_netmask":"255.255.255.252"
    },
    "interface":"wwan",
    "profile":{
      "profile_name":"profile3",
      "apn":"pda.bell.ca"
    }
  },
  "vdom":"root",
  "path":"system",
  "name":"lte-modem",
  "action":"status",
  "status":"success",
  "serial":"FG40FITK20000000",
  "version":"v7.0.1",
  "build":138
}

The API output matches output from the following commands:

  • diagnose sys lte-modem modem-details
  • diagnose sys lte-modem signal-info
  • diagnose sys lte-modem sim-info
  • diagnose sys lte-modem data-usage
  • diagnose sys lte-modem data-session-info
  • execute lte-modem wireless-profile list

Add monitoring API to retrieve LTE modem statistics from 3G and 4G FortiGates 7.0.1

The REST API can retrieve dynamic information about LTE modems, such as RSSI signal strength, SIM information, data session, and usage levels from 3G and 4G FortiGates.

Sample LTE modem configuration
config system lte-modem
    set status enable
    set extra-init ''
    set manual-handover disable
    set force-wireless-profile 0
    set authtype none
    set apn "pda.bell.ca"
    set modem-port 255
    set billing-date 10
    set data-limit 200
    set network-type auto
    set auto-connect disable
    set gps-service enable
    set gps-port 255
    set data-usage-tracking enable
    set band-restrictions ''
    set image-preference auto-sim
    set allow-modify-wireless-profile-table enable
    set allow-modify-mtu-size enable
    set sim-hot-swap enable
    set connection-hot-swap 5-minutes
end

api/v2/monitor/system/lte-modem/status

The REST API from the sample LTE modem configuration has the following output:

{
  "http_method":"GET",
  "results":{
    "status":"enabled",
    "billing_date":10,
    "gps_status":true,
    "data_limit":200,
    "data_usage_tracking":true,
    "sim_auto_switch":true,
    "sim_auto_switch_time":"5-minutes",
    "manufacturer":"Sierra Wireless, Incorporated",
    "model":"EM7565",
    "revision":"SWI9X50C_01.14.02.00 2e210b jenkins 2020\/08\/19 14:18:39",
    "msisdn":"17782284617",
    "esn":"0",
    "imei":"353533100871675",
    "meid":"",
    "cell_id":"28373369",
    "hw_revision":"1.0",
    "sw_revision":"S.AT.2.5.1-00666-9655_GEN_PACK-1",
    "sku":"",
    "fsn":"UF01037177021047",
    "operating_mode":"QMI_DMS_OPERATING_MODE_ONLINE",
    "roaming":false,
    "signal":{
      "lte":{
        "rssi":-61,
        "rsrq":-13,
        "rsrp":-95,
        "snr":150
      }
    },
    "active_sim":{
      "slot":1,
      "status":"SIM_STATE_PRESENT",
      "iccid":"89302610104305638831",
      "imsi":"302610030602455",
      "carrier":"Bell Mobility",
      "country":"Canada"
    },
    "usage":{
      "rx":5001728,
      "tx":1311493
    },
    "connection_status":"QMI_WDS_CONNECTION_STATUS_CONNECTED",
    "ipv4":{
      "address":"100.114.242.233",
      "gateway":"100.114.242.234",
      "address_netmask":"255.255.255.252",
      "gateway_netmask":"255.255.255.252"
    },
    "interface":"wwan",
    "profile":{
      "profile_name":"profile3",
      "apn":"pda.bell.ca"
    }
  },
  "vdom":"root",
  "path":"system",
  "name":"lte-modem",
  "action":"status",
  "status":"success",
  "serial":"FG40FITK20000000",
  "version":"v7.0.1",
  "build":138
}

The API output matches output from the following commands:

  • diagnose sys lte-modem modem-details
  • diagnose sys lte-modem signal-info
  • diagnose sys lte-modem sim-info
  • diagnose sys lte-modem data-usage
  • diagnose sys lte-modem data-session-info
  • execute lte-modem wireless-profile list