创建重新配置客户端任务

参数

参数	类型	可选性	描述
`targetIds`	数组	必填	需要重新配置代理的终端或容器ID列表。
`scheduler`	对象	可选	任务调度器设置对象，包含以下字段： `type` ，整型数值（可选值如下）： 1表示立即运行（默认值） 2表示定时执行若 `type` 设为1，可省略其他字段。 `recurrence` ，整型数值（可选值如下）： 1表示每小时执行。此值需设置 `everyHour` 参数。 2表示每日。此值需要 `startTime` 被设置。 3表示每周。此值需要同时设置 `everyHour` 和 `startTime` 。 `everyHour` ，介于1到23之间的整数，表示两次任务运行之间的小时间隔。 `startTime` ，格式为以下字符串： `HH:mm` ，表示首次任务运行的小时时间。 `onWeekDay` ，介于1到7之间的整数，其中1为周一，7为周日。若省略此参数，任务将立即运行。
`modules`	对象	是	需启用或禁用的模块。该对象包含以下字段： `antimalware` `advancedThreatControl` `firewall` `contentControl` `deviceControl` `userControl` `antiphishing` `trafficScan` `powerUser` `加密` `终端检测与响应传感器` `高级反漏洞利用` `容器保护` `补丁管理` `网络攻击防护` `完整性监控` 每个字段可设为1（启用）或0（禁用）。若模块被省略，则视为禁用状态。
`扫描模式`	对象	是	扫描引擎的设置。该对象包含以下字段： `类型` ，整数类型，可选值如下： 1表示自动配置（默认） 2表示自定义设置。此数值需配合 `计算机` 与 `虚拟机` 字段使用若省略则采用默认值。 `虚拟机` ，下文描述的对象。 `计算机` ，下文描述的对象。对象 `计算机` 和 `虚拟机` 包含以下字段： `main` ，整数类型，可选值如下： 1表示中央扫描（带安全服务器） 2表示混合扫描（轻量引擎） 3表示本地扫描（完整引擎） `fallback` ，整数类型，可选值如下： 2表示混合扫描（轻量引擎） 3表示本地扫描（完整引擎）若 `main` 值为2或3，则 `fallback` 将被忽略。
`roles`	对象	是	需在代理上启用或禁用的角色： `relay` 可选值如下： 1表示启用 0表示禁用（默认） `exchange` 可选值如下： 1表示启用 0表示禁用（默认）此角色仅在有有效的Exchange安全许可时可用。
`productType`	数值	是	该参数决定安全代理的运行模式。可选值： `0` - 检测与防护模式（完整端点安全代理的默认模式） `3` - EDR（仅报告）模式（Bitdefender EDR代理的默认模式）更多信息请参阅参数说明 .

参数说明

Bitdefender EDR用户只能运行将目标安全代理重新配置为EDR（仅报告）模式的任务； productType 为可选参数。
GravityZone BS/ABS/Elite用户只能运行将目标安全代理重新配置为检测与防护模式的任务； productType 为可选参数。
GravityZone Ultra /Ultra Plus 用户可将目标安全代理重新配置为两种运行模式。
- productType 在EDR（仅报告）模式重新配置时必须指定。
- 若选择运行不同模式的端点时未指定 productType ，EDR（仅报告）端点将被重新配置为检测与防护模式。
EDR（仅报告）模式默认包含一组预定义参数，将覆盖用户指定的选项。预定义参数：
- modules
  - edrSensor-true
  - contentControl-true
  - networkAttackDefense-true
  - 高级威胁防护-启用
  - 其他模块-禁用
- 扫描模式-不适用
- roles.exchange-禁用
该 完整性监控 模块不适用于EDR产品类型（仅报告）。

返回值

此方法返回所创建任务的父任务ID数组。

示例

请求 :

{
     "params": {
         "targetIds": [
             "5d7244b10ea1de153817c072"
         ],
         "scheduler": {
             "type": 1
         },
         "modules": {
           "advancedThreatControl": 1,
           "firewall": 1,
           "contentControl": 1,
           "deviceControl": 1,
           "powerUser": 1,
           "encryption": 1,
           "advancedAntiExploit": 1,
           "containerProtection": 1,
           "edrSensor": 1,
           "patchManagement": 1,
           
           "networkAttackDefense": 1
           "integrityMonitoring: 1
         },
         "scanMode": {
             "type": 1
         },
         "roles": {
             "relay": 0,
             "exchange": 0
         },
         "productType": 0
     },
     "jsonrpc": "2.0",
     "method": "createReconfigureClientTask",
     "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

响应 :

{
      "id": "5787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": [
          "652feab6b9684f3ba80685d5",
          "652feab6b9684f3ba80685d4"
      ]
}

版本1.0

参数

参数	类型	可选	描述
`targetIds`	数组	否	需要重新配置代理的终端或容器ID。
`scheduler`	对象	是	任务调度器设置。该对象包含以下字段： `类型` ，取值为以下整型之一： 1表示立即运行（默认值） 2表示计划任务若 `类型` 为1，可省略其余字段。 `重复周期` ，取值为以下整型之一： 1表示每小时。该值需设置 `每小时间隔` 字段。 2表示每天。该值需设置 `开始时间` 字段。 3表示每周。该值需同时设置 `每小时间隔` 与 `开始时间` 字段。 `每小时间隔` ，介于1至23的整数，表示两次任务执行的小时间隔。 `开始时间` ，格式如下的字符串： `时:分` ，表示首次任务执行的小时数。 `周内工作日` ，介于1至7的整数，1为周一，7为周日。若省略该参数，任务将立即执行。
`模块`	对象	是	需要启用或禁用的模块。该对象包含以下字段： `反恶意软件` `高级威胁防护` `防火墙` `内容控制` `设备控制` `高级用户` `加密` `高级反漏洞利用` `容器保护` `EDR传感器` `补丁管理` `网络攻击防护` `完整性监控` 每个字段可设为1（启用）或0（禁用）。若未指定模块，则默认禁用。
`扫描模式`	对象	是	扫描引擎的设置。该对象包含以下字段： `类型` ，整数，可选值如下： 1表示自动配置（默认） 2表示自定义设置。此值需配合 `计算机` 与 `虚拟机` 字段使用若未指定，将采用默认值。 `vms` ，如下所述的对象。 `computers` ，如下所述的对象。这些对象 `computers` 和 `vms` 包含以下字段： `main` ，整数类型，可选值如下： 1表示中央扫描（带安全服务器） 2表示混合扫描（轻量引擎） 3表示本地扫描（完整引擎） `fallback` ，整数类型，可选值如下： 2表示混合扫描（轻量引擎） 3表示本地扫描（完整引擎）如果 `main` 值为2或3，则 `fallback` 将被忽略。
`roles`	对象	是	需要在代理上启用或禁用的角色： `relay` 可选值如下： 1表示启用 0 表示禁用（默认） `exchange` 可选值为： 1 表示启用 0 表示禁用（默认）此角色仅在使用有效的 Security for Exchange 许可证时可用。
`productType`	数字	是	此参数决定安全代理的运行模式。可选值： `0` - 检测与防护模式，完整端点安全代理的默认模式。 `3` - EDR（仅报告）模式，Bitdefender EDR 代理的默认模式。更多信息，请参阅参数信息 .

参数信息

Bitdefender EDR 用户只能运行将目标安全代理重新配置为 EDR（仅报告）模式的任务；指定 productType 为可选。
GravityZone BS / ABS / Elite 用户只能运行将目标安全代理重新配置为检测与防护模式的任务；指定 productType 为可选。
GravityZone Ultra / Ultra Plus 用户可将目标安全代理重新配置为两种运行模式。
- productType 在EDR（仅报告）模式重新配置时必须指定。
- 若选择运行不同操作模式的终端时，若未指定 产品类型 ，则EDR（仅报告）终端将被重新配置为检测与防护模式运行。
EDR（仅报告）模式默认包含一组预定义参数，这些参数将覆盖用户指定的选项。预定义参数包括：
- 模块
  - edrSensor-启用
  - contentControl-启用
  - networkAttackDefense-启用
  - advancedThreatControl-启用
  - 其他模块-禁用
- scanMode-不适用
- roles.exchange-禁用
其中 完整性监控 模块不适用于EDR（仅报告）产品类型。

返回值

本方法返回布尔值，若至少一个目标ID成功创建重新配置任务则返回True。

示例

请求 :

{
     "params": {
         "targetIds": [
             "5d7244b10ea1de153817c072"
         ],
         "scheduler": {
             "type": 1
         },
         "modules": {
           "advancedThreatControl": 1,
           "firewall": 1,
           "contentControl": 1,
           "deviceControl": 1,
           "powerUser": 1,
           "encryption": 1,
           "advancedAntiExploit": 1,
           "containerProtection": 1,
           "edrSensor": 1,
           "patchManagement": 1,
           
           "networkAttackDefense": 1"integrityMonitoring: 1},
         "scanMode": {
             "type": 1
         },
         "roles": {
             "relay": 0,
             "exchange": 0
         },
         "productType": 0
     },
     "jsonrpc": "2.0",
     "method": "createReconfigureClientTask",
     "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

响应 :

{
     "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
     "jsonrpc":"2.0",
     "result": true
  }

createReconfigureClientTask

重要提示

警告

参数

参数说明

返回值

示例

版本1.0

参数

参数信息

返回值

示例

搜索结果