Player Network Interface Settings Entity (2020/10)

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 string: The target network interface name (typically "eth0", “usb0”, “wlan0”, “ppp0”)
Type PlayerNetworkInterfaceType: One of "Ethernet”, “WiFi”, “Virtual”, “Cellular”, or “Other”

Player Ethernet Interface Settings:

Enabled bool: Whether the player Ethernet settings are enabled
Name string: The target network interface name (typically “eth0”)
Type PlayerNetworkInterfaceType: "Ethernet”
Proto NetworkConfigurationProtocol: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"
IP string[]: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.
Gateway string: 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 string[]: The DNS address(es) of the device
RateLimitDuringInitialDownloads Nullable<uint>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
RateLimitInsideContentDownloadWindow Nullable<uint>: 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) define the inside content download window.
RateLimitOutsideContentDownloadWindow Nullable<uint>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
ContentDownloadEnabled bool: Whether content data is allowed to be downloaded using this connection
TextFeedsDownloadEnabled bool: Whether text feed data is allowed to be downloaded using this connection
MediaFeedsDownloadEnabled bool: Whether media feed data is allowed to be downloaded using this connection
HealthReportingEnabled bool: Whether uploading health reporting data is enabled using this connection
LogsUploadEnabled bool: Whether uploading log updates is enabled using this connection

Player Virtual Interface Settings:

Enabled bool: Defines whether the particular virtual network interface is enabled
Name string: The target network interface name (typically "eth0.110")
Type PlayerNetworkInterfaceType: "Virtual”
Parent string: The name of the associated link or parent ethernet interface.
VlanId ushort: The identifier of the virtual interface
Proto NetworkConfigurationProtocol: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"
IP string[]: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.
Gateway string: The IPv4 address of the player. "Null" means that a default route is absent.
DNS string[]: The DNS address(es) of the device
RateLimitDuringInitialDownloads Nullable<uint>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
RateLimitInsideContentDownloadWindow Nullable<uint>: 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) define the inside content download window.
RateLimitOutsideContentDownloadWindow Nullable<uint>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
ContentDownloadEnabled bool: Whether content data is allowed to be downloaded using this connection
TextFeedsDownloadEnabled bool: Whether text feed data is allowed to be downloaded using this connection
MediaFeedsDownloadEnabled bool: Whether media feed data is allowed to be downloaded using this connection
HealthReportingEnabled bool: Whether uploading health reporting data is enabled using this connection
LogsUploadEnabled bool: Whether uploading log updates is enabled using this connection

Player WiFi Interface Settings:

Enabled bool: Whether the player WiFi settings are enabled
Name string: The target network interface name (typically "wlan0")
Type PlayerNetworkInterfaceType: "WiFi”
SSID string: The SSID (seen by users as a wireless network name)
Security WiFiSecuritySettings: Defines the authentication and encryption settings to be used
Proto NetworkConfigurationProtocol: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"
IP string[]: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.
Gateway string: The IPv4 address of the player. "Null" means that a default route is absent.
DNS string[]: The DNS address(es) of the device
RateLimitDuringInitialDownloads Nullable<uint>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
RateLimitInsideContentDownloadWindow Nullable<uint>: 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) define the inside content download window.
RateLimitOutsideContentDownloadWindow Nullable<uint>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
ContentDownloadEnabled bool: Whether content data is allowed to be downloaded using this connection
TextFeedsDownloadEnabled bool: Whether text feed data is allowed to be downloaded using this connection
MediaFeedsDownloadEnabled bool: Whether media feed data is allowed to be downloaded using this connection
HealthReportingEnabled bool: Whether uploading health reporting data is enabled using this connection
LogsUploadEnabled bool: Whether uploading log updates is enabled using this connection

Player Cellular Interface Settings:

Enabled bool: Whether the player cellular network interface settings are enabled
Name string: The target network interface name (typically “ppp0”)
Type PlayerNetworkInterfaceType: "Cellular”
Modems PlayerCellularModemSettings[]: A collection of the cellular modems supported by this network interface
- Model string: The model name of the supported cellular modem
- USBDeviceIds string[]: The identifiers of the supported cellular modems
SIMS PlayerCellularModuleSettings[]: A collection of the supported SIM cards
- MCC string: The mobile country code
- MNC string: The mobile network code
- Connection PlayerCellularConnectionSettings: The connection options to apply with this SIM card
RateLimitDuringInitialDownloads Nullable<uint>: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.
RateLimitInsideContentDownloadWindow Nullable<uint>: 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) define the inside content download window.
RateLimitOutsideContentDownloadWindow Nullable<uint>: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.
ContentDownloadEnabled bool: Whether content data is allowed to be downloaded using this connection
TextFeedsDownloadEnabled bool: Whether text feed data is allowed to be downloaded using this connection
MediaFeedsDownloadEnabled bool: Whether media feed data is allowed to be downloaded using this connection
HealthReportingEnabled bool: Whether uploading health reporting data is enabled using this connection
LogsUploadEnabled bool: Whether uploading log updates is enabled using this connection