跳至主内容

更新软件包

使用此方法更新安装包。

警告

atc 模块已弃用。建议使用 advancedThreatControl 替代。

参数

参数

类型

可选

描述

packageId

字符串

软件包的ID。

packageName

字符串

软件包的名称。

description

字符串

软件包的描述。若未传值,描述将默认为空字符串。

language

字符串

软件包的语言格式为LL_CC,其中LL表示语言,CC表示国家/地区。支持的语言包括:en_US(美式英语)、es_ES(西班牙语)、de_DE(德语)、fr_FR(法语)、ro_RO(罗马尼亚语)、pl_PL(波兰语)、pt_BR(巴西葡萄牙语)、it_IT(意大利语)、ru_RU(俄语)。若未指定,默认值为 en_US .

modules

对象

包含待启用/禁用模块的对象。其键名可为:

  • advancedThreatControl

  • firewall

  • contentControl

    注意

    contentControl 存在,其值将自动赋给 userControl , antiphishingtrafficScan 尝试为这三个键中的任何一个分配不同的值都将导致错误。

    提示

    内容控制 设置已弃用。建议改用 用户控制 , 反钓鱼流量扫描 设置进行替代。

  • 用户控制

    注意

    如果 内容控制 存在,则分配给它的值也将分配给此键。

  • 反钓鱼

    注意

    如果 内容控制 存在,则分配给它的值也将分配给此键。

  • 流量扫描

    注意

    如果 内容控制 存在,则分配给它的值也将分配给此键。

  • 设备控制

  • 高级用户

  • 终端检测与响应传感器

  • 高级反漏洞利用

  • 容器防护

  • 加密

  • 补丁管理

  • 网络攻击防御

  • PHASR

取值可为1(启用)或0(禁用)。若未发送该模块参数,则默认为禁用状态。

对于EDR(仅报告模式),模块参数必须采用默认配置:edrSensor、contentControl、networkAttackDefense和advancedThreatControl设为1(启用),其余模块均设为0。在检测与防护模式下,所有模块默认值均为0。

PHASR独立部署时,仅需将 PHASR 参数置于 modules 对象下并设为 1 (启用),其余模块均设为 0 .

扫描模式

对象

包含扫描模式设置的对象,描述如下:

  • 可接受的键名为: 类型 , 虚拟机 , 计算机EC2 (若已配置AWS集成)。其中 类型 取值可为1(自动模式)或2(自定义模式)。

  • 类型 值为2,则需传递 物理机 , 虚拟机EC2 的键值对,否则系统将填充默认值。 物理机 , 虚拟机EC2 的值为包含以下可选键的对象: 主模式备用模式 .

  • 其中 主模式 可取值:1(中央扫描-安全服务器)、2(混合扫描-轻量引擎)或3(本地扫描-完整引擎)。

  • 备用模式 可取值:2(混合扫描-轻量引擎)或3(本地扫描-完整引擎)。若 主模式 选择2或3,则 备用模式 取值将被忽略。

  • 主要 选项为 ec2 时,只能选择1(用于中央扫描(安全服务器))。

  • 若未传递此参数,则自动模式的值将被保存。

设置

对象

包含软件包其他设置的对象。可选值包括:

  • 移除竞争对手 ,

  • 卸载密码 ,

  • 自定义安装路径 ,

  • 自定义组ID .

  • 虚拟机自定义组ID

参数 移除竞争对手 可设为1(启用)或0(禁用)。 卸载密码 应为字符串且满足复杂度要求:密码长度至少6个字符,且必须包含至少一个数字、一个大写字母、一个小写字母及一个特殊字符; 自定义安装路径 应为有效的Windows路径(仅适用于Windows操作系统)。 自定义组ID 应为表示自定义组实体ID的字符串,新终端将部署至该组 (适用于计算机和虚拟机视图) .

vmsCustomGroupId 应为表示自定义组实体ID的字符串,新端点将部署至该组以供虚拟机视图使用。所有值均为可选。

roles

对象

包含待启用或禁用角色的对象:

  • relay 可选值如下: 1 表示启用中继角色, 0 表示禁用。默认情况下中继角色处于禁用状态。

  • exchange 可选值如下: 1 表示启用Exchange角色, 0 表示禁用。默认情况下Exchange角色处于禁用状态。 此角色仅在持有有效的Security for Exchange许可证时可用。

deploymentOptions

对象

包含安装选项的对象:

  • type 整数,表示端点将连接的目标实体。该实体负责提供安装包和更新,可选值包括: 1 表示通过Bitdefender更新服务器常规部署; 2 表示通过中继节点部署。

  • relayId ,表示启用了Relay角色的端点ID字符串。当 type 选项设置为 2 (即通过Relay部署)时,此字段必须设置。

  • useCustomCommunicationServer ,布尔值,用于选择端点是否与特定通信服务器设备通信。可选值为: True 表示指定特定通信服务器设备, False 表示使用默认通信服务器设备。此选项可在部署选项为 1 (即常规部署)时设置。

  • communicationServer ,包含自定义通信服务器设备IP或主机名的字符串。仅当 useCustomCommunicationServer 设置为 True .

  • useCommunicationProxy ,布尔值,用于指定端点是否通过代理进行互联网通信。可选值为 True 表示使用通信代理, False 表示不使用。

  • proxyServer ,表示代理服务器IP或域名的字符串。有效值为IPv4/IPv6格式的IP地址及符合RFC 1035定义的域名。当 useCommunicationProxy 设置为 True .

  • proxyPort ,一个表示允许访问代理服务器端口的整数。有效值介于 165535 之间。当 useCommunicationProxy 设置为 True .

  • proxyUsername ,表示代理服务器认证所需的用户名字符串。若代理服务器无需认证,可省略此选项。

  • proxyPassword ,表示代理服务器认证所需的密码字符串。若代理服务器无需认证,可省略此选项。

productType

数值

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

  • 0 - 检测与防护模式(完整端点安全代理的默认模式)

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

  • 5 - Phasr独立模式(PHASR独立代理的默认模式)

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

参数说明

  • Bitdefender EDR用户仅能创建EDR(仅报告)模式安装包;若指定 productType 为可选参数。

  • GravityZone BS/ABS/Elite 及Enterprise 用户仅可创建检测与防护安装包;指定 productType 为可选参数。

  • GravityZone Ultra用户可同时创建EDR(仅报告)和检测与防护安装包; productType 必须明确指定以创建EDR(仅报告)安装包。

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

    • modules

      • edrSensor-true

      • contentControl-true

      • networkAttackDefense-true

      • advancedThreatControl-true

      • 其他模块-false

    • scanMode-不适用

    • settings.removeCompetitors-false

    • settings.scanBeforeInstall-false

    • roles.exchange-false

  • PHASR独立安装包默认包含一组预定义参数,将覆盖用户指定的选项。预定义参数包括:

    • modules

      • phasr - true

    • scanMode - 不适用

    • settings.removeCompetitors - 否

    • settings.scanBeforeInstall - 否

    • roles.exchange - 否

返回值

该方法返回一个布尔值,表示 若软件包更新成功。

示例

请求 :

{
     "params": {
       "packageId": "652feab6b9684f3ba80685d5"
       "packageName": "唯一名称",
       "companyId": "54a1a1d3b1a43d2b347b23c1",
       "description": "软件包描述",
       "language": "en_EN",
       "modules": {
           "advancedThreatControl": 1,
           "firewall": 0,
           "userControl": 1,
           "antiphishing": 1,
           "trafficScan": 1,
           "deviceControl": 0,
           "powerUser": 1,
           "edrSensor": 1,
           "advancedAntiExploit": 1,
           "containerProtection": 1,
           "encryption": 0,
           "patchManagement": 0,
           "networkAttackDefense": 1,
           "integrityMonitoring": 1
       },
       "scanMode": {
           "type": 2,
           "computers": {
               "main": 1,
               "fallback": 2
           },
           "vms": {
               "main": 2
           },
           "ec2": {
               "main": 1,
               "fallback": 2
           }
       },
       "settings": {
           "uninstallPassword": "mys3cre3tP@assword",
           "removeCompetitors": 1,
           "customInstallationPath": "c:\\mypath\\bitdefender",
           "customGroupId": "5a4dff50b1a43ded0a7b23c8"
       },
       "roles": {
           "relay": 0,
           "exchange":1
       },
       "deploymentOptions": {
           "type": 2,
           "relayId": "54a1a1s3b1a43e2b347s23c1",
           "useCommunicationProxy": true,
           "proxyServer": "10.12.13.14",
           "proxyPort": 123
       },
       "productType": 0
     },
     "jsonrpc": "2.0",
     "method": "updatePackage",
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18"
  }

响应 :

{
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18",
     "jsonrpc": "2.0",
     "result": true
  }