---
title: Player Network Interface Status Entity (2022/06)
slug: develop/player-network-interface-status-entity-202206
docTags: 
createdAt: 2025-03-11T07:03:30.743Z
---

The Player Network Interface status entities follow one of the structures below, depending on the type of network interface (see `Type`):

`Player Network Interface Status`:

- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported network interface name (typically "eth0", “usb0”, “wlan0”, “ppp0”)
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">read-only</font>: One of "Ethernet”, “WiFi”, “Virtual”, or “Other”
- `Proto` <font color="#704ae0">NetworkConfigurationProtocol</font> <font color="#01a0af">read-only</font>: Comma-separated \{ "Static", "DHCPv4", "DHCPv6", "NDP" } enumeration values
- `Mac` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported media access control (mac) address
- `Ip` <font color="#704ae0">string[]</font> <font color="#01a0af">read-only</font>: The reported internet protocol (IP) address, may contain zero or more IPv4 and IPv6 addresses in CIDR notation
- `Gateway` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported IPv4 default gateway address. "Null" means that a default route is absent.
- `Metric` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-only</font>: The priority value assigned to the IP route for this network interface. "Null" means that a default route is absent.

`Player Cellular Interface Status`:

- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported network interface name (typically “ppp0”)
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">r</font><font color="#01a0af">ead-only</font>: "Cellular"
- `Proto` <font color="#704ae0">NetworkConfigurationProtocol</font> <font color="#01a0af">read-only</font>: Comma-separated \{ "Static", "DHCPv4", "DHCPv6", "NDP" } enumeration values
- `Mac` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported media access control (mac) address
- `Ip` <font color="#704ae0">string[]</font> <font color="#01a0af">read-only</font>: The reported internet protocol (IP) address, may contain zero or more IPv4 and IPv6 addresses in CIDR notation
- `Gateway` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported IPv4 default gateway address. "Null" means that a default route is absent.
- `Metric` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-only</font>: The priority value assigned to the IP route for this network interface. "Null" means that a default route is absent
- `Modem`:
  - `imei` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The unique International Mobile Equipment Identity number
  - `manufacturer` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The name of the manufacturer 
  - `model` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The model identifier
  - `revision` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The model revision identifier
- `Sims:`
  - `status` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The interface status (for example, "OK")
  - `iccid` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The globally unique identifier for the SIM card
  - `connection` :
    - `network` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The reported network name 
    - `signal` <font color="#704ae0">short</font> <font color="#01a0af">read-only</font>: The reported signal strength