js-apis-enterprise-networkManager.md 34.4 KB
Newer Older
F
fangyun 已提交
1 2
# @ohos.enterprise.networkManager(网络管理)

Y
yaobaohua 已提交
3
本模块提供设备网络管理能力,包括查询设备IP地址、MAC地址信息等。
F
fangyun 已提交
4 5 6 7

> **说明:**
>
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Y
yaobaohua 已提交
8
>
L
liwuli 已提交
9 10 11
> 本模块接口仅可在Stage模型下使用。
>
> 本模块接口仅对[设备管理应用](enterpriseDeviceManagement-overview.md#基本概念)开放,需将[设备管理应用激活](js-apis-enterprise-adminManager.md#adminmanagerenableadmin)后调用,实现相应功能。
F
fangyun 已提交
12 13 14 15 16 17 18 19 20 21 22

## 导入模块

```js
import networkManager from '@ohos.enterprise.networkManager';
```

## networkManager.getAllNetworkInterfaces

getAllNetworkInterfaces(admin: Want, callback: AsyncCallback<Array<string>>): void

L
liwuli 已提交
23
指定设备管理应用获取所有激活的网络接口。使用callback异步回调。
F
fangyun 已提交
24

F
fangyun 已提交
25
**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO
F
fangyun 已提交
26 27 28 29 30 31 32 33 34

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
35
| admin    | [Want](js-apis-app-ability-want.md)     | 是    | 设备管理应用。                  |
L
liwuli 已提交
36
| callback | AsyncCallback<Array<string>>            | 是    | 回调函数。当接口调用成功,err为null,data为网络接口名称数组,否则err为错误对象。     |
F
fangyun 已提交
37 38 39

**错误码**

L
liwuli 已提交
40
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
41 42 43 44 45 46 47 48 49 50

| 错误码ID | 错误信息                                                                       |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
51 52
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
53
};
L
liwuli 已提交
54 55 56 57 58 59 60

networkManager.getAllNetworkInterfaces(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to get all network interfaces. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting all network interfaces, result : ${JSON.stringify(result)}`);
F
fangyun 已提交
61 62 63 64 65 66 67
});
```

## networkManager.getAllNetworkInterfaces

getAllNetworkInterfaces(admin: Want): Promise<Array<string>>

L
liwuli 已提交
68
指定设备管理应用获取所有激活的网络接口。使用Promise异步回调。
F
fangyun 已提交
69 70 71 72 73 74 75 76 77 78 79

**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
80
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
F
fangyun 已提交
81 82 83 84 85

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
L
liwuli 已提交
86
| Promise<Array<string>> | Promise结果,返回网络接口名称数组。  |
F
fangyun 已提交
87 88 89

**错误码**

L
liwuli 已提交
90
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
91 92 93 94 95 96 97 98 99 100

| 错误码ID | 错误信息                                                                     |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
101 102
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
103
};
L
liwuli 已提交
104

F
fangyun 已提交
105
networkManager.getAllNetworkInterfaces(wantTemp).then((result) => {
L
liwuli 已提交
106 107 108
  console.info(`Succeeded in getting all network interfaces, result : ${JSON.stringify(result)}`);
}).catch((err) => {
  console.error(`Failed to get all network interfaces. Code: ${err.code}, message: ${err.message}`);
F
fangyun 已提交
109 110 111 112 113 114 115
});
```

## networkManager.getIpAddress

getIpAddress(admin: Want, networkInterface: string, callback: AsyncCallback<string>): void

L
liwuli 已提交
116
指定设备管理应用根据网络接口获取设备IP地址。使用callback异步回调。
F
fangyun 已提交
117

F
fangyun 已提交
118
**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO
F
fangyun 已提交
119 120 121 122 123 124 125 126 127

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
128
| admin    | [Want](js-apis-app-ability-want.md)     | 是    | 设备管理应用。                  |
L
liwuli 已提交
129 130
| networkInterface    | string     | 是    | 指定网络接口。                  |
| callback | AsyncCallback<string>            | 是    | 回调函数。当接口调用成功,err为null,data为IP地址,否则err为错误对象。       |
F
fangyun 已提交
131 132 133

**错误码**

L
liwuli 已提交
134
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
135 136 137 138 139 140 141 142 143 144

| 错误码ID | 错误信息                                                                       |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
145 146
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
147
};
L
liwuli 已提交
148 149 150 151 152 153 154

networkManager.getIpAddress(wantTemp, 'eth0', (err, result) => {
  if (err) {
    console.error(`Failed to get ip address. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting ip address, result : ${result}`);
F
fangyun 已提交
155 156 157 158 159 160 161
});
```

