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

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

`Player Network Interface Settings` (this is the base definition):

- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The target network interface name (typically "eth0", “usb0”, “wlan0”, or “ppp0”)
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">read-only</font>: One of "Ethernet”, “WiFi”, “Virtual”, “Cellular”, or “Other”

`Player Ethernet Interface Settings`:

- `Enabled` <font color="#704ae0">bool</font> <font color="#01a0af">r</font><font color="#01a0af">ead-write</font>: Whether the player Ethernet settings are enabled
- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The target network interface name (typically “eth0”)
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">read-only</font>: "Ethernet”
- `Proto` <font color="#704ae0">NetworkConfigurationProtocol</font> <font color="#01a0af">read-write</font>: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"
- `IP` <font color="#704ae0">string[]</font> <font color="#01a0af">read-write</font>: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.
- `Gateway` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: In the “Static” network configuration, this defines the optional IPv4 address of the default gateway to be used by the current network interface. When absent, this interface is link local only.
- `DNS` <font color="#704ae0">string[]</font> r<font color="#01a0af">ead-write</font>: The DNS address(es) of the device
- `RateLimitDuringInitialDownloads` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
- `RateLimitInsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the [Player Synchronization Settings Entity (2022/06)](docId:9wQlt7eW-kTnaOgp5WTjD) define the inside content download window.
- `RateLimitOutsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
- `ContentDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether content data is allowed to be downloaded using this connection
- `TextFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether text feed data is allowed to be downloaded using this connection
- `MediaFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether media feed data is allowed to be downloaded using this connection
- `HealthReportingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading health reporting data is enabled using this connection
- `LogsUploadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading log updates is enabled using this connection

`Player Virtual Interface Settings`:

- `Enabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Defines whether the particular virtual network interface is enabled
- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The target network interface name (typically "eth0.110")
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">read-only</font>: "Virtual”
- `Parent`  <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The name of the associated link or parent ethernet interface.
- `VlanId` <font color="#704ae0">ushort</font> <font color="#01a0af">read-write</font>: The identifier of the virtual interface
- `Proto` <font color="#704ae0">NetworkConfigurationProtocol</font> <font color="#01a0af">read-write</font>: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"
- `IP` <font color="#704ae0">string[]</font> <font color="#01a0af">read-write</font>: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.
- `Gateway` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The IPv4 address of the player. "Null" means that a default route is absent.
- `DNS` <font color="#704ae0">string[]</font> <font color="#01a0af">read-write</font>: The DNS address(es) of the device
- `RateLimitDuringInitialDownloads` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
- `RateLimitInsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the [Player Synchronization Settings Entity (2022/06)](docId:9wQlt7eW-kTnaOgp5WTjD) define the inside content download window.
- `RateLimitOutsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
- `ContentDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether content data is allowed to be downloaded using this connection
- `TextFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether text feed data is allowed to be downloaded using this connection
- `MediaFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether media feed data is allowed to be downloaded using this connection
- `HealthReportingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading health reporting data is enabled using this connection
- `LogsUploadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading log updates is enabled using this connection

`Player WiFi Interface Settings`:

- `Enabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether the player WiFi settings are enabled
- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The target network interface name (typically "wlan0")
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">read-only</font>: "WiFi”
- `SSID` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The SSID (seen by users as a wireless network name)
- `Security` <font color="#704ae0">WiFiSecuritySettings</font> <font color="#01a0af">read-write</font>: Defines the authentication and encryption settings to be used:
  - `authentication`:
    - `mode` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: One of "Open", "Shared", "EAP", "Other" enumeration values
    - `passphrase` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: Applies only to "Shared" mode
  - `encryption`:
    - `mode` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: One of "None", "WEP", "TKIP", "AES", "Other" enumeration values
- `Proto` <font color="#704ae0">NetworkConfigurationProtocol</font> <font color="#01a0af">read-write</font>: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"
- `IP` <font color="#704ae0">string[]</font> <font color="#01a0af">read-write</font>: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.
- `Gateway` <font color="#704ae0">string</font> read-write: The IPv4 address of the player. "Null" means that a default route is absent.
- `DNS` <font color="#704ae0">string[]</font> <font color="#01a0af">read-write</font>: The DNS address(es) of the device
- `RateLimitDuringInitialDownloads` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
- `RateLimitInsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the [Player Synchronization Settings Entity (2022/06)](docId:9wQlt7eW-kTnaOgp5WTjD) define the inside content download window.
- `RateLimitOutsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
- `ContentDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether content data is allowed to be downloaded using this connection
- `TextFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether text feed data is allowed to be downloaded using this connection
- `MediaFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether media feed data is allowed to be downloaded using this connection
- `HealthReportingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading health reporting data is enabled using this connection
- `LogsUploadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading log updates is enabled using this connection

`Player Cellular Interface Settings`:

- `Enabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether the player cellular network interface settings are enabled
- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The target network interface name (typically “ppp0”)
- `Type` <font color="#704ae0">PlayerNetworkInterfaceType</font> <font color="#01a0af">read-only</font>: "Cellular”
- `Modems` <font color="#704ae0">PlayerCellularModemSettings[]</font> <font color="#01a0af">read-write</font>: A collection of the cellular modems `supported` by this network interface
  - `Model` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The model name of the supported cellular modem
  - `USBDeviceIds` <font color="#704ae0">string[]</font><font color="#01a0af"> read-write</font>: The identifiers of the supported cellular modems
- `SIMS` <font color="#704ae0">PlayerCellularModuleSettings[]</font> <font color="#01a0af">read-write</font>: A collection of the supported SIM cards
  - `MCC` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The mobile country code
  - `MNC` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The mobile network code
  - `Connection` <font color="#704ae0">PlayerCellularConnectionSettings</font> <font color="#01a0af">read-write</font>: The connection options to apply with this SIM card
- `RateLimitDuringInitialDownloads` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
- `RateLimitInsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the [Player Synchronization Settings Entity (2022/06)](docId:9wQlt7eW-kTnaOgp5WTjD) define the inside content download window.
- `RateLimitOutsideContentDownloadWindow` <font color="#704ae0">Nullable</font> <font color="#01a0af">read-write</font>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
- `ContentDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether content data is allowed to be downloaded using this connection
- `TextFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether text feed data is allowed to be downloaded using this connection
- `MediaFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether media feed data is allowed to be downloaded using this connection
- `HealthReportingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading health reporting data is enabled using this connection
- `LogsUploadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether uploading log updates is enabled using this connection