updatePackage: суулгалтын багцыг шинэчлэх API арга

Суулгалтын багцыг шинэчлэхийн тулд энэ аргыг ашиглана.

Параметрүүд

• packageId — төрөл: String; заавал: Тийм. Багцын ID.
• packageName — төрөл: String; заавал: Тийм. Багцын нэр.
• description — төрөл: String; заавал биш. Багцын тайлбар. Утга өгөхгүй бол тайлбар хоосон мөр болно.
• language — төрөл: String; заавал биш. Багцын хэл, 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 — төрөл: Object; заавал биш. Идэвхжүүлэх/идэвхгүй болгох модулиудын объект. Түлхүүрүүд:

- advancedThreatControl
- firewall
- contentControl
> Тэмдэглэл: contentControl байвал түүний утга userControl, antiphishing, trafficScan-д автоматаар оноогдоно. Эдгээр гурвын аль нэгэнд өөр утга оноохыг оролдвол алдаа гарна.

> Зөвлөмж: contentControl тохиргоо хуучирсан. Оронд нь userControl, antiphishing, trafficScan тохиргоог ашиглахыг зөвлөж байна.
- userControl
> Тэмдэглэл: contentControl байвал түүнд оноосон утга энэ түлхүүрт мөн оноогдоно.
- antiphishing
> Тэмдэглэл: contentControl байвал түүнд оноосон утга энэ түлхүүрт мөн оноогдоно.
- trafficScan
> Тэмдэглэл: contentControl байвал түүнд оноосон утга энэ түлхүүрт мөн оноогдоно.
- deviceControl
- powerUser
- edrSensor
- advancedAntiExploit
- containerProtection
- encryption
- patchManagement
- networkAttackDefense
- integrityMonitoring
- phasr

Утга нь 1 (идэвхтэй) эсвэл 0 (идэвхгүй) байна. Модулийг илгээгээгүй бол идэвхгүй гэж үзнэ.

EDR (Report only)-ийн хувьд modules параметр анхдагч тохиргоотой байх ёстой: edrSensor, contentControl, networkAttackDefense, advancedThreatControl нь 1 (идэвхтэй), бусад бүх модуль 0 байна. Detection and prevention-ийн хувьд бүх модулийн анхдагч утга 0.

PHASR Standalone-ийн хувьд modules объект доторх зөвхөн phasr параметр 1 (идэвхтэй) байна. Бусад бүх модуль 0.

• scanMode — төрөл: Object; заавал биш. Шалгалтын горимын тохиргооны объект:

- Зөвшөөрөгдөх түлхүүрүүд: type, vms, computers, мөн AWS интеграц тохируулсан бол ec2. type утга нь 1 (автомат) эсвэл 2 (өөрийн тохиргоотой горим) байна.
- type утга 2 бол computers, vms, ec2 түлхүүр ба утгуудыг заавал илгээнэ, эс бөгөөс системээс анхдагч утгуудыг бөглөнө. computers, vms, ec2-ийн утга нь main ба fallback түлхүүртэй объект байна.
- main-ийн утга: 1 (Central Scanning (Security Server)), 2 (Hybrid Scanning (Light Engines)) эсвэл 3 (Local Scanning (Full Engines)).
- fallback-ийн утга: 2 (Hybrid Scanning (Light Engines)) эсвэл 3 (Local Scanning (Full Engines)). main сонголтын утга 2 эсвэл 3 бол fallback-ийн утгыг тооцохгүй.
- ec2-ийн main сонголт зөвхөн 1 (Central Scanning (Security Server)) байж болно.
- Энэ параметрийг илгээгээгүй бол автомат горимын утгуудыг хадгална.

• settings — төрөл: Object; заавал биш. Багцын бусад тохиргооны объект. Утгууд:

- removeCompetitors,
- uninstallPassword,
- customInstallationPath,
- customGroupId.

removeCompetitors-ийн утга 1 (идэвхтэй) эсвэл 0 (идэвхгүй). uninstallPassword нь мөр байх ба нарийн төвөгтэй байдлын шаардлагыг хангана: нууц үг дор хаяж 6 тэмдэгттэй, дор хаяж нэг цифр, нэг том үсэг, нэг жижиг үсэг, нэг тусгай тэмдэгт агуулсан байх ёстой. customInstallationPath нь багц суулгагдах Windows-ийн хүчинтэй зам байх ёстой (зөвхөн Windows үйлдлийн системд ажиллана). customGroupId нь шинэ төгсгөлийн төхөөрөмж (endpoint) байршуулагдах custom group объектын ID-г илэрхийлэх мөр байна. Бүх утга заавал биш. EDR (Report only)-ийн хувьд settings параметр анхдагч тохиргоотой байх ёстой: removeCompetitors нь 0 (идэвхгүй).

vmsCustomGroupId нь Virtual Machines View-д шинэ төгсгөлийн төхөөрөмж байршуулагдах custom group объектын ID-г илэрхийлэх мөр байна. Бүх утга заавал биш.

• roles — төрөл: Object; заавал биш. Идэвхжүүлэх эсвэл идэвхгүй болгох үүргүүдийн объект:

- relay — боломжит утга: Relay үүргийг идэвхжүүлэхэд 1, идэвхгүй болгоход 0. Анхдагчаар Relay үүрэг идэвхгүй.
- exchange — боломжит утга: Exchange үүргийг идэвхжүүлэхэд 1, идэвхгүй болгоход 0. Анхдагчаар Exchange үүрэг идэвхгүй. Энэ үүрэг зөвхөн компанийн лиценз Security for Exchange үйлчилгээг мөн хамарсан тохиолдолд боломжтой.

• deploymentOptions — төрөл: Object; заавал биш. Суулгалтын сонголтуудын объект:

- type — төгсгөлийн төхөөрөмж ямар обьекттой холбогдохыг заасан бүхэл тоо. Энэ объект суулгалтын багц болон шинэчлэлтийг хүргэнэ. Боломжит утга: 1 — Bitdefender Update Server-ээс энгийн байршуулалт; 2 — Relay-ээр дамжуулан байршуулалт.
- relayId — Relay үүрэг идэвхтэй төгсгөлийн төхөөрөмжийн ID-г илэрхийлэх мөр. type сонголт 2 (Relay ашиглан байршуулах) бол энэ талбарыг заавал тохируулна.
- useCommunicationProxy — төгсгөлийн төхөөрөмж интернетээр холбогдохдоо прокси ашиглах эсэхийг заах boolean. Боломжит утга: прокси ашиглах бол True, үгүй бол False.
- proxyServer — прокси серверийн IP эсвэл домэйн нэрийг илэрхийлэх мөр. Хүчинтэй утга: IPV4 эсвэл IPV6 хэлбэрийн IP хаяг, RFC 1035-д тодорхойлсон домэйн нэр. useCommunicationProxy нь True үед энэ сонголт заавал шаардлагатай.
- proxyPort — прокси сервер рүү хандах портыг илэрхийлэх бүхэл тоо. Хүчинтэй утга 1-ээс 65535 хүртэл. useCommunicationProxy нь True үед энэ сонголт заавал шаардлагатай.
- proxyUsername — прокси серверт нэвтрэхэд шаардлагатай хэрэглэгчийн нэрийг илэрхийлэх мөр. Прокси сервер нэвтрэлт шаарддаггүй бол орхиж болно.
- proxyPassword — прокси серверт нэвтрэхэд шаардлагатай нууц үгийг илэрхийлэх мөр. Прокси сервер нэвтрэлт шаарддаггүй бол орхиж болно.

• productType — төрөл: Number; заавал биш. Энэ параметр security agent-ийн ажиллах горимыг тодорхойлно. Боломжит утга:

- 0 — Detection and prevention горим, бүрэн endpoint security agent-ийн анхдагч.
- 3 — EDR (Report only) горим, Bitdefender EDR agent-ийн анхдагч.
- 5 — Phasr Standalone горим, PHASR Standalone agent-ийн анхдагч.

Дэлгэрэнгүйг Parameter Info хэсгээс үзнэ үү.

Параметрийн мэдээлэл (Parameter Info)

• Bitdefender EDR хэрэглэгчид зөвхөн EDR (Report only) багц үүсгэж болно; productType-ийг зааж өгөх нь заавал биш.

• GravityZone Business Security, Advanced Business Security, Business Security Premium хэрэглэгчид зөвхөн Detection and prevention багц үүсгэж болно; productType-ийг зааж өгөх нь заавал биш.

• GravityZone Business Security Enterprise, EDR Cloud, XDR хэрэглэгчид EDR (Report only) болон Detection and prevention хоёр төрлийн багцыг үүсгэж болно; EDR (Report only) багц үүсгэхийн тулд productType-ийг заавал зааж өгнө.

• EDR (Report only) багц нь хэрэглэгчийн заасан сонголтуудыг дарж бичих урьдчилан тодорхойлсон параметрүүдтэй байдаг. Урьдчилан тодорхойлсон параметрүүд:

- modules

- edrSensor - true
- contentControl - true
- networkAttackDefense - true
- advancedThreatControl - true
- other modules - false

- scanMode - n/a

- settings.removeCompetitors - false

- settings.scanBeforeInstall - false

- roles.exchange - false

• PHASR Standalone багц нь хэрэглэгчийн заасан сонголтуудыг дарж бичих урьдчилан тодорхойлсон параметрүүдтэй байдаг. Урьдчилан тодорхойлсон параметрүүд:

- modules

- phasr - true

- scanMode - n/a

- settings.removeCompetitors - false

- settings.scanBeforeInstall - false

- roles.exchange - false

• integrityMonitoring модуль нь EDR (Report only) бүтээгдэхүүний төрөлд боломжгүй.

Буцаах утга

Энэ арга Boolean утга буцаах ба багцыг амжилттай шинэчилсэн бол True байна.

Жишээ

Хүсэлт:

{
     "params": {
       "packageId": "652feab6b9684f3ba80685d5"
       "packageName": "a unique name",
       "companyId": "54a1a1d3b1a43d2b347b23c1",
       "description": "package 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
  }