## networkManager.getIpAddress

getIpAddress(admin: Want, networkInterface: string): Promise<string>

L
liwuli 已提交
162
指定设备管理应用根据网络接口获取设备IP地址。使用Promise异步回调。
F
fangyun 已提交
163 164 165 166 167 168 169 170 171 172 173

**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
174
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
L
liwuli 已提交
175
| networkInterface    | string     | 是    | 指定网络接口。                  |
F
fangyun 已提交
176 177 178 179 180

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
L
liwuli 已提交
181
| Promise<string> | Promise结果,返回设备IP地址。  |
F
fangyun 已提交
182 183 184

**错误码**

L
liwuli 已提交
185
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
186 187 188 189 190 191 192 193 194 195

| 错误码ID | 错误信息                                                                     |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
196 197
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
198
};
L
liwuli 已提交
199 200 201 202 203

networkManager.getIpAddress(wantTemp, 'eth0').then((result) => {
  console.info(`Succeeded in getting ip address, result : ${result}`);
}).catch((err) => {
  console.error(`Failed to get ip address. Code: ${err.code}, message: ${err.message}`);
F
fangyun 已提交
204 205 206 207 208 209 210
});
```

## networkManager.getMac

getMac(admin: Want, networkInterface: string, callback: AsyncCallback<string>): void

L
liwuli 已提交
211
指定设备管理应用根据网络接口获取设备MAC地址。使用callback异步回调。
F
fangyun 已提交
212 213 214 215 216 217 218 219 220 221 222

**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
223
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理应用。                  |
L
liwuli 已提交
224 225
| networkInterface    | string     | 是    | 指定网络接口。                  |
| callback | AsyncCallback<string>            | 是    | 回调函数。当接口调用成功,err为null,data为设备MAC地址,否则err为错误对象。       |
F
fangyun 已提交
226 227 228

**错误码**

L
liwuli 已提交
229
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
230 231 232 233 234 235 236 237 238 239

| 错误码ID | 错误信息                                                                       |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
240 241
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
242
};
L
liwuli 已提交
243 244 245 246 247 248 249

networkManager.getMac(wantTemp, 'eth0', (err, result) => {
  if (err) {
    console.error(`Failed to get mac. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting mac, result : ${result}`);
F
fangyun 已提交
250 251 252 253 254
});
```

## networkManager.getMac

L
liwuli 已提交
255
getMac(admin: Want, networkInterface: string): Promise\<string>;
F
fangyun 已提交
256

L
liwuli 已提交
257
指定设备管理应用根据网络接口获取设备MAC地址。使用Promise异步回调。
F
fangyun 已提交
258 259 260 261 262 263 264 265 266 267 268

**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
269
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
L
liwuli 已提交
270
| networkInterface    | string     | 是    | 指定网络接口。                  |
F
fangyun 已提交
271 272 273 274 275

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
L
liwuli 已提交
276
| Promise&lt;string&gt; | Promise结果,返回设备MAC地址。  |
F
fangyun 已提交
277 278 279

**错误码**

L
liwuli 已提交
280
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
281 282 283 284 285 286 287 288 289 290

| 错误码ID | 错误信息                                                                     |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
291 292
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
293
};
L
liwuli 已提交
294 295 296 297 298

