Player Network Interface Status Entity (2022/06)

Owned by BrightSign TechDocs
Last updated: Nov 03, 2023
2 min read

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 string read-only:  The reported network interface name (typically "eth0", “usb0”, “wlan0”, “ppp0”)

  • Type PlayerNetworkInterfaceType read-only: One of "Ethernet”, “WiFi”, “Virtual”, or “Other”

  • Proto NetworkConfigurationProtocol read-only: Comma-separated { "Static", "DHCPv4", "DHCPv6", "NDP" } enumeration values

  • Mac string read-only: The reported media access control (mac) address

  • Ip string[] read-only:  The reported internet protocol (IP) address, may contain zero or more IPv4 and IPv6 addresses in CIDR notation

  • Gateway string read-only: The reported IPv4 default gateway address. "Null" means that a default route is absent.

  • Metric Nullable<uint> read-only: 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 string read-only:  The reported network interface name (typically “ppp0”)

  • Type PlayerNetworkInterfaceType read-only: "Cellular"

  • Proto NetworkConfigurationProtocol read-only: Comma-separated { "Static", "DHCPv4", "DHCPv6", "NDP" } enumeration values

  • Mac string read-only: The reported media access control (mac) address

  • Ip string[] read-only:  The reported internet protocol (IP) address, may contain zero or more IPv4 and IPv6 addresses in CIDR notation

  • Gateway string read-only: The reported IPv4 default gateway address. "Null" means that a default route is absent.

  • Metric Nullable<uint> read-only: The priority value assigned to the IP route for this network interface. "Null" means that a default route is absent

  • Modem:

    • imei string read-only: The unique International Mobile Equipment Identity number

    • manufacturer string read-only: The name of the manufacturer 

    • model string read-only: The model identifier

    • revision string read-only: The model revision identifier

  • Sims:

    • status string read-only: The interface status (for example, "OK")

    • iccid string read-only: The globally unique identifier for the SIM card

    • connection :

      • network string read-only: The reported network name 

      • signal short read-only: The reported signal strength