Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated as per DOCS-844

...

...

...

...

...

...

...

...

...

...

...

...


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

...

If the network_interface is specified as an integer, the interface must currently exist on the player; otherwise, the object-creation function will return Invalid. Conversely, specifying the network_interface as a string allows you to create a roNetworkConfiguration instance for an interface that is not currently present on the player.

The network interface can be configured as a VLAN using the following string format: "[parent_interface].[vlan_id]" (e.g "eth0.42"). Once the VLAN interface(s) are configured, they must be enabled on the parent network interface (e.g. "eth0") using the SetVlanIds() method. VLAN interfaces use DHCP by default. They are supported on Series 4 (XTx44, XDx34, HDx24, LS424) and Series 3 (XTx43, XDx33, HDx23, LS423, HO523) players only.

...

SetWiFiFrequencies(frequencies As String) As Boolean

Sets valid WiFi frequencies to specified range. Supports 2GHz, 5GHz, or list of frequencies written in MHz("2412 2417"). It returns true if the frequency is successfully set.

SetWiFiAccessPointMode(enable as Boolean) As Boolean

...

ValueTypeHost/InterfaceDescription

metric

Integer

Interface

Returns the current routing metric for the interface. See the SetRoutingMetric() entry for more details.

dhcp

Boolean

Interface

Returns true if the system is currently configured to use DHCP. Returns false otherwise.

hostname

String

Host

The currently configured host name

mdns_hostname

String

Host

The Zeroconf host name currently in use. This may be longer than the host name if there is a collision on the current network.

ethernet_mac

String

Interface

The Ethernet MAC address

ip4_address

String

Interface

The current IPv4 address. If none is currently set, the string will be empty.

ip4_netmask

String

Interface

The current IPv4 network mask. If none is currently set, the string will be empty.

ip4_broadcast

String

Interface

The current IPv4 broadcast address. If none is currently set, the string will be empty.

ip4_gateway

String

Interface

The current IPv4 gateway address. If none is currently set, the string will be empty.

domain

String

HostThe current domain suffix

A whitespace-separated list of domains that will be appended to unqualified names when resolving them

domainsroArray of StringsHostThe domains that will be appended to uniqualified names when resolving name

dns_servers

roArray of Strings

Host

The currently active DNS servers

time_server

String

Host

The current time server

configured_proxy

String

Host

The currently configured proxy. This may contain magic characters as explained under SetProxy() above.

current_proxy

String

Host

The currently active proxy. Any magic characters will have been replaced as explained under SetProxy() above.

shape_inbound

Integer

Interface

The current bandwidth shaping for inbound traffic determined by the SetInboundShaperRate() method.

type

String

Interface

Either "wired" or "wifi"

link

Boolean

Interface

Indicates whether the network interface is currently connected.

wifi_essid

String

Interface

The name of the current Wi-Fi network (if any)

wifi_signal

Integer

Interface

An indication of the received signal strength. The absolute value of this field is usually not meaningful, but it can be compared with the reported value on other networks or in different locations.

...