networkManager.getMac(wantTemp, 'eth0').then((result) => {
  console.info(`Succeeded in getting mac, result : ${result}`);
}).catch((err) => {
  console.error(`Failed to get mac. Code: ${err.code}, message: ${err.message}`);
F
fangyun 已提交
299 300
});
```
F
fangyun 已提交
301 302 303 304 305

## networkManager.isNetworkInterfaceDisabled

isNetworkInterfaceDisabled(admin: Want, networkInterface: string, callback: AsyncCallback&lt;boolean&gt;): void

L
liwuli 已提交
306
指定设备管理应用查询指定网络接口是否被禁用。使用callback异步回调。
F
fangyun 已提交
307 308 309 310 311 312 313 314 315 316 317

**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
318
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理应用。                  |
F
fangyun 已提交
319 320 321 322 323
| networkInterface    | string     | 是    | 指定网络接口。                  |
| callback | AsyncCallback&lt;boolean&gt;            | 是    | 回调函数。当接口调用成功,err为null,data为指定网络接口是否被禁用,true表示该网络接口被禁用,false表示该网络接口未被禁用,否则err为错误对象。       |

**错误码**

L
liwuli 已提交
324
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
325 326 327 328 329 330 331 332 333 334

| 错误码ID | 错误信息                                                                       |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
335 336
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
337
};
L
liwuli 已提交
338 339 340 341 342 343 344

networkManager.isNetworkInterfaceDisabled(wantTemp, 'eth0', (err, result) => {
  if (err) {
    console.error(`Failed to query network interface is disabled or not. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in querying network interface is disabled or not, result : ${result}`);
F
fangyun 已提交
345 346 347 348 349 350 351
});
```

## networkManager.isNetworkInterfaceDisabled

isNetworkInterfaceDisabled(admin: Want, networkInterface: string): Promise&lt;boolean&gt;

L
liwuli 已提交
352
指定设备管理应用查询指定网络接口是否被禁用。使用Promise异步回调。
F
fangyun 已提交
353 354 355 356 357 358 359 360 361 362 363

**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
364
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
F
fangyun 已提交
365 366 367 368 369 370 371 372 373 374
| networkInterface    | string     | 是    | 指定网络接口。                  |

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
| Promise&lt;boolean&gt; | Promise结果,返回指定网络接口是否被禁用,true表示该网络接口被禁用,false表示该网络接口未被禁用。  |

**错误码**

L
liwuli 已提交
375
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
376 377 378 379 380 381 382 383 384 385

| 错误码ID | 错误信息                                                                     |          
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                        |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
386 387
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
388
};
L
liwuli 已提交
389 390 391 392 393

networkManager.isNetworkInterfaceDisabled(wantTemp, 'eth0').then((result) => {
  console.info(`Succeeded in querying network interface is disabled or not, result : ${result}`);
}).catch((err) => {
  console.error(`Failed to query network interface is disabled or not. Code: ${err.code}, message: ${err.message}`);
F
fangyun 已提交
394 395 396 397 398 399 400
});
```

## networkManager.setNetworkInterfaceDisabled

setNetworkInterfaceDisabled(admin: Want, networkInterface: string, isDisabled: boolean, callback: AsyncCallback&lt;void&gt;): void

L
liwuli 已提交
401
指定设备管理应用禁止设备使用指定网络。使用callback异步回调。
F
fangyun 已提交
402 403 404 405 406 407 408 409 410 411 412

**需要权限:** ohos.permission.ENTERPRISE_SET_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
413
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理应用。                  |
F
fangyun 已提交
414 415 416 417 418 419
| networkInterface    | string     | 是    | 指定网络接口。                  |
| isDisabled    | boolean     | 是    | true表示禁用该网络接口,false表示开启该网络接口。                  |
| callback | AsyncCallback&lt;void&gt;            | 是    | 回调函数。当接口调用成功,err为null,否则err为错误对象。       |

**错误码**

L
liwuli 已提交
420
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
421 422 423 424 425 426 427 428 429 430

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
431 432
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
433
};
L
liwuli 已提交
434 435 436 437 438 439 440

networkManager.setNetworkInterfaceDisabled(wantTemp, 'eth0', true, (err) => {
  if (err) {
    console.error(`Failed to set network interface disabled. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in setting network interface disabled`);
F
fangyun 已提交
441 442 443 444 445 446 447
});
```

