跳至主要内容

createReconfigureClientTask

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

警告

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

服务

此方法要求将 {service} 服务名称置于API URL中。允许的服务包括:

  • computers (对应"计算机与虚拟机")

  • virtualmachines (对应"虚拟机")

例如,针对 虚拟机 服务的请求URL为:

https://YOUR-HOSTNAME/api/v1.1/jsonrpc/network/virtualmachines

参数

参数名

类型

是否可选

描述

targetIds

数组

必填

需要重新配置代理的终端或容器ID数组

scheduler

对象

可选

任务调度器设置对象,包含下列字段:

  • type 整型数字,可选值如下:

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

    • 2表示定时运行

    type 值为1,可省略其他字段

  • recurrence 整型数字,可选值如下:

    • 1表示每小时运行。该值需设置 everyHour 字段

    • 2表示每天运行。该值需设置 startTime 待设置。

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

  • everyHour ,介于1到23之间的整数,表示两次任务运行之间的小时间隔。

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

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

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

modules

对象

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

  • 反恶意软件

  • 高级威胁控制

  • 防火墙

  • 内容控制

  • 设备控制

  • 高级用户

  • 应用程序控制

  • 加密

  • 高级反漏洞利用

  • 容器保护

  • EDR传感器

  • 补丁管理

  • 网络攻击防御

每个字段可设为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(仅报告)模式的任务;指定 productType 是可选的。

  • GravityZone BS / ABS / Elite 和Enterprise 用户只能运行将目标安全代理重新配置为检测和防护模式的任务;指定 productType 是可选的。

  • GravityZone Ultra用户可将目标安全代理重新配置为两种操作模式。

    • productType 必须为EDR(仅报告)模式重新配置指定。

    • 如果选择运行不同操作模式的终端,且未指定 productType ,则EDR(仅报告)终端将被重新配置为检测和防护模式。

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

    • modules

      • edrSensor-true

      • contentControl-true

      • networkAttackDefense-true

      • advancedThreatControl-true

      • 其他模块-false

    • scanMode-不适用

    • roles.exchange-false

返回值

该方法返回一个布尔值,若为True表示至少为一个目标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,"applicationControl": 1,"networkAttackDefense": 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
  }