Cloud APIs
...
Data Types (2020/10)
Custom Data Types (2020/10)

Player Network Interface Settings Entity (2020/10)

3min
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 string the target network interface name (typically "eth0", “usb0”, “wlan0”, “ppp0”) type playernetworkinterfacetype playernetworkinterfacetype one of "ethernet”, “wifi”, “virtual”, “cellular”, or “other” player ethernet interface settings enabled bool bool whether the player ethernet settings are enabled name string string the target network interface name (typically “eth0”) type playernetworkinterfacetype playernetworkinterfacetype "ethernet” proto networkconfigurationprotocol networkconfigurationprotocol defines a configuration protocol or given network interface such as "static" or "dhcpv4" ip string\[] string\[] in the “static” network configuration, this defines the target ipv4 address (in cidr notation) to apply by the current network interface gateway string 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\[] string\[] the dns address(es) of the device ratelimitduringinitialdownloads nullable\<uint> nullable\<uint> the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable\<uint> 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> nullable\<uint> the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool whether uploading log updates is enabled using this connection player virtual interface settings enabled bool bool defines whether the particular virtual network interface is enabled name string string the target network interface name (typically "eth0 110") type playernetworkinterfacetype playernetworkinterfacetype "virtual” parent string string the name of the associated link or parent ethernet interface vlanid ushort ushort the identifier of the virtual interface proto networkconfigurationprotocol networkconfigurationprotocol defines a configuration protocol or given network interface such as "static" or "dhcpv4" ip string\[] string\[] in the “static” network configuration, this defines the target ipv4 address (in cidr notation) to apply by the current network interface gateway string string the ipv4 address of the player "null" means that a default route is absent dns string\[] string\[] the dns address(es) of the device ratelimitduringinitialdownloads nullable\<uint> nullable\<uint> the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable\<uint> 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> nullable\<uint> the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool whether uploading log updates is enabled using this connection player wifi interface settings enabled bool bool whether the player wifi settings are enabled name string string the target network interface name (typically "wlan0") type playernetworkinterfacetype playernetworkinterfacetype "wifi” ssid string string the ssid (seen by users as a wireless network name) security wifisecuritysettings wifisecuritysettings defines the authentication and encryption settings to be used proto networkconfigurationprotocol networkconfigurationprotocol defines a configuration protocol or given network interface such as "static" or "dhcpv4" ip string\[] string\[] in the “static” network configuration, this defines the target ipv4 address (in cidr notation) to apply by the current network interface gateway string string the ipv4 address of the player "null" means that a default route is absent dns string\[] string\[] the dns address(es) of the device ratelimitduringinitialdownloads nullable\<uint> nullable\<uint> the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable\<uint> 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> nullable\<uint> the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool whether uploading log updates is enabled using this connection player cellular interface settings enabled bool bool whether the player cellular network interface settings are enabled name string string the target network interface name (typically “ppp0”) type playernetworkinterfacetype playernetworkinterfacetype "cellular” modems playercellularmodemsettings\[] playercellularmodemsettings\[] a collection of the cellular modems supported by this network interface model string string the model name of the supported cellular modem usbdeviceids string\[] string\[] the identifiers of the supported cellular modems sims playercellularmodulesettings\[] playercellularmodulesettings\[] a collection of the supported sim cards mcc string string the mobile country code mnc string string the mobile network code connection playercellularconnectionsettings playercellularconnectionsettings the connection options to apply with this sim card ratelimitduringinitialdownloads nullable\<uint> nullable\<uint> the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable\<uint> 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 nullable \<uint> \<uint> the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool whether uploading log updates is enabled using this connection