js-apis-enterprise-networkManager.md 34.6 KB
Newer Older
F
fangyun 已提交
1 2 3 4 5 6 7
# @ohos.enterprise.networkManager(网络管理)

本模块提供设备网络管理能力,包括查询设备IP地址、MAC地址信息等。仅企业设备管理员应用才能调用。

> **说明:**
>
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
L
liwuli 已提交
8
> 本模块接口需激活为[设备管理员应用](js-apis-enterprise-adminManager.md#adminmanagerenableadmin)后才能调用,实现相应功能。
F
fangyun 已提交
9 10 11 12 13 14 15 16 17 18 19

## 导入模块

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

## networkManager.getAllNetworkInterfaces

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

L
liwuli 已提交
20
指定设备管理员应用获取所有活动的网络接口,使用callback形式返回网络接口名称数组。
F
fangyun 已提交
21

F
fangyun 已提交
22
**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO
F
fangyun 已提交
23 24 25 26 27 28 29 30 31

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

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

**参数:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
48 49
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
50
};
L
liwuli 已提交
51 52 53 54 55 56 57

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 已提交
58 59 60 61 62 63 64
});
```

## networkManager.getAllNetworkInterfaces

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

L
liwuli 已提交
65
指定设备管理员应用获取所有活动的网络接口,使用Promise形式返回网络接口名称数组。
F
fangyun 已提交
66 67 68 69 70 71 72 73 74 75 76

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

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

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

**参数:**

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

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
L
liwuli 已提交
83
| Promise<Array<string>> | Promise结果,返回网络接口名称数组。  |
F
fangyun 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96 97

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
98 99
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
100
};
L
liwuli 已提交
101

F
fangyun 已提交
102
networkManager.getAllNetworkInterfaces(wantTemp).then((result) => {
L
liwuli 已提交
103 104 105
  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 已提交
106 107 108 109 110 111 112
});
```

## networkManager.getIpAddress

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

L
liwuli 已提交
113
指定设备管理员应用根据networkInterface获取设备IP地址,使用callback形式返回设备IP地址。
F
fangyun 已提交
114

F
fangyun 已提交
115
**需要权限:** ohos.permission.ENTERPRISE_GET_NETWORK_INFO
F
fangyun 已提交
116 117 118 119 120 121 122 123 124

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

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

**参数:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
142 143
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
144
};
L
liwuli 已提交
145 146 147 148 149 150 151

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 已提交
152 153 154 155 156 157 158
});
```

## networkManager.getIpAddress

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

L
liwuli 已提交
159
指定设备管理员应用根据networkInterface获取设备IP地址,使用Promise形式返回设备IP地址。
F
fangyun 已提交
160 161 162 163 164 165 166 167 168 169 170

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

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

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

**参数:**

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

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
L
liwuli 已提交
178
| Promise<string> | Promise结果,返回设备IP地址。  |
F
fangyun 已提交
179 180 181 182 183 184 185 186 187 188 189 190 191 192

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
193 194
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
195
};
L
liwuli 已提交
196 197 198 199 200

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 已提交
201 202 203 204 205 206 207
});
```

## networkManager.getMac

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

L
liwuli 已提交
208
指定设备管理员应用根据networkInterface获取设备MAC地址,使用callback形式返回设备MAC地址。
F
fangyun 已提交
209 210 211 212 213 214 215 216 217 218 219

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

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

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

**参数:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
237 238
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
239
};
L
liwuli 已提交
240 241 242 243 244 245 246

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 已提交
247 248 249 250 251
});
```

## networkManager.getMac

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

L
liwuli 已提交
254
指定设备管理员应用根据networkInterface获取设备MAC地址,使用Promise形式返回设备IP地址。
F
fangyun 已提交
255 256 257 258 259 260 261 262 263 264 265

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

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

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

**参数:**

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

**返回值:**

| 类型                   | 说明                      |
| --------------------- | ------------------------- |
L
liwuli 已提交
273
| Promise&lt;string&gt; | Promise结果,返回设备MAC地址。  |
F
fangyun 已提交
274 275 276 277 278 279 280 281 282 283 284 285 286 287

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
288 289
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
290
};
L
liwuli 已提交
291 292 293 294 295

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 已提交
296 297
});
```
F
fangyun 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

## networkManager.isNetworkInterfaceDisabled

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

指定设备管理员应用查询指定网络接口是否被禁用,使用callback形式返回网络接口是否被禁用。

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

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

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

**参数:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
332 333
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
334
};
L
liwuli 已提交
335 336 337 338 339 340 341

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 已提交
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
});
```

## networkManager.isNetworkInterfaceDisabled

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

指定设备管理员应用查询指定网络接口是否被禁用,使用Promise形式返回指定网络接口是否被禁用。

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

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

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

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理员应用。 |
| networkInterface    | string     | 是    | 指定网络接口。                  |

**返回值:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
383 384
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
385
};
L
liwuli 已提交
386 387 388 389 390

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 已提交
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
});
```

## networkManager.setNetworkInterfaceDisabled

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

指定设备管理员应用禁用指定网络接口,使用callback形式返回。

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

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

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

**参数:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
428 429
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
430
};
L
liwuli 已提交
431 432 433 434 435 436 437

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 已提交
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
});
```

## networkManager.setNetworkInterfaceDisabled

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

指定设备管理员应用禁用指定网络接口,使用Promise形式返回。

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

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

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

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理员应用。 |
| networkInterface    | string     | 是    | 指定网络接口。                  |
| isDisabled    | boolean     | 是    | true表示禁用该网络接口,false表示开启该网络接口。                  |

**返回值:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
480 481
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
F
fangyun 已提交
482
};
L
liwuli 已提交
483 484 485 486 487

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 已提交
488
});
Y
yaobaohua 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
```

## networkManager.addIptablesFilterRule

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

指定设备管理员应用添加网络包过滤规则,使用callback形式返回。

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

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

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

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理员应用。                  |
Y
yaobaohua 已提交
508
| filterRule    | [AddFilterRule](#addfilterrule)     | 是    | 添加网络包过滤规则                  |
Y
yaobaohua 已提交
509 510 511 512 513 514 515 516 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 556 557 558 559 560 561 562 563 564 565
| callback | AsyncCallback&lt;void&gt;            | 是    | 回调函数。当接口调用成功,err为null,否则err为错误对象。       |

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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>

指定设备管理员应用添加网络包过滤规则,使用Promise形式返回。

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

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

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

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理员应用。 |
Y
yaobaohua 已提交
566
| filterRule    | [AddFilterRule](#addfilterrule)     | 是    | 添加网络包过滤规则                  |
Y
yaobaohua 已提交
567 568 569 570 571 572 573 574 575 576 577 578 579 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 617 618 619 620 621 622 623 624 625 626

**返回值:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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

指定设备管理员应用移除网络包过滤规则,使用callback形式返回。

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

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

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

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                       |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
| admin    | [Want](js-apis-app-ability-want.md)      | 是    | 设备管理员应用。                  |
Y
yaobaohua 已提交
627
| filterRule    | [RemoveFilterRule](#removefilterrule)     | 是    | 移除网络包过滤规则                  |
Y
yaobaohua 已提交
628 629 630 631 632 633 634 635 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 673 674 675 676 677 678 679 680 681 682
| callback | AsyncCallback&lt;void&gt;            | 是    | 回调函数。当接口调用成功,err为null,否则err为错误对象。       |

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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>

指定设备管理员应用移除网络包过滤规则,使用Promise形式返回。

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

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

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

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理员应用。 |
Y
yaobaohua 已提交
683
| filterRule    | [RemoveFilterRule](#removefilterrule)     | 是    | 移除网络包过滤规则                  |
Y
yaobaohua 已提交
684 685 686 687 688 689 690 691 692 693 694 695 696 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 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 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 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 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

**返回值:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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

指定设备管理员应用获取网络包过滤规则,使用callback形式返回。

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

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

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

**参数:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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>

指定设备管理员应用获取网络包过滤规则,使用Promise形式返回。

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

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

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

**参数:**

| 参数名   | 类型                                  | 必填   | 说明      |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理员应用。 |

**返回值:**

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

**错误码**

以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)

| 错误码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 已提交
834 835 836 837
| method        | [AddMethod](#addmethod)    | 是   | 添加策略。 |
| direction | [Direction](#direction)    | 是   | 规则链。 |
| action        | [Action](#action)    | 是   | 接收或者丢弃数据包。 |
| protocol | [Protocol](#protocol)   | 否   | 网络协议。 |
Y
yaobaohua 已提交
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853

## RemoveFilterRule

移除网络包过滤规则

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

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

| 名称         | 类型     | 必填 | 说明                            |
| ----------- | --------| ---- | ------------------------------- |
| srcAddr | string   | 否   | ip源地址。 |
| destAddr        | string    | 否   | ip目标地址。 |
| srcPort | string   | 否   | ip源端口。 |
| destPort        | string    | 否    | ip目标端口。 |
| uid | string   | 否    | 应用uid。 |
Y
yaobaohua 已提交
854 855 856
| direction | [Direction](#direction)    | 是    | 规则链。 |
| action        | [Action](#action)    | 否    | 接收或者丢弃数据包。 |
| protocol | [Protocol](#protocol)   | 否    | 网络协议。 |
Y
yaobaohua 已提交
857 858 859 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

## 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 已提交
899
网络协议。
Y
yaobaohua 已提交
900 901 902 903 904 905 906 907 908 909 910

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

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

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