getNetworkInventoryItems: сүлжээний инвентарийн элементүүдийг авах
Энэ хуудсыг AI-аар орчуулж, автоматаар шалгасан. Нарийн тохиргоо хийхээсээ өмнө англи эхтэй тулгаж болно.
Энэ method нь сүлжээний инвентарийн элементүүдийг буцаана.
Service-үүд
Энэ method нь API URL-д {service} нэрийг оруулахыг шаардана. Зөвшөөрөгдсөн service-үүд:
computers- "Computers and Virtual Machines" хувьдvirtualmachines- "Virtual Machines" хувьд
Жишээ нь virtualmachines service-ийн хүсэлтийн URL:
https://YOUR-HOSTNAME/api/v1.0/jsonrpc/network/virtualmachines
details гишүүн
Сүлжээний инвентарийн зарим элемент details гишүүнийг агуулна. Энэ гишүүн нь элементийн талаар нэмэлт мэдээлэл өгнө. Мэдээлэл нь элементийн төрлөөс хамаарна.
| Элементийн төрөл | Details |
|---|---|
| 5 (computer) ба 6 (virtual machine) | label - төгсгөлийн төхөөрөмжид оноосон шошго; fqdn - төгсгөлийн төхөөрөмжийн FQDN; groupId - төгсгөлийн төхөөрөмжийн бүлгийн ID; isManaged - төгсгөлийн төхөөрөмж удирдагдаж байвал boolean true; machineType - машины төрөл: (1 - computer, 2 - virtual machine, 0 - Other); operatingSystemVersion - төгсгөлийн төхөөрөмжийн үйлдлийн системийн хувилбар; isIsolated - төгсгөлийн төхөөрөмж одоогоор тусгаарлах (isolation) үйлдлээр сүлжээнээс тусгаарлагдсан бол boolean true; ip - локал IP хаяг; publicIp - олон нийтийн (public) IP хаяг; macs - MAC хаягуудын жагсаалт; ssid - Active Directory SID; managedWithBest - энэ төгсгөлийн төхөөрөмж дээр BEST суулгасан бол boolean true; isContainerHost - Container Host бол boolean true; managedExchangeServer - Exchange Server бол boolean true; managedRelay - Relay үүрэгтэй бол boolean true; securityServer - Security Server бол boolean true; managedWithNsx - VMware NSX дата төвийн төгсгөлийн төхөөрөмж бол boolean true; managedWithVShield - VMware vShield орчны төгсгөлийн төхөөрөмж бол boolean true; modules - суулгасан модулиуд болон тэдгээрийн төлөвийг мэдээлэх Object. Талбарууд Boolean утгатай: модуль идэвхтэй бол true, идэвхгүй бол false. Боломжит талбарууд: advancedThreatControl, antimalware, contentControl, deviceControl, firewall, powerUser, encryption, edrSensor, hyperDetect, patchManagement, relay, sandboxAnalyzer, exchange, advancedAntiExploit, containerProtection, networkAttackDefense |
Жишээнүүд
1 - Тодорхой эцэг объектын доорх сүлжээний бүх модноос компани болон компьютеруудыг авах
Хүсэлт
{
"params": {
"parentId": "5c373e1a1da1974a678b456d",
"perPage": 100,
"filters": {
"type": {
"groups": true
},
"depth": {
"allItemsRecursively": true
}
}
},
"jsonrpc": "2.0",
"method": "getNetworkInventoryItems",
"id": "tracking"
}Хариу:
{
"id": "103d7b05-ec02-481b-9ed6-c07b97de2b7a",
"jsonrpc": "2.0",
"result": {
"page": 2,
"pagesCount": 11,
"perPage": 1,
"total": 11,
"items": [
{
"id": "21a295eeb1a43d8b497b24b7",
"name": "Computer",
"type": 5,
"parentId": "21a295eeb1a43d8b497b24b7",
"companyId": "21a295eeb1a43d8b497b24b7",
"details": {
"label": "endpoint 2",
"fqdn": "endpoint2.local",
"groupId": "5a5f4d36b1a43d5f097b23bb",
"isManaged": true,
"machineType": 2,
"operatingSystemVersion": "Windows Server",
"isIsolated": false,
"ip": "60.40.10.220",
"publicIp": "198.51.100.42",
"macs": [
"324935237346"
],
"modules": {
"advancedThreatControl": false,
"antimalware": true,
"contentControl": false,
"deviceControl": false,
"firewall": false,
"powerUser": false,
"networkAttackDefense": false
},
"ssid": ""
}
}
]
}
}2 - Active Directory-оос компьютеруудыг авах
Эхлээд AD хавтасны ID-г олж, дараа нь тэр ID-г хоёр дахь дуудлагын parentId болгон ашиглан дотор нь байгаа бодит компьютеруудыг авна.
- Active Directory хавтасны ID-г ол.
Тайлбар
Энэ алхамд манай компанийн дээд түвшний контейнеруудаас Active Directory интеграцийг илэрхийлэх контейнерийг хайна. AD-д харгалзах type: 4 (Group) төрлийн элементүүдийг хайж байна.
Хүсэлт
{
"jsonrpc": "2.0",
"id": "step1-find-ad-folder",
"method": "getNetworkInventoryItems",
"params": {
"parentId": "6221f9582dab425234613c82",
"filters": {
"details": {
"name": "Active Directory"
}
}
}
}Хариу
{
"id": "step1-find-ad-folder",
"jsonrpc": "2.0",
"result": {
"total": 1,
"page": 1,
"perPage": 100,
"pagesCount": 1,
"hasMoreRecords": false,
"items": [
{
"id": "64a1bc2e8f3d4a001e5c7890",
"name": "Active Directory",
"type": 4,
"parentId": "6221f9592dab425234613c88",
"companyId": "6221f9582dab425234613c82"
}
]
}
}- Active Directory хавтас доторх бүх компьютерийг ав.
Тайлбар
Өмнөх алхамд олсон AD хавтасны ID-г parentId болгон ашиглаж, дотор нь байгаа бүх компьютерийг рекурсив байдлаар, бүх details сонголтыг идэвхжүүлэн авна.
Энэ жишээнд AD хавтасны ID нь 64a1bc2e8f3d4a001e5c7890 байна.
Хүсэлт
{
"jsonrpc": "2.0",
"method": "getNetworkInventoryItems",
"id": "step2-get-ad-computers",
"params": {
"parentId": "64a1bc2e8f3d4a001e5c7890",
"filters": {
"type": {
"computers": true
},
"depth": {
"allItemsRecursively": true
},
"security": {
"management": {
"managedWithBest": true
}
}
},
"options": {
"companies": {
"returnAllProducts": true,
"includeRiskScore": true
},
"endpoints": {
"returnProductOutdated": true,
"includeScanLogs": true,
"includeRiskScore": true
}
}
}
}{
"jsonrpc": "2.0",
"method": "getNetworkInventoryItems",
"id": "step2-get-ad-computers",
"params": {
"parentId": "64a1bc2e8f3d4a001e5c7890",
"filters": {
"type": {
"computers": true
},
"depth": {
"allItemsRecursively": true
},
"security": {
"management": {
"managedWithBest": true
}
}
},
"options": {
"endpoints": {
"returnProductOutdated": true,
"includeScanLogs": true,
"includeRiskScore": true
}
}
}
}Хариу
{
"id": "step2-get-ad-computers",
"jsonrpc": "2.0",
"result": {
"total": 3,
"page": 1,
"perPage": 100,
"pagesCount": 1,
"hasMoreRecords": false,
"items": [
{
"id": "63a1795cdf372f0e7f84a3f2",
"name": "WIN-C6UPHBAQKMP",
"type": 5,
"parentId": "64a1bc2e8f3d4a001e5c7890",
"companyId": "6221f9582dab425234613c82",
"details": {
"label": "",
"fqdn": "win-c6uphbaqkmp",
"groupId": "6221f9592dab425234613c88",
"isManaged": true,
"machineType": 2,
"operatingSystemVersion": "Windows Server 2019 Standard",
"ip": "10.18.156.11",
"publicIp": "198.51.100.42",
"macs": [
"005056962842"
],
"ssid": "S-1-5-21-3623811015-3361044348-30300820-1013",
"managedWithBest": true,
"policy": {
"id": "5121da426803fa2d0e000017",
"name": "Default policy",
"applied": true
},
"modules": {
"antimalware": true,
"firewall": false,
"contentControl": true,
"powerUser": false,
"deviceControl": false,
"advancedThreatControl": true,
"applicationControl": false,
"encryption": false,
"networkAttackDefense": true,
"advancedAntiExploit": true,
"edrSensor": true,
"hyperDetect": true,
"remoteEnginesScanning": false,
"sandboxAnalyzer": false,
"riskManagement": false
},
"productOutdated": true
}
},
{
"id": "639a4a79962c330620b393a9",
"name": "WIN-01M8RUNUG5I",
"type": 5,
"parentId": "64a1bc2e8f3d4a001e5c7891",
"companyId": "6221f9582dab425234613c82",
"details": {
"label": "",
"fqdn": "win-01m8runug5i",
"groupId": "6221f9592dab425234613c88",
"isManaged": true,
"machineType": 2,
"operatingSystemVersion": "Windows Server 2016 Standard",
"ip": "10.18.149.152",
"publicIp": "198.51.100.42",
"macs": [
"005056968ff0"
],
"ssid": "S-1-5-21-3623811015-3361044348-30300820-1045",
"managedWithBest": true,
"policy": {
"id": "63a181f6a1f3bb1a850dc372",
"name": "no-update",
"applied": true
},
"modules": {
"antimalware": true,
"firewall": false,
"contentControl": true,
"powerUser": false,
"deviceControl": false,
"advancedThreatControl": true,
"applicationControl": false,
"encryption": false,
"networkAttackDefense": true,
"advancedAntiExploit": true,
"edrSensor": true,
"hyperDetect": true,
"remoteEnginesScanning": false,
"sandboxAnalyzer": false,
"riskManagement": false
},
"productOutdated": false
}
},
{
"id": "639b23b624956ebb5dd2b2f3",
"name": "UBUNTU-HELIX",
"type": 5,
"parentId": "64a1bc2e8f3d4a001e5c7890",
"companyId": "6221f9582dab425234613c82",
"details": {
"label": "",
"fqdn": "ubuntu-helix",
"groupId": "6221f9592dab425234613c88",
"isManaged": true,
"machineType": 2,
"operatingSystemVersion": "Linux Ubuntu 20.04.3 LTS",
"ip": "10.18.155.140",
"publicIp": "198.51.100.44",
"macs": [
"005056962499"
],
"ssid": "",
"managedWithBest": true,
"policy": {
"id": "5121da426803fa2d0e000017",
"name": "Default policy",
"applied": true
},
"modules": {
"antimalware": true,
"firewall": false,
"contentControl": false,
"powerUser": false,
"deviceControl": false,
"advancedThreatControl": false,
"applicationControl": false,
"encryption": false,
"networkAttackDefense": true,
"advancedAntiExploit": true,
"hyperDetect": true,
"riskManagement": false
},
"productOutdated": false
}
}
]
}
}Параметрүүд
| Параметр | Төрөл | Заавал биш эсэх | Тайлбар |
|---|---|---|---|
| parentId | String | Тийм | Зорилтот компани эсвэл бүлгийн ID. Заагаагүй бол API түлхүүртэй холбогдсон компанийн зорилтот объектууд дотор байгаа элементүүдийг буцаана. |
| filters | Object | Тийм | Төгсгөлийн төхөөрөмжүүдийн жагсаалтыг лавлахад ашиглах шүүлтүүрүүд. Боломжит шүүлтүүр ба тэдгээрийг хэрхэн ашиглах талаар Available filters хэсгээс үз. |
| viewType | Number | Тийм | Харагдацын төрлийн ID. Виртуалчлалын платформ бүр инвентарийг өөрийн тусгай харагдацаар харуулдаг. VMware интеграцид боломжит сонголтууд: 1 - Hosts and Clusters харагдац (өгөгдмөл); 2 - Virtual Machines харагдац. Citrix XenServer интеграцид боломжит сонголтууд: 3 - Server харагдац (өгөгдмөл); 4 - Folder харагдац. |
| page | Number | Тийм | Үр дүнгийн хуудасны дугаар. Өгөгдмөл хуудасны дугаар 1. |
| perPage | Number | Тийм | Буцаах нэг хуудасны зүйлсийн тоо. Дээд хязгаар нь нэг хуудсанд 100 зүйл. Өгөгдмөл утга: нэг хуудсанд 30 зүйл. |
Available filters (боломжит шүүлтүүрүүд)
| Хэсэг | Дэд хэсэг | Шүүлтүүрийн сонголтууд |
|---|---|---|
| type | groups - Boolean, төгсгөлийн төхөөрөмжүүдийн бүх custom бүлгийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers service-д боломжтой. computers - Boolean, бүх компьютерийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers service-д боломжтой. virtualMachines - Boolean, бүх виртуал машиныг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers болон virtualmachines service-д боломжтой. clusters - Boolean, бүх Virtualization Cluster-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. hosts - Boolean, бүх Virtualization Host-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. dataCenters - Boolean, бүх Datacenter-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. vApps - Boolean, бүх vShield App-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. resourcePools - Boolean, бүх Resource Pool-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. folders - Boolean, бүх Virtualization Folder-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. pools - Boolean, бүх Virtualization Pool-ыг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. | |
| security | management | managedWithBest - Boolean, security agent суулгасан бүх төгсгөлийн төхөөрөмжийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers болон virtualmachines service-д боломжтой. isContainerHost - Boolean, container host хамгаалалт суулгасан бүх төгсгөлийн төхөөрөмжийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers болон virtualmachines service-д боломжтой. managedExchangeServers - Boolean, хамгаалагдсан бүх Exchange сервер шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers болон virtualmachines service-д боломжтой. Энэ шүүлтүүр нь security service-ийг хамарсан хүчинтэй лицензийн түлхүүр шаардана. managedRelays - Boolean, Relay үүрэгтэй бүх төгсгөлийн төхөөрөмжийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers болон virtualmachines service-д боломжтой. securityServers - Boolean, бүх Security Server-ийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр computers болон virtualmachines service-д боломжтой. managedWithNsx - Boolean, VMware NSX дата төвүүдэд хамгаалагдсан төгсгөлийн төхөөрөмжүүдийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. Энэ шүүлтүүр нь хүчинтэй виртуалчлалын лицензийн түлхүүр шаардана. managedWithVShield - Boolean, VMware vShield орчинд хамгаалагдсан төгсгөлийн төхөөрөмжүүдийг шүүнэ. Өгөгдмөл утга: false. Энэ шүүлтүүр virtualmachines service-д боломжтой. Энэ шүүлтүүр нь хүчинтэй виртуалчлалын лицензийн түлхүүр шаардана. |
| depth | allItemsRecursively - Boolean, компанийн Network Inventory доторх бүх төгсгөлийн төхөөрөмжийг рекурсив (доод түвшин хүртэл) шүүнэ. Өгөгдмөл утга: false. | |
| details | ssid - string, хамгаалалтын төлвөөс үл хамааран төгсгөлийн төхөөрөмжүүдийг шүүхэд ашиглах SSID (төгсгөлийн төхөөрөмжийн Active Directory SID). macs - array, хамгаалалтын төлвөөс үл хамааран төгсгөлийн төхөөрөмжүүдийг шүүхэд ашиглах MAC хаягуудын жагсаалт. name - элементүүдийг нэрээр шүүх String. Мөрийн хамгийн бага урт гурван тэмдэгт байх ёстой. |
Чухал
- Зарим шүүлтүүр тодорхой лиценз идэвхтэй байхыг шаарддаг. Эс бөгөөс тэдгээрийг үл тооно, ингэснээр API-ийн хариу буруу байж болно.
- name талбар хэсэгчилсэн тохирлоор ажиллана.
Шүүлтүүр нь нэр нь заасан утгатай яг таарсан эсвэл тэр утгаар эхэлсэн элементүүдийг буцаана. Заасан утгыг дагавар болгон ашиглахын тулд од (*) тэмдэг хэрэглэнэ.
Жишээ нь:
- name нь computer бол API нь нэр нь computer-ээр эхэлсэн бүх элементийг буцаана.
- name нь *puter бол API нь нэрэндээ puter агуулсан бүх элементийн жагсаалтыг буцаана.
Буцаах утга
Энэ method нь сүлжээний элементүүдийн мэдээллийг агуулсан Object буцаана. Буцаах объект дараахыг агуулна:
- page - одоогийн хуудас
- pagesCount - нийт хуудасны тоо
- perPage - нэг хуудсанд буцаасан зүйлсийн нийт тоо
- total - нийт зүйлсийн тоо
- items - элементүүдийн жагсаалт агуулсан array. Жагсаалтын оруулга бүр дараах талбартай:
- id, сүлжээний элементийн ID,
- name, сүлжээний элементийн нэр,
- parentId, эцэг контейнерийн ID,
- type, сүлжээний элементийн төрөл: 1 - Company, 2 - Root Container (Companies and Network containers), 3 - Company Folder, 4 - Group, 5 - Computer, 6 - Virtual Machine, 7 - EC2 Instance, 14 - Containers Group, 15 - Container Host Folder, 16 - Container.
- details, элементийн талаарх нэмэлт мэдээлэл. Энэ талбар 1 - Companies, 5 - Computers, 6 - Virtual Machines, 7 - EC2 Instances болон 16 - Containers төрлүүдэд боломжтой. details гишүүний агуулгын талаар details гишүүн хэсгийг үз.
details гишүүн
Сүлжээний инвентарийн зарим элемент details гишүүнийг агуулна. Энэ гишүүн нь элементийн талаар нэмэлт мэдээлэл өгнө. Мэдээлэл нь элементийн төрлөөс хамаарна.
| Элементийн төрөл | Details |
|---|---|
| 5 (computer) ба 6 (virtual machine) | label - төгсгөлийн төхөөрөмжид оноосон шошго; fqdn - төгсгөлийн төхөөрөмжийн FQDN; groupId - төгсгөлийн төхөөрөмжийн бүлгийн ID; isManaged - төгсгөлийн төхөөрөмж удирдагдаж байвал boolean true; machineType - машины төрөл: (1 - computer, 2 - virtual machine, 0 - Other); operatingSystemVersion - төгсгөлийн төхөөрөмжийн үйлдлийн системийн хувилбар; isIsolated - төгсгөлийн төхөөрөмж одоогоор тусгаарлах (isolation) үйлдлээр сүлжээнээс тусгаарлагдсан бол boolean true; ip - локал IP хаяг; macs - MAC хаягуудын жагсаалт; ssid - Active Directory SID; managedWithBest - энэ төгсгөлийн төхөөрөмж дээр BEST суулгасан бол boolean true; isContainerHost - Container Host бол boolean true; managedExchangeServer - Exchange Server бол boolean true; managedRelay - Relay үүрэгтэй бол boolean true; securityServer - Security Server бол boolean true; managedWithNsx - VMware NSX дата төвийн төгсгөлийн төхөөрөмж бол boolean true; managedWithVShield - VMware vShield орчны төгсгөлийн төхөөрөмж бол boolean true; modules - суулгасан модулиуд болон тэдгээрийн төлөвийг мэдээлэх Object. Талбарууд Boolean утгатай: модуль идэвхтэй бол true, идэвхгүй бол false. Боломжит талбарууд: advancedThreatControl, antimalware, contentControl, deviceControl, firewall, powerUser, encryption, edrSensor, hyperDetect, patchManagement, relay, sandboxAnalyzer, exchange, advancedAntiExploit, containerProtection, networkAttackDefense |
Жишээ
Хүсэлт:
{
"params": {
"parentId": "5c373e1a1da1974a678b456d",
"perPage": 100,
"filters": {
"type": {
"groups": true
},
"depth": {
"allItemsRecursively": true
}
}
},
"jsonrpc": "2.0",
"method": "getNetworkInventoryItems",
"id": "tracking"
}Хариу:
{
"jsonrpc": "2.0",
"id": "tracking",
"result": {
"page": 1,
"pagesCount": 1,
"perPage": 100,
"total": 1,
"items": [
{
"id": "21a295eeb1a43d8b497b24b7",
"name": "Computer",
"type": 5,
"parentId": "5c373e1a1da1974a678b456d",
"companyId": "5a5f4d36b1a43d5f097b23bb",
"details": {
"label": "endpoint 2",
"fqdn": "endpoint2.local",
"groupId": "5c373e1a1da1974a678b456d",
"isManaged": true,
"machineType": 2,
"operatingSystemVersion": "Windows Server",
"ip": "60.40.10.220",
"macs": [
"324935237346"
],
"modules": {
"advancedThreatControl": false,
"antimalware": true,
"contentControl": false,
"deviceControl": false,
"firewall": false,
"powerUser": false,
"networkAttackDefense": false
},
"ssid": ""
}
}
]
}
}Энэ хуудсанд гарсан нэр томъёо
- Endpoint
- Хамгаалж буй компьютер, сервер, виртуал машин
- Security agent
- Төхөөрөмж дээр суулгадаг Bitdefender-ийн хамгаалалтын программ (BEST)
- Policy
- Хамгаалалтын тохиргооны багц; төхөөрөмж эсвэл бүлэгт оноодог
- Network
- Таны байгууллагын бүх төхөөрөмжийн жагсаалт (Inventory)
- Relay
- Шинэчлэлт, суулгацыг дотоод сүлжээнд түгээдэг агент