Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

An array of information about any network interface.

...

The properties that are displayed will depend on the type of interface:

id string requiredThe type of network interface (for example,"wireless_wlan0" or "wired_eth0")

name string required: A target network interface name (for example, "wlan0", "eth0", "usb0", or "ppp0")

type string required: The player interface type (one of "Ethernet", "Cellular", "WiFi", "Virtual", or "Other")

proto string required: A configuration protocol or given network interface such as "Static" or "DHCPv4"

ip  string[] or null required optional: An array of the target IPv4 addresses (in CIDR notation) to apply by the current network interface.

gateway string or null requiredoptional: An IPv4 address of the player.

dns string[] required optional: An array of the device DNS addresses

rateLimitDuringInitialDownloads int or null required optionalThe data rate limit for downloading content during initial downloads.

rateLimitInsideContentDownloadWindow int or null required optionalThe data rate limit during content downloads.

rateLimitOutsideContentDownloadWindow int or null required optionalThe data rate limitation when content is not being downloaded.

contentDownloadEnabled bool required optionalIf true, content data can be downloaded using this connection. True is the default.

textFeedsDownloadEnabled bool required optionalIf true, text feeds data can be downloaded using this connection. True is the default.

mediaFeedsDownloadEnabled bool required optionalIf true, media feed data can be downloaded using this connection. True is the default.

healthReportingEnabledboolrequiredoptional: If true, uploading health reporting data is enabled using this connection. True is the default.

logsUploadEnabled bool requiredoptionalIf true, uploading log updates is enabled using this connection. True is the default.

ssidstringrequiredThe wireless network name, which is required if the interface is WLAN.

passphrase string required optional: The wireless network password

security object optional: If this is provided, the following fields are required:

authentication object required optional:

mode string required optional: The possible network modes are "Shared", "Open", "EAP" or "Other". The default is “Shared”.

passphrase string required optional: The encrypted password for the network, if any.

encryption object required optional:

mode string required optional: The possible encryption modes are "None", "WEP", "TKIP", "CCMP", "TKIP,CCMP" or "Other". The default is “TKIP,CCMP”.

wpaSettings object optional: If this is provided, the following fields are required:

enableWPAEnterpriseAuthentication bool required: If true, authentication via 802.1x (for wired) or WPA Enterprise Authentication (for wireless) is enabled.

wpaEnterpriseVariant string required: Either WPAEnterpriseEapTls or WPAEnterprisePeap

eapCertificateType string required: Either WPAEapTlsPKCS or WPAEapTlsPEMorDER

eapCertificateFile object required:  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 string required: A passphrase to protect the client certificate. This can can default to null if it is not applicable.

eapPemOrDerKeyFile  object required: 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 can default to null if it is not applicable.

peapUsername  string required: The PEAP username for authentication. This can can default to null if it is not applicable.

peapPassphrase string required: The PEAP password for authentication. This can can default to null if it is not applicable.

caCertificateFile  object required: An artifact object that has a name (which is a string) and an asset (which is a PEM/DER CA certificate file). This can can default to null if it is not applicable.

...