Add GPS coordinates to REST API monitor output for FortiExtender and LTE modems 7.0.2
When querying a FortiExtender or LTE modem through the FortiGate REST API, the GPS coordinates are included in the response.
FortiExtender
GPS reading must be enabled in the FortiExtender profile to use this feature.
To enable GPS reading in the GUI:
- Go to Network > FortiExtenders and select the Profiles tab.
- Double-click a profile to edit it.
- In the Modem 1 section, enable GPS.
- Click OK.
To enable GPS reading in the CLI:
config extender-controller extender-profile edit <name> config cellular config modem1 set gps enable end end next end
api/v2/monitor/extender-controller/extender
api/v2/monitor/extender-controller/extender?id=FX004TQ21000000 { "http_method":"GET", "results":[ { "name":"FX004TQ21000000", "id":"FXA11FTQ21000000", "system":{ "cpu":0, "memory":15, "ip":"192.168.1.110", "software_version":"FXTA11F-v7.0.1-build614", "hardware_version":"P26794-01", "mac":"**:**:**:**:**:**", "netmask":"255.255.255.0", "gateway":"192.168.1.99", "addr_type":"", "fgt_ip":"", "gps_lat":"49.304016", "gps_long":"-122.817596" }, "modem1":{ "data_plan":"Generic-plan", "physical_port":"1-2:1.3", "manufacturer":"Quectel", "product":"Quectel", "model":"EM06A", "revision":"EM06ALAR03A05M4G", "imsi":"111111111111111", "pin_status":"disable", "service":"LTE", "signal_strength":"52", "rssi":"-74", "connect_status":"CONN_STATE_CONNECTED", "gsm_profile":[ ], "cdma_profile":{ "NAI":"", "idx":"", "status":"", "home_addr":"", "primary_ha":"", "secondary_ha":"", "aaa_spi":"", "ha_spi":"" }, "esn_imei":"222222222222222", "activation_status":"Attached [profile 12]", "roaming_status":"Registered, home network", "usim_status":"", "oma_dm_version":"", "plmn":"", "band":"LTE BAND 2", "signal_rsrq":"-13", "signal_rsrp":"-104", "lte_sinr":"17", "lte_rssi":"-74", "lte_rs_throughput":"", "lte_ts_throughput":"", "lte_physical_cellid":"61D050E", "modem_type":"EM06A", "drc_cdma_evdo":"", "current_snr":"", "wireless_operator":"Fido", "operating_mode":"", "wireless_signal":"52", "usb_wan_mac":"", "sim1":{ "carrier":"", "phone_number":"", "status":"disable", "is_active":0, "imsi":"N\/A", "iccid":"", "maximum_allowed_data":0, "overage_allowed":"disable", "next_billing_date":"N\/A", "data_usage":0, "slot":1, "modem":1 }, "sim2":{ "carrier":"Fido", "phone_number":"+***********", "status":"enable", "is_active":1, "imsi":"111111111111111", "iccid":"33333333333333333333", "maximum_allowed_data":70, "overage_allowed":"disable", "next_billing_date":"2021-10-10", "data_usage":69, "slot":2, "modem":1 } } } ], "vdom":"root", "path":"extender-controller", "name":"extender", "action":"", "status":"success", "serial":"FG81EPTK00000000", "version":"v7.0.2", "build":211 }
LTE modem
GPS reading must be enabled on 3G4G models to use this feature.
To enable GPS reading:
config system lte-modem set gps-service enable end
api/v2/monitor/system/lte-modem/status
{ "http_method":"GET", "results":{ "status":"enabled", "billing_date":1, "gps_status":true, "data_limit":20, "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":"11111111111", "esn":"0", "imei":"222222222222222", "meid":"", "cell_id":"", "hw_revision":"1.0", "sw_revision":"S.AT.2.5.1-00666-9655_GEN_PACK-1", "sku":"", "fsn":"UF0000000000000000", "operating_mode":"QMI_DMS_OPERATING_MODE_ONLINE", "roaming":false, "signal":{ "wcdma":{ "rssi":-102, "ecio":29 }, "lte":{ "rssi":-72, "rsrq":-14, "rsrp":-103, "snr":120 } }, "active_sim":{ "slot":2, "status":"SIM_STATE_PRESENT", "iccid":"3333333333333333", "imsi":"444444444444444", "carrier":"Rogers AT&T Wireless", "country":"Canada" }, "usage":{ "rx":3209284, "tx":110981 }, "connection_status":"QMI_WDS_CONNECTION_STATUS_DISCONNECTED", "gps":{ "latitude":49.281737116666662, "longitude":-122.86043441666668, "timestamp":11871443012 } }, "vdom":"root", "path":"system", "name":"lte-modem", "action":"status", "status":"success", "serial":"FG40FITK2000000", "version":"v7.0.2", "build":205 }