/pps/services/networking/all/interfaces/<interface>

Status object for network interfaces

Publishers
Network Manager
Subscribers
Any app

Overview

For every connected network interface, the Network Manager creates an object under the /pps/services/networking/all/interfaces/ directory for publishing status information. The name of each status object is the interface name as reported by the ifconfig utility (e.g., en0).

Attributes

Attribute Data type Description
connected Boolean Indicates whether (true|false) the given interface is connected.
fib Number FIB number.
httpproxy String IP address of the HTTP proxy server.
httpproxyloginrequired Boolean Indicates whether (true|false) the HTTP proxy requires login credentials.
ip4_ok String A yes here indicates whether IPv4 connectivity is available. Possible error strings:
  • error_no_ip_addr
  • error_no_ip_gateway
  • error_no_nameserver
  • error_not_configured
  • error_not_connected
  • error_not_up
ip6_ok String Same as for ip4_ok, but for IPv6 connectivity.
ip_addresses JSON Array of IP addresses assigned to this interface.
ip_bcastaddr String Interface's IP broadcast address (if it has one).
ip_dstaddr String Interface's IP destination address (if it has one).
ip_gateway JSON Array of IP gateways.
ip_ok String General status attribute for IP connectivity.
link_address String Link layer (MAC) address.
manual String Indicates whether (yes|no) manual or DHCP settings will be used.
If manual is yes, these settings apply:
  • ip_address=
  • gateway=
  • netmask=
  • nameservers=
  • searchdomains=
If manual is no, these settings apply:
  • dhcp=on|off|auto
  • dhcp6=on|off|auto
manual6 String Indicates whether (on|off) IPv6 manual or DHCP settings will be used.
mtu Number MTU number for this interface.
nameservers JSON Array of nameserver addresses.
searchdomains String Array of strings to be used for DNS resolution.
type String Type of interface. Possible values:
  • bb (any BlackBerry Bridge BIS-B/BES-B or BBIO HTTP proxy connection)
  • bluetooth_dun (any Bluetooth tethering interface)
  • cellular (any cellular network interface)
  • usb (any direct USB cable to a PC or Mac)
  • vpn (any VPN tunnel)
  • wifi (any wireless network interface)
  • wired (any wired Ethernet interface)
up Boolean Indicates whether (true|false) the physical interface is up.