createPackage

此方法用于创建安装包。

警告

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

参数

参数	类型	可选	描述
`packageName`	字符串	否	软件包名称。
`描述`	字符串	是	包的描述。如果未传入值，描述将为空字符串。
`语言`	字符串	是	包的语言，格式为LL_CC，其中LL表示语言，CC表示国家/地区。支持的语言包括：en_US、es_ES、de_DE、fr_FR、ro_RO、pl_PL、pt_BR、it_IT、ru_RU。若未指定，默认值为 `en_US` .
`模块`	对象	是	包含待启用/禁用模块的对象。键名可以是： `反恶意软件` `高级威胁控制` `防火墙` `内容控制` 注意若 `内容控制` 存在，其值将自动赋给 `用户控制` , `反钓鱼` 及 `流量扫描` 。尝试为这三个键中的任意一个赋予不同值将导致错误。提示该 `内容控制` 设置已弃用。建议改用 `用户控制` , `反钓鱼` 和 `流量扫描` 设置进行替代。 `设备控制` `用户控制` 注意若 `内容控制` 存在，则分配给它的值也将自动赋给此键。 `反钓鱼` 注意若 `内容控制` 存在，则分配给它的值也将自动赋给此键。 `流量扫描` 注意若 `内容控制` 存在，则分配给它的值也将自动赋给此键。 `高级用户` `应用程序控制` `加密` `终端检测与响应传感器` `高级反漏洞利用` `容器保护` `补丁管理` `网络攻击防御` `phasr` 取值可为1（启用）或0（禁用）。若未发送该模块，则默认为禁用状态。对于EDR（仅报告模式），模块参数必须采用默认配置：edrSensor、contentControl、networkAttackDefense和advancedThreatControl设为1（启用），其余模块均设为0。在检测与防护模式下，所有模块默认值均为0。对于PHASR独立版，仅需将 `phasr` 参数置于 `modules` 对象下并设置为 `1` （启用），其余模块均设为 `0` .
`scanMode`	对象	是	包含扫描模式设置的对象。对象描述如下：可接受的键名包括： `type` , `vms` , `computers` 以及 `ec2` （若已配置AWS集成）。其中 `type` 取值可为1（自动模式）或2（自定义模式）。若 `类型` 值为2时，则需发送 `计算机` , `虚拟机` 及 `EC2` 的键值对，否则系统将自动填充默认值。 `计算机` , `虚拟机` 和 `EC2` 的值应为包含以下可能键的对象： `主模式` 与 `备用模式` . `主模式` 可选值为1（中央扫描模式（安全服务器））、2（混合扫描模式（轻量引擎））或3（本地扫描模式（全量引擎））。 `备用模式` 可选值为2（混合扫描模式（轻量引擎））或3（本地扫描模式（全量引擎））。若 `主模式` 选项值为2或3，则 `备用模式` 的值将被忽略。 `主模式` 选项 `ec2` 只能为1（用于中央扫描（安全服务器））。若未传递此参数，则自动模式的值将被保存。
`设置`	对象	是	包含软件包其他设置的对象。其取值可为： `removeCompetitors` , `uninstallPassword` , `customInstallationPath` , `customGroupId` . `vmsCustomGroupId` 参数 `removeCompetitors` 可取值为1（启用）或0（禁用）。 `uninstallPassword` 应为字符串且需满足复杂度要求：密码长度至少6个字符，且必须包含至少一位数字、一个大写字母、一个小写字母及一个特殊字符； `customInstallationPath` 应为有效的Windows安装路径（仅适用于Windows操作系统）。 `customGroupId` 应为表示自定义组实体ID的字符串，新终端将被部署至该组（适用于计算机与虚拟机视图） . `vmsCustomGroupId` 应为表示自定义组实体ID的字符串，新终端将被部署至该组（仅适用于虚拟机视图）。所有值均为可选。
`roles`	对象	是	包含需启用或禁用角色的对象： `relay` 可选值如下： `1` 表示启用Relay角色， `0` 表示禁用该角色。默认情况下，Relay角色处于禁用状态。 `exchange` 可选值如下： `1` 表示启用Exchange角色， `0` 表示禁用该角色。默认情况下，Exchange角色处于禁用状态。该角色仅在持有有效的Security for Exchange许可证时可用。
`deploymentOptions`	对象	是	包含安装选项的对象： `type` 整数，表示终端将连接的目标实体。该实体负责提供安装包和更新。可选值包括： `1` 表示通过Bitdefender更新服务器常规部署； `2` 表示通过Relay进行部署。 `relayId` 字符串，表示已启用Relay角色的终端ID。当 `type` 选项设置为 `2` ，表示通过中继节点部署。 `useCustomCommunicationServer` ，布尔值，用于选择端点是否与特定通信服务器设备通信。可选值为： `True` 表示指定特定通信服务器设备， `False` 表示使用默认通信服务器设备。此选项仅在部署选项为 `1` （即常规部署）时设置。 `communicationServer` ，字符串，包含自定义通信服务器设备的IP或主机名。此选项仅在 `useCustomCommunicationServer` 设置为 `True` . `useCommunicationProxy` ，布尔值，用于指定端点是否通过代理进行互联网通信。可选值为 `True` 表示启用通信代理， `False` 表示不启用。 `proxyServer` ，字符串，表示代理服务器的IP或域名。有效值为IPv4/IPv6格式的IP地址或符合RFC 1035标准的域名。当 `useCommunicationProxy` 设置为 `True` . `proxyPort` ，一个整数，表示允许访问代理服务器的端口号。有效值介于 `1` 与 `65535` 之间。当 `useCommunicationProxy` 设置为 `True` . `proxyUsername` ，一个字符串，表示代理服务器身份验证所需的用户名。若代理服务器无需认证，可省略此选项。 `proxyPassword` ，一个字符串，表示代理服务器身份验证所需的密码。若代理服务器无需认证，可省略此选项。
`productType`	数字	是	此参数决定安全代理的运行模式。可选值： `0` - 检测与防护模式（完整终端安全代理的默认模式）。 `3` - EDR（仅报告）模式（Bitdefender EDR代理的默认模式）。 `5` - Phasr独立模式。更多信息请参阅参数说明 .

参数说明

Bitdefender EDR用户仅能创建EDR（仅报告）安装包；指定 productType 为可选操作。
GravityZone BS/ABS/Elite 和企业版用户只能创建检测与防护安装包；指定 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 - false
- settings.scanBeforeInstall - false
- roles.exchange - false

返回值

该方法返回一个包含创建包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
       },
       "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
       }
     ]
  }

本节内容 :

createPackage

警告

参数

注意

提示

注意

注意

注意

参数说明

返回值

示例

搜索结果