## networkManager.setNetworkInterfaceDisabled

setNetworkInterfaceDisabled(admin: Want, networkInterface: string, isDisabled: boolean): Promise&lt;void&gt;

L
liwuli 已提交
448
指定设备管理应用禁止设备使用指定网络。使用Promise异步回调。
F
fangyun 已提交
449 450 451 452 453 454 455 456 457 458 459

**需要权限:** ohos.permission.ENTERPRISE_SET_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
460
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
F
fangyun 已提交
461 462 463 464 465 466 467 468 469 470 471
| networkInterface    | string     | 是    | 指定网络接口。                  |
| isDisabled    | boolean     | 是    | true表示禁用该网络接口,false表示开启该网络接口。                  |

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。当禁用网络接口失败时抛出错误对象  |

**错误码**

L
liwuli 已提交
472
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
F
fangyun 已提交
473 474 475 476 477 478 479 480 481 482

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
L
liwuli 已提交
483 484
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
485
};
L
liwuli 已提交
486 487 488 489 490

networkManager.setNetworkInterfaceDisabled(wantTemp, 'eth0', true).then(() => {
  console.info(`Succeeded in setting network interface disabled`);
}).catch((err) => {
  console.error(`Failed to set network interface disabled. Code: ${err.code}, message: ${err.message}`);
F
fangyun 已提交
491
});
Y
yaobaohua 已提交
492 493 494 495 496 497
```

## networkManager.addIptablesFilterRule

addIptablesFilterRule(admin: Want, filterRule: AddFilterRule, callback: AsyncCallback\<void>): void

L
liwuli 已提交
498
指定设备管理应用为设备添加网络包过滤规则。使用callback异步回调。
Y
yaobaohua 已提交
499 500 501 502 503 504 505 506 507 508 509

**需要权限:** ohos.permission.ENTERPRISE_MANAGE_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
510
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理应用。                  |
511
| filterRule    | [AddFilterRule](#addfilterrule)     | 是    | 添加网络包过滤规则。                  |
Y
yaobaohua 已提交
512 513 514 515
| callback | AsyncCallback&lt;void&gt;            | 是    | 回调函数。当接口调用成功,err为null,否则err为错误对象。       |

**错误码**

L
liwuli 已提交
516
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
Y
yaobaohua 已提交
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let filterRule = {
  "ruleNo": 1,
  "srcAddr": "192.168.1.1-192.188.22.66",
  "destAddr": "10.1.1.1",
  "srcPort": "8080",
  "destPort": "8080",
  "uid": "9696",
  "method": networkManager.AddMethod.APPEND,
  "direction": networkManager.Direction.OUTPUT,
  "action": networkManager.Action.DENY,
  "protocol": networkManager.Protocol.UDP,
}

networkManager.addIptablesFilterRule(wantTemp, filterRule, (err) => {
  if (err) {
    console.error(`Failed to set iptables filter rule. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in setting iptables filter rule`);
});
```

## networkManager.addIptablesFilterRule

addIptablesFilterRule(admin: Want, filterRule: AddFilterRule): Promise\<void>

L
liwuli 已提交
556
指定设备管理应用为设备添加网络包过滤规则。使用Promise异步回调。
Y
yaobaohua 已提交
557 558 559 560 561 562 563 564 565 566 567

**需要权限:** ohos.permission.ENTERPRISE_MANAGE_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
568
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
569
| filterRule    | [AddFilterRule](#addfilterrule)     | 是    | 添加网络包过滤规则。                  |
Y
yaobaohua 已提交
570 571 572 573 574

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
575
| Promise&lt;void&gt; | 无返回结果的Promise对象。当添加网络包过滤规则失败时抛出错误对象。  |
Y
yaobaohua 已提交
576 577 578

**错误码**

L
liwuli 已提交
579
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
Y
yaobaohua 已提交
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let filterRule = {
  "ruleNo": 1,
  "srcAddr": "192.168.1.1-192.188.22.66",
  "destAddr": "10.1.1.1",
  "srcPort": "8080",
  "destPort": "8080",
  "uid": "9696",
  "method": networkManager.AddMethod.APPEND,
  "direction": networkManager.Direction.OUTPUT,
  "action": networkManager.Action.DENY,
  "protocol": networkManager.Protocol.UDP,
}

networkManager.addIptablesFilterRule(wantTemp, filterRule).then(() => {
  console.info(`Succeeded in setting iptables filter rule`);
}).catch((err) => {
  console.error(`Failed to set iptables filter rule. Code: ${err.code}, message: ${err.message}`);
});
```

## networkManager.removeIptablesFilterRule

removeIptablesFilterRule(admin: Want, filterRule: RemoveFilterRule, callback: AsyncCallback\<void>): void

L
liwuli 已提交
617
指定设备管理应用移除网络包过滤规则。使用callback异步回调。
Y
yaobaohua 已提交
618 619 620 621 622 623 624 625 626 627 628

**需要权限:** ohos.permission.ENTERPRISE_MANAGE_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
629
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理应用。                  |
630
| filterRule    | [RemoveFilterRule](#removefilterrule)     | 是    | 移除网络包过滤规则。                  |
Y
yaobaohua 已提交
631 632 633 634
| callback | AsyncCallback&lt;void&gt;            | 是    | 回调函数。当接口调用成功,err为null,否则err为错误对象。       |

**错误码**

L
liwuli 已提交
635
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
Y
yaobaohua 已提交
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let filterRule = {
  "srcAddr": "192.168.1.1-192.188.22.66",
  "destAddr": "10.1.1.1",
  "srcPort": "8080",
  "destPort": "8080",
  "uid": "9696",
  "direction": networkManager.Direction.OUTPUT,
  "action": networkManager.Action.DENY,
  "protocol": networkManager.Protocol.UDP,
}

networkManager.removeIptablesFilterRule(wantTemp, filterRule, (err) => {
  if (err) {
    console.error(`Failed to remove iptables filter rule. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in removing iptables filter rule`);
});
```

## networkManager.removeIptablesFilterRule

removeIptablesFilterRule(admin: Want, filterRule: RemoveFilterRule): Promise\<void>

L
liwuli 已提交
673
指定设备管理应用移除网络包过滤规则。使用Promise异步回调。
Y
yaobaohua 已提交
674 675 676 677 678 679 680 681 682 683 684

**需要权限:** ohos.permission.ENTERPRISE_MANAGE_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
685
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
686
| filterRule    | [RemoveFilterRule](#removefilterrule)     | 是    | 移除网络包过滤规则。                  |
Y
yaobaohua 已提交
687 688 689 690 691

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
692
| Promise&lt;void&gt; | 无返回结果的Promise对象。当移除网络包过滤规则失败时抛出错误对象。  |
Y
yaobaohua 已提交
693 694 695

**错误码**

L
liwuli 已提交
696
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
Y
yaobaohua 已提交
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let filterRule = {
  "srcAddr": "192.168.1.1-192.188.22.66",
  "destAddr": "10.1.1.1",
  "srcPort": "8080",
  "destPort": "8080",
  "uid": "9696",
  "direction": networkManager.Direction.OUTPUT,
  "action": networkManager.Action.DENY,
  "protocol": networkManager.Protocol.UDP,
}

networkManager.removeIptablesFilterRule(wantTemp, filterRule).then(() => {
  console.info(`Succeeded in removing iptables filter rule`);
}).catch((err) => {
  console.error(`Failed to remove iptables filter rule. Code: ${err.code}, message: ${err.message}`);
});
```

## networkManager.listIptablesFilterRules

listIptablesFilterRules(admin: Want, callback: AsyncCallback\<string>): void

L
liwuli 已提交
732
指定设备管理应用获取网络包过滤规则。使用callback异步回调。
Y
yaobaohua 已提交
733 734 735 736 737 738 739 740 741 742 743

**需要权限:** ohos.permission.ENTERPRISE_MANAGE_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
L
liwuli 已提交
744
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理应用。                  |
Y
yaobaohua 已提交
745 746 747 748
| callback | AsyncCallback&lt;string&gt;            | 是    | 回调函数。当接口调用成功,err为null,否则err为错误对象。       |

**错误码**

L
liwuli 已提交
749
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
Y
yaobaohua 已提交
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

networkManager.listIptablesFilterRules(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to get iptables filter rule. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting iptables filter rule, result : ${result}`);
});
```

## networkManager.listIptablesFilterRules

listIptablesFilterRules(admin: Want): Promise\<string>

L
liwuli 已提交
777
指定设备管理应用获取网络包过滤规则。使用Promise异步回调。
Y
yaobaohua 已提交
778 779 780 781 782 783 784 785 786 787 788

**需要权限:** ohos.permission.ENTERPRISE_MANAGE_NETWORK

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
L
liwuli 已提交
789
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
Y
yaobaohua 已提交
790 791 792 793 794 795 796 797 798

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | Promise对象,返回网络包过滤规则。  |

**错误码**

L
liwuli 已提交
799
以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
Y
yaobaohua 已提交
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836

| 错误码ID | 错误信息                                                                     |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | the application is not an administrator of the device.                       |
| 9200002 | the administrator application does not have permission to manage the device. |

**示例:**

```js
let wantTemp = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

networkManager.listIptablesFilterRules(wantTemp).then((result) => {
  console.info(`Succeeded in getting iptables filter rule, result: ${result}`);
}).catch((err) => {
  console.error(`Failed to remove iptables filter rule. Code: ${err.code}, message: ${err.message}`);
});
```

## AddFilterRule

添加网络包过滤规则

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

| 名称         | 类型     | 必填 | 说明                            |
| ----------- | --------| ---- | ------------------------------- |
| ruleNo        | number    | 否   | 规则序号。 |
| srcAddr | string   | 否   | ip源地址。 |
| destAddr        | string    | 否   | ip目标地址。 |
| srcPort | string   | 否   | ip源端口。 |
| destPort        | string    | 否   | ip目标端口。 |
| uid | string   | 否   | 应用uid。 |
Y
yaobaohua 已提交
837 838 839 840
| method        | [AddMethod](#addmethod)    | 是   | 添加策略。 |
| direction | [Direction](#direction)    | 是   | 规则链。 |
| action        | [Action](#action)    | 是   | 接收或者丢弃数据包。 |
| protocol | [Protocol](#protocol)   | 否   | 网络协议。 |
Y
yaobaohua 已提交
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856

## RemoveFilterRule

移除网络包过滤规则

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

| 名称         | 类型     | 必填 | 说明                            |
| ----------- | --------| ---- | ------------------------------- |
| srcAddr | string   | 否   | ip源地址。 |
| destAddr        | string    | 否   | ip目标地址。 |
| srcPort | string   | 否   | ip源端口。 |
| destPort        | string    | 否    | ip目标端口。 |
| uid | string   | 否    | 应用uid。 |
Y
yaobaohua 已提交
857 858 859
| direction | [Direction](#direction)    | 是    | 规则链。 |
| action        | [Action](#action)    | 否    | 接收或者丢弃数据包。 |
| protocol | [Protocol](#protocol)   | 否    | 网络协议。 |
Y
yaobaohua 已提交
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901

## AddMethod

添加网络包方法。

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| APPEND | 0 | 追加。 |
| INSERT | 1 | 插入。 |

## Direction

规则链。

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INPUT | 0 | 输入链。 |
| OUTPUT | 1 | 输出链。 |

## Action

数据包的行为。

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| ALLOW | 0 | 接收数据包。 |
| DENY | 1 | 丢弃数据包。 |

## Protocol

Y
yaobaohua 已提交
902
网络协议。
Y
yaobaohua 已提交
903 904 905 906 907 908 909 910 911 912 913

**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager

**系统API**: 此接口为系统接口。

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| ALL | 0 | 全部网络协议。 |
| TCP | 1 | 网络协议TCP。 |
| UDP | 2 | 网络协议UDP。 |
| ICMP | 3 | 网络协议ICMP。 |