Interfaces Entity (v3)
1 min
an array of information about any network interface the order of the interface objects indicates the priority (“metric“) of each interface the first interface object in the array is the highest priority interface and traffic will be sent to that interface if there is an active connection all other interfaces are considered secondary interfaces see this page docid 7yk3i2x7twfjhoyuemv3a for more information the properties that are displayed will depend on the type of interface the interfaces entity contains the following required properties id \<font color="#704ae0">string\</font> \<font color="#01a0af">required\</font> the type of network interface (for example,"wireless wlan0" or "wired eth0") name \<font color="#704ae0">string\</font> \<font color="#01a0af">required\</font> a target network interface name (for example, "wlan0", "eth0", "usb0", or "ppp0") type \<font color="#704ae0">string\</font> \<font color="#01a0af">required\</font> the player interface type (one of "ethernet", "cellular", "wifi", "virtual", or "other") proto \<font color="#704ae0">string\</font> \<font color="#01a0af">required\</font> a configuration protocol or given network interface such as "static" or "dhcpv4" ssid \<font color="#704ae0">string\</font> \<font color="#01a0af">required\</font> the wireless network name, which is required if the interface is wlan these optional properties can also be used ip \<font color="#704ae0">string\[]\</font> \<font color="#704ae0">or \</font> \<font color="#704ae0">null\</font> \<font color="#01a0af">optional\</font> an array of the target ipv4 addresses (in cidr notation) to apply by the current network interface gateway \<font color="#704ae0">string or null\</font> \<font color="#01a0af">optional\</font> an ipv4 address of the player dns \<font color="#704ae0">string\[]\</font> \<font color="#01a0af">optional\</font> an array of the device dns addresses ratelimitduringinitialdownloads \<font color="#704ae0">int or null\</font> \<font color="#01a0af">optional\</font> the data rate limit for downloading content during initial downloads ratelimitinsidecontentdownloadwindow \<font color="#704ae0"> int or null\</font> \<font color="#01a0af">optional\</font> the data rate limit during content downloads ratelimitoutsidecontentdownloadwindow \<font color="#704ae0">int or null\</font> \<font color="#01a0af">optional\</font> the data rate limitation when content is not being downloaded contentdownloadenabled \<font color="#704ae0">bool\</font> \<font color="#01a0af">optional\</font> if true, content data can be downloaded using this connection true is the default textfeedsdownloadenabled \<font color="#704ae0">bool\</font> \<font color="#01a0af">optional\</font> if true, text feeds data can be downloaded using this connection true is the default mediafeedsdownloadenabled \<font color="#704ae0">bool\</font> \<font color="#01a0af">optional\</font> if true, media feed data can be downloaded using this connection true is the default healthreportingenabled \<font color="#704ae0">bool\</font> \<font color="#01a0af">optional\</font> if true, uploading health reporting data is enabled using this connection true is the default logsuploadenabled \<font color="#704ae0">bool\</font> \<font color="#01a0af">optional\</font> if true, uploading log updates is enabled using this connection true is the default passphrase \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> the wireless network password security \<font color="#704ae0">object\</font> \<font color="#01a0af">optional\</font> if this is provided, the following fields are required authentication \<font color="#704ae0">object\</font> mode \<font color="#704ae0">string\</font> possible network modes are "shared", "open", "eap" or "other" the default is “shared” passphrase \<font color="#704ae0">string\</font> the encrypted password for the network, if any encryption \<font color="#704ae0">object \</font> mode \<font color="#704ae0">string\</font> the possible encryption modes are "none", "wep", "tkip", "ccmp", "tkip,ccmp" or "other" the default is “tkip,ccmp” wpasettings \<font color="#704ae0">object\</font> \<font color="#01a0af">optional\</font> if this is provided, the following fields are required enablewpaenterpriseauthentication \<font color="#704ae0">bool\</font> if true, authentication via 802 1x (for wired) or wpa enterprise authentication (for wireless) is enabled wpaenterprisevariant \<font color="#704ae0">string\</font> either wpaenterpriseeaptls or wpaenterprisepeap eapcertificatetype \<font color="#704ae0">string\</font> either wpaeaptlspkcs or wpaeaptlspemorder eapcertificatefile \<font color="#704ae0">object\</font> an artifact object that has a name (which is a string) and an asset (which is a certificate file) this can default to null if it is not applicable eapcertificatepassphrase \<font color="#704ae0">string\</font> a passphrase to protect the client certificate this can default to null if it is not applicable eappemorderkeyfile \<font color="#704ae0">object\</font> an artifact object that has a name (which is a string) and an asset (which is a pem or der encoded x 509 certificate file) this can default to null if it is not applicable peapusername \<font color="#704ae0">string\</font> the peap username for authentication this can default to null if it is not applicable peappassphrase \<font color="#704ae0">string\</font> the peap password for authentication this can default to null if it is not applicable cacertificatefile \<font color="#704ae0">object\</font> an artifact object that has a name (which is a string) and an asset (which is a pem/der ca certificate file) this can default to null if it is not applicable