# @ohos.net.ethernet (Ethernet Connection Management)

The ethernet module provides wired network capabilities, which allow users to set the IP address, subnet mask, gateway, and Domain Name System (DNS) server, and HTTP proxy of a wired network.

NOTE The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import ethernet from '@ohos.net.ethernet'

ethernet.setIfaceConfig⁹⁺

setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback<void>): void

Sets the network interface configuration. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

let config: ethernet.InterfaceConfiguration = {
  mode: 0,
  ipAddr: "192.168.xx.xxx",
  route: "192.168.xx.xxx",
  gateway: "192.168.xx.xxx",
  netMask: "255.255.255.0",
  dnsServers: "1.1.1.1"
};

ethernet.setIfaceConfig("eth0", config, (error: BusinessError) => {
  if (error) {
    console.log("setIfaceConfig callback error = " + JSON.stringify(error));
  } else {
    console.log("setIfaceConfig callback ok");
  }
});

ethernet.setIfaceConfig⁹⁺

setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise<void>

Sets the network interface configuration. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Return value

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

let config: ethernet.InterfaceConfiguration = {
  mode: 0,
  ipAddr: "192.168.xx.xxx",
  route: "192.168.xx.xxx",
  gateway: "192.168.xx.xxx",
  netMask: "255.255.255.0",
  dnsServers: "1.1.1.1"
};

const setConfigPromise = ethernet.setIfaceConfig("eth0", config);

setConfigPromise.then(() => {
  console.log("setIfaceConfig promise ok");
}).catch((error: BusinessError)  => {
  console.log("setIfaceConfig promise error = " + JSON.stringify(error));
});

ethernet.getIfaceConfig⁹⁺

getIfaceConfig(iface: string, callback: AsyncCallback<InterfaceConfiguration>): void

Obtains the configuration of a network interface. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

ethernet.getIfaceConfig("eth0", (error: BusinessError, value: ethernet.InterfaceConfiguration) => {
  if (error) {
    console.log("getIfaceConfig  callback error = " + JSON.stringify(error));
  } else {
    console.log("getIfaceConfig callback mode = " + JSON.stringify(value.mode));
    console.log("getIfaceConfig callback ipAddr = " + JSON.stringify(value.ipAddr));
    console.log("getIfaceConfig callback route = " + JSON.stringify(value.route));
    console.log("getIfaceConfig callback gateway = " + JSON.stringify(value.gateway));
    console.log("getIfaceConfig callback netMask = " + JSON.stringify(value.netMask));
    console.log("getIfaceConfig callback dnsServers = " + JSON.stringify(value.dnsServers));
  }
});

ethernet.getIfaceConfig⁹⁺

getIfaceConfig(iface: string): Promise<InterfaceConfiguration>

Obtains the configuration of a network interface. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Return value

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

ethernet.getIfaceConfig("eth0").then((data: ethernet.InterfaceConfiguration) => {
  console.log("getIfaceConfig promise mode = " + JSON.stringify(data.mode));
  console.log("getIfaceConfig promise ipAddr = " + JSON.stringify(data.ipAddr));
  console.log("getIfaceConfig promise route = " + JSON.stringify(data.route));
  console.log("getIfaceConfig promise gateway = " + JSON.stringify(data.gateway));
  console.log("getIfaceConfig promise netMask = " + JSON.stringify(data.netMask));
  console.log("getIfaceConfig promise dnsServers = " + JSON.stringify(data.dnsServers));
}).catch((error: BusinessError) => {
  console.log("getIfaceConfig promise error = " + JSON.stringify(error));
});

ethernet.isIfaceActive⁹⁺

isIfaceActive(iface: string, callback: AsyncCallback<number>): void

Checks whether a network interface is active. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

ethernet.isIfaceActive("eth0", (error: BusinessError, value: number) => {
  if (error) {
    console.log("whether2Activate callback error = " + JSON.stringify(error));
  } else {
    console.log("whether2Activate callback = " + JSON.stringify(value));
  }
});

ethernet.isIfaceActive⁹⁺

isIfaceActive(iface: string): Promise<number>

Checks whether a network interface is active. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Return value

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

ethernet.isIfaceActive("eth0").then((data: number) => {
  console.log("isIfaceActive promise = " + JSON.stringify(data));
}).catch((error: BusinessError) => {
  console.log("isIfaceActive promise error = " + JSON.stringify(error));
});

ethernet.getAllActiveIfaces⁹⁺

getAllActiveIfaces(callback: AsyncCallback<Array<string>>): void

Obtains the list of all active network interfaces. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

ethernet.getAllActiveIfaces((error: BusinessError, value: string[]) => {
  if (error) {
    console.log("getAllActiveIfaces callback error = " + JSON.stringify(error));
  } else {
    console.log("getAllActiveIfaces callback value.length = " + JSON.stringify(value.length));
    for (let i = 0; i < value.length; i++) {
      console.log("getAllActiveIfaces callback = " + JSON.stringify(value[i]));
    }
  }
});

ethernet.getAllActiveIfaces⁹⁺

getAllActiveIfaces(): Promise<Array<string>>

Obtains the list of all active network interfaces. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Return value

Error codes

Example

import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'

ethernet.getAllActiveIfaces().then((data: string[]) => {
  console.log("getAllActiveIfaces promise data.length = " + JSON.stringify(data.length));
  for (let i = 0; i < data.length; i++) {
    console.log("getAllActiveIfaces promise  = " + JSON.stringify(data[i]));
  }
}).catch((error:BusinessError) => {
  console.log("getAllActiveIfaces promise error = " + JSON.stringify(error));
});

ethernet.on('interfaceStateChange')¹⁰⁺

on(type: 'interfaceStateChange', callback: Callback<{ iface: string, active: boolean }>): void

Registers an observer for NIC hot swap events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Error codes

Example

import ethernet from '@ohos.net.ethernet'

ethernet.on('interfaceStateChange', (data: object) => {
  console.log('on interfaceSharingStateChange: ' + JSON.stringify(data));
});

ethernet.off('interfaceStateChange')¹⁰⁺

off(type: 'interfaceStateChange', callback?: Callback<{ iface: string, active: boolean }>): void

Unregisters the observer for NIC hot swap events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Ethernet

Parameters

Error codes

Example

import ethernet from '@ohos.net.ethernet'

ethernet.off('interfaceStateChange');

InterfaceConfiguration⁹⁺

Defines the network configuration for the Ethernet connection.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.Ethernet

IPSetMode⁹⁺

Defines the configuration mode of the Ethernet connection.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.Ethernet