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

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

Параметрүүд

modules

Түлхүүрүүд:

• 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
• phasr

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

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

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

scanMode

• Зөвшөөрөгдөх түлхүүрүүд: 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

Утгууд нь:

• removeCompetitors
• uninstallPassword
• customInstallationPath
• customGroupId
• vmsCustomGroupId

removeCompetitors-ийн утга 1 (идэвхтэй) эсвэл 0 (идэвхгүй) байж болно. uninstallPassword нь string байх бөгөөд нарийн төвөгтэй байдлын шаардлагыг хангана: нууц үг хамгийн багадаа 6 тэмдэгттэй, дор хаяж нэг цифр, нэг том үсэг, нэг жижиг үсэг, нэг тусгай тэмдэгт агуулсан байх ёстой; customInstallationPath нь багц суулгагдах Windows-ийн хүчинтэй зам байх ёстой (зөвхөн Windows үйлдлийн системд ажиллана). customGroupId нь Computers and Virtual Machines View-д шинэ endpoint-ийг байршуулах custom group нэгжийн ID-г илэрхийлэх string байна. vmsCustomGroupId нь Virtual Machines View-д шинэ endpoint-ийг байршуулах custom group нэгжийн ID-г илэрхийлэх string байна. Бүх утга заавал биш.

roles

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

deploymentOptions

• type, endpoint-ийн холбогдох нэгжийг заасан бүхэл тоо. Энэ нэгж суулгалтын kit болон шинэчлэлтийг хүргэнэ. Боломжит утгууд: Bitdefender Update Server-ээс энгийн суулгахад 1; Relay-ээр дамжуулан суулгахад 2.
• relayId, Relay role идэвхтэй endpoint-ийн ID-г илэрхийлэх string. type сонголт 2 (Relay ашиглан суулгах) үед энэ талбарыг заавал тохируулна.
• useCustomCommunicationServer, endpoint тусгай communication server appliance-тай холбогдох эсэхийг сонгох boolean. Боломжит утга: тусгай communication server appliance заахад True, үндсэн communication server appliance ашиглахад False. Энэ сонголтыг суулгалтын төрөл 1 (энгийн суулгалт) үед тохируулж болно.
• communicationServer, тусгай communication server appliance-ийн IP эсвэл hostname агуулсан string. Энэ сонголтыг зөвхөн useCustomCommunicationServer нь True үед тохируулна.
• useCommunicationProxy, endpoint интернэтээр холбогдохдоо proxy ашиглах эсэхийг зааж өгөх boolean. Боломжит утга: proxy ашиглах бол True, үгүй бол False.
• proxyServer, proxy серверийн IP эсвэл домэйн нэрийг илэрхийлэх string. Хүчинтэй утга нь IPV4 эсвэл IPV6 форматтай IP хаяг, мөн RFC 1035-д тодорхойлсон домэйн нэр. useCommunicationProxy нь True үед энэ сонголт заавал шаардлагатай.
• proxyPort, proxy сервер рүү хандах портыг илэрхийлэх бүхэл тоо. Хүчинтэй утга 1-ээс 65535 хүртэл. useCommunicationProxy нь True үед энэ сонголт заавал шаардлагатай.
• proxyUsername, proxy серверийн нэвтрэлтэд шаардагдах хэрэглэгчийн нэрийг илэрхийлэх string. Proxy сервер нэвтрэлт шаарддаггүй бол энэ сонголтыг орхиж болно.
• proxyPassword, proxy сервер дээрх нэвтрэлтэд шаардагдах нууц үгийг илэрхийлэх string. Proxy сервер нэвтрэлт шаарддаггүй бол энэ сонголтыг орхиж болно.

productType

Энэ параметр нь security agent-ийн ажиллах горимыг тодорхойлно. Боломжит утгууд:

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

Нэмэлт мэдээллийг доорх "Параметрийн мэдээлэл" хэсгээс үзнэ үү.

Параметрийн мэдээлэл

• 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

Буцаах утга

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

Жишээ

Хүсэлт:

{
     "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
}