跳至主内容

createReconfigureClientTask

此方法用于创建新的代理重配置任务。通过该任务可选择在目标代理上安装哪些模块。

重要提示

本文主要章节包含该方法1.1版本的信息。1.0版本信息可查阅 此处 .

警告

networkMonitor 模块已弃用。建议改用 networkAttackDefense 模块。

参数

参数

类型

可选

描述

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

Object

需启用或禁用的模块。该对象包含以下字段:

  • antimalware

  • advancedThreatControl

  • firewall

  • contentControl

  • deviceControl

  • userControl

  • antiphishing

  • trafficScan

  • powerUser

  • encryption

  • edrSensor

  • advancedAntiExploit

  • containerProtection

  • patchManagement

  • 网络攻击防御

  • 完整性监控

每个字段可设为1(启用)或0(禁用)。若模块被省略,则视为禁用状态。

扫描模式

对象

扫描引擎的设置。该对象包含以下字段:

  • 类型 ,整数类型,可选值如下:

    • 1表示自动配置(默认)

    • 2表示自定义设置。此值需配合 计算机虚拟机 字段使用

    若省略则采用默认值。

  • 虚拟机 ,下文描述的对象。

  • 计算机 ,下文描述的对象。

对象 计算机虚拟机 包含以下字段:

  • 主模式 ,整数类型,可选值如下:

    • 1表示中央扫描(需安全服务器)

    • 2表示混合扫描(轻量引擎)

    • 3表示本地扫描(完整引擎)

  • 备用方案 ,一个整数,取以下值之一:

    • 2 表示混合扫描(轻量引擎)

    • 3 表示本地扫描(完整引擎)

主模式 取值为 2 或 3,则 备用方案 将被忽略。

角色

对象

必填

需在代理上启用或禁用的角色:

  • 中继 可选值如下:

    • 1 表示启用

    • 0 表示禁用(默认)

  • 邮件交换 可选值如下:

    • 1 表示启用

    • 0 表示禁用(默认)

    此角色需持有有效的 Security for Exchange 许可证方可使用。

产品类型

数字

必填

此参数决定安全代理的运行模式。可选值:

  • 0 - 检测与防护模式(全功能终端安全代理的默认模式)

  • 3 - EDR(仅报告)模式(Bitdefender EDR 代理的默认模式)

更多信息请参阅 参数说明 .

参数说明

  • Bitdefender EDR用户只能运行将目标安全代理重新配置为EDR(仅报告)模式的任务;指定 产品类型 为可选操作。

  • GravityZone BS/ABS/Elite用户只能运行将目标安全代理重新配置为检测与防护模式的任务;指定 产品类型 为可选操作。

  • GravityZone Ultra /Ultra Plus 用户可将目标安全代理重新配置为两种运行模式。

    • 产品类型 在EDR(仅报告)模式重新配置时必须指定。

    • 若选择运行不同模式的终端时未指定 产品类型 ,则EDR(仅报告)终端将被重新配置为检测与防护模式运行。

  • EDR(仅报告)模式默认包含一组将覆盖用户指定选项的预定义参数。预定义参数包括:

    • 模块

      • edrSensor-启用

      • 内容控制-启用

      • 网络攻击防御-启用

      • 高级威胁控制-启用

      • 其他模块-禁用

    • 扫描模式-不适用

    • 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

对象

任务调度器设置。该对象包含以下字段:

  • type ,整数类型,可选值为:

    • 1表示立即运行(默认)

    • 2表示计划任务

    如果 类型 若为1,可省略其他字段。

  • 重复模式 ,整数类型,可选值如下:

    • 1表示每小时。此值需设置 everyHour 字段。

    • 2表示每日。此值需设置 startTime 字段。

    • 3表示每周。此值需同时设置 everyHourstartTime 字段。

  • everyHour ,介于1至23的整数,表示任务执行的间隔小时数。

  • startTime ,字符串格式如下: HH:mm ,表示首次任务执行的小时数。

  • onWeekDay ,介于1至7的整数,其中1为周一,7为周日。

若省略此参数,任务将立即执行。

模块

对象

必填

需启用或禁用的模块。该对象包含以下字段:

  • 反恶意软件

  • 高级威胁控制

  • 防火墙

  • 内容控制

  • 设备控制

  • 高级用户

  • 加密

  • 高级反漏洞利用

  • 容器保护

  • EDR传感器

  • 补丁管理

  • 网络攻击防御

  • 完整性监控

每个字段可设置为1(启用)或0(禁用)。若模块未指定,则视为禁用状态。

扫描模式

对象

扫描引擎的设置。该对象包含以下字段:

  • 类型 ,整数类型,可选值如下:

    • 1表示自动配置(默认)

    • 2表示自定义设置。此值需配合 计算机虚拟机 字段使用

    若未指定,将采用默认值。

  • 虚拟机 ,详见下文描述的对象。

  • 计算机 ,详见下文描述的对象。

这些对象 计算机虚拟机 包含以下字段:

  • 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(仅报告)模式重新配置时必须指定。

    • 若选择运行不同模式的端点时未指定 productType ,则EDR(仅报告)模式的端点将被重新配置为检测与防护模式。

  • EDR(仅报告)模式默认包含一组预定义参数,这些参数将覆盖用户指定的选项。预定义参数:

    • 模块

      • edrSensor-true

      • contentControl-true

      • networkAttackDefense-true

      • advancedThreatControl-true

      • 其他模块-false

    • scanMode-不适用

    • roles.exchange-false

  • 完整性监控 模块不适用于产品类型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
  }