• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

ToiNetService

ToiNetService is used to configure and retrieving information about logical networks. A logical network (aka network) is a collection of everything in the system required to allow network access. This includes network interfaces, DNS, routing and Wi-Fi management.

Service:

This is a service and can be accessed through toi.netService
  • Methods
  • Members
  • Constants

Method Summary

getNetwork ( networkName )  → ToiNetwork

Returns the network with the specified name.
getNetworkInterfaces ( )  → Array.<ToiNetwork.ToiInterfaceInfo>

Returns information about the available network interfaces.

Constants

  • BOOT_NETWORK

Methods

getNetwork ( networkName )  → ToiNetwork

Returns the network with the specified name.

Parameters:

Name Type Description
networkName string

The name of the network. The following named networks are currently supported: ToiNetService.BOOT_NETWORK

Throws:

ToiInvalidArgumentException

Raised if there is no network with the specified name.

Returns:

The ToiNetwork address.

Type: ToiNetwork
getNetworkInterfaces ( )  → Array.<ToiNetwork.ToiInterfaceInfo>

Returns information about the available network interfaces.

Returns:

Information about the available network interfaces.

Type: Array.<ToiNetwork.ToiInterfaceInfo>

Members

BOOT_NETWORK (Type: string) (value = '_boot_network_') (static, constant)

This string constant identifies the boot network.

This constant can also be accessed from toi.consts.ToiNetService.BOOT_NETWORK.

5.1.1.p8

Copyright (c) 2018 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.