跳至主内容

创建软件包

此方法用于创建安装包。

警告

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

参数

参数

类型

可选

描述

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

对象

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

  • antimalware

  • advancedThreatControl

  • firewall

  • contentControl

    注意

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

    提示

    不建议使用 contentControl 设置。建议改用 userControl , antiphishingtrafficScan 设置。

  • deviceControl

  • userControl

    注意

    如果 contentControl 存在,分配给它的值也将分配给此键。

  • antiphishing

    注意

    如果 contentControl 存在,分配给它的值也将分配给此键。

  • trafficScan

    注意

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

  • 高级用户

  • 加密

  • EDR传感器

  • 高级反漏洞利用

  • 容器保护

  • 补丁管理

  • 网络攻击防护

  • 完整性监控

  • PHASR

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

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

对于PHASR独立版,仅 PHASR 参数在 模块 对象下被设置为 1 (启用),其余模块均设为 0 .

扫描模式

对象

包含扫描模式设置的对象。对象描述:

  • 可接受的键为: 类型 , vms , computers ,以及 ec2 (若已配置AWS集成)。 type 取值可为1(自动模式)或2(自定义模式)。

  • type 值为2,则需传递 computers , vmsec2 的键值对,否则系统将填充默认值。 computers , vmsec2 的值为包含以下可选键的对象: mainfallback .

  • 其中 main 可为1(中央扫描(安全服务器))、2(混合扫描(轻量引擎))或3(本地扫描(完整引擎))。

  • 参数 fallback 可设为2(混合扫描(轻量引擎))或3(本地扫描(完整引擎))。若 main 选项值为2或3,则 fallback 的值将被忽略。

  • 对于 ec2 实例, main 选项仅支持设为1(中央扫描(安全服务器))。

  • 若未传递此参数,则保存自动模式下的默认值。

settings

对象

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

  • removeCompetitors ,

  • uninstallPassword ,

  • customInstallationPath ,

  • customGroupId .

参数 removeCompetitors 可设为1(启用)或0(禁用)。 uninstallPassword 应为字符串且需满足复杂度要求:密码长度至少6个字符,必须包含至少一位数字、一个大写字母、一个小写字母及一个特殊字符;且 customInstallationPath 应为有效的Windows安装路径(仅适用于Windows操作系统)。 customGroupId 应为表示新终端应部署到的自定义群组实体ID的字符串。 所有值均为可选。对于EDR(仅报告模式),settings参数必须保持默认配置:removeCompetitors设为0(禁用)。

vmsCustomGroupId 应为表示新终端在虚拟机视图中应部署到的自定义群组实体ID的字符串。所有值均为可选。

roles

对象

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

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

  • exchange 可选值如下: 1 表示启用Exchange角色, 0 表示禁用。默认Exchange角色为禁用状态。 仅当公司许可证包含Security for Exchange安全服务时此角色可用。

deploymentOptions

对象

包含安装选项的对象:

  • type ,一个整数,表示终端将连接到的实体。该实体将提供安装包和更新。可能的取值为: 1 表示从Bitdefender更新服务器常规部署; 2 表示通过中继节点部署。

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

  • useCommunicationProxy ,一个布尔值,用于指定终端是否使用代理服务器进行互联网通信。可能的取值为 True 表示使用通信代理, False 则表示不使用。

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

  • proxyPort ,一个整数,表示访问代理服务器的端口号。有效值范围为 165535 。当 useCommunicationProxy 设置为 .

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

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

productType

数值

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

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

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

  • 5 - Phasr独立模式

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

参数说明

  • Bitdefender EDR用户仅能创建EDR(仅报告)策略包;指定 productType 为可选操作。

  • GravityZone BS/ABS/Elite用户仅能创建检测与防护策略包;指定 productType 为可选操作。

  • GravityZone Ultra / Ultra Plus 用户可创建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 - false

    • settings.scanBeforeInstall - false

    • roles.exchange - false

  • integrityMonitoring 模块不适用于EDR(仅报告)产品类型。

返回值

该方法返回一个包含创建包ID和调用状态的对象(若成功)。

示例

请求 :

{
     "params": {
       "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": "createPackage",
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18"
  }

响应 :

{
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18",
     "jsonrpc": "2.0",
     "result": [
       {
         "records": ["551bb0aed5172cac5c8b4568"],
         "success": true
       }
     ]
  }