Querying Information About the Wireless Network Interface Status Resource

Function

This interface is used to query the information about wireless network interface resources.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/LTE/StatusInfo

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

The API is developed by default. The function is adapted based on the wireless NIC.

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/LTE/StatusInfo

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.type": "#MindXEdgeLTE.v1_0_0.MindXEdgeLTE",
    "@odata.context": "/redfish/v1/$metadata#Systems/LTE/StatusInfo",
    "@odata.id": "/redfish/v1/Systems/LTE/StatusInfo",
    "Id": "LTE StatusInfo",
    "Name": "LTE StatusInfo",
    "default_gateway": false,
    "lte_enable": true,
    "sim_exist": true,
    "state_lte": true,
    "state_data": true,
    "network_signal_level": 4,
    "network_type": "4G",
    "ip_addr": "xx.xx.xx.xx"
}

Response code: 200

Output Description

Table 1 Operation output description

Field

Type

Description

@odata.type

Character string

Type of the wireless network interface status resource.

@odata.context

Character string

OData description of the wireless network interface status resource.

@odata.id

Character string

Path to access the wireless network interface status resource.

Id

Character string

Unique ID of the wireless network interface status resource.

Name

Character string

Name of the wireless network interface status resource.

default_gateway

Boolean

Whether the default gateway is configured for eth0 or eth1. The default value is false.

  • true: Default gateway is configured.
  • false: Default gateway is not configured.

lte_enable

Boolean

Whether the wireless network is enabled. The default value is false.

  • true: LTE is enabled.
  • false: LTE is not enabled.

sim_exist

Boolean

Whether the SIM card is installed.

  • true: The SIM card is installed.
  • false: The SIM card is not installed.

state_data

Boolean

Whether mobile data is enabled.

  • true: enabled
  • false: disabled

state_lte

Boolean

Switch status of the wireless network.

  • true: enabled
  • false: disabled

network_signal_level

Number

Signal strength.

The value ranges from 0 to 5. The default value is None, indicating that mobile data switch is turned off. If the value is 0, the network is disconnected. In this case, the value of network_type is null.

network_type

Character string

Network status.

When the network is disconnected, the value is null.

ip_addr

Character string

IP address to be displayed after wireless network dial-up is connected.