KSC Open API
Kaspersky Security Center API description
|
"KLHST_WKS_PRODUCT_NAME" | paramString | Product name. |
"KLHST_WKS_PRODUCT_VERSION" | paramString | Product version name. |
"KLHST_WKS_PRODUCT_ID" | paramString | Search-only attribute, product name and version are divided by a slash (e.g. '1093/1.0.0.0', '1103/1.0.0.0', 'KES/10.2.2.0'), up to 64 chars, supported since 10SP2. |
"KLHST_WKS_PRODUCT_DISPLAY_VERSION" | paramString | Product build. |
"KLHST_WKS_PRODUCT_BUILD" | paramLong | Product build. A 64-bit number, each build number component occupies 16 bits. For example, 2814758357182738 = 0xA000200022912 means 0x000A.0x0002.0x0002.0x2912 = 10.2.2.10514. |
"KLHST_WKS_PRODUCT_INSTALLED" | paramDateTime | Anti-virus installed, in UTC. |
"KLHST_WKS_PRODUCT_TAG_NAME" | paramString | Value of the tag that is assigned to a product that is installed on the host. |
"KLHST_INCLUDED_WKS_PRODUCT_TAG_NAME" | paramString | Used to search by value of the tag that is not assigned to products. |
"KLHST_HF_DN" | paramString | Display name of hotfix of product. |
"KLHST_HF_ID" | paramString | String If of hotfix of product. |
"KLHST_INCLUDED_HF_DN" | paramString | Used to search by product hotfix that is not installed on the host. |
"KLHST_WKS_AV_BASES_RECORDS" | paramInt | Number of records in anti-virus bases. |
"KLHST_WKS_AV_BASES_DATE" | paramDateTime | Anti-virus bases, in UTC. |
"KLHST_WKS_AV_BASES_SEC" | paramInt | Anti-virus bases age in seconds (in comparison to appropriate bases on server). |
"KLHST_WKS_STATUS_MASK_N" | paramInt | Extended status mask bit, where N = 0..8. |
"KLHST_NAG_INSTID" | paramString | Network Agent installation ID. |
"KLHST_WKS_GROUPID_GP" | paramInt | ID of administration group that is an ancestor for a host (supported by Administration Server 7.0 or higher). |
"KLDPNS_ID" | paramInt | ID of IP subnet where the host is located. |
"KLHST_AD_GROUP" | paramInt | ID of AD group. |
"KLHST_AD_ORGUNIT" | paramInt | ID of AD organization unit where the host is located. |
"KLHST_AD_ORGUNIT_GP" | paramInt | ID of AD organization unit where the host or its ancestor is located (supported by Administration Server 7.0 or higher). |
"KLHST_UNCURED_PRESENT" | paramBool | The parameter accepts true if the host has uncured objects (supported by Administration Server 7.0 or higher). |
"KLHST_INACT_BASES_PRESENT" | paramBool | The parameter accepts true if the host has obsolete anti-virus bases (supported by Administration Server 7.0 or higher). |
"KLHST_WKS_HSDP_REASON" | paramString | Searching on the product-defined host status reason ID, since KSC 10 SP2 MR1. |
"KLHST_CLOUD_CONTAINER" | paramBinary | ID of a cloud container where the host is located. See SrvView List of server cloud containers. |
"KLHST_CLOUD_CONTAINER_GP" | paramBinary | ID of a cloud container where the host or its ancestor is located. For more information, see SrvView List of server cloud containers. Also, top-level cloud container ID may be used. |
"KLHST_MOB_HAS_OWNER_CERT" | paramBool | The parameter accepts true if mobile host has owner certificate. The attribute has following format: <product>/<version>/<reason_guid_in_hex> Where:
Examples:
|
"KLHST_WKS_TAG_NAME" | paramString | Value of the tag that is assigned to host. |
"KLHST_INCLUDED_WKS_TAG_NAME" | paramString | Used to search by value of the tag that is not assigned to the host. |
"KLHST_WKS_USER_BINID" | paramBinary | Universal user ID, identifies user. |
"KLHST_WKS_SESSION_USER_BINID" | paramBinary | Universal user ID, identifies user. Searches among opened sessions only. |
"KLHST_MOB_HAS_OWNER_CERT" | paramBool | The parameter accepts true if mobile host has owner certificate. Read-only. |
"KLHST_WKS_COMPETITOR_PRODUCT_NAME" | paramString | Display name of competitor application that is installed on the host. |
"KLHST_INVENTORY_PRODUCT_NAME" | paramString | Display name of software application that is installed on host. See Full-text attribute. |
"KLHST_INVENTORY_PRODUCT_DISPLAY_VERSION" | paramString | Display version of software application that is installed on host. See Full-text attribute. |
"KLHST_INVENTORY_PRODUCT_PUBLISHER" | paramString | Publisher of software application that is installed on host. See Full-text attribute. |
"KLHST_INVENTORY_PRODUCT_STRID" | paramString | String ID of software application that is installed on host (unique for all Administration Servers). |
"KLHST_INVENTORY_PRODUCT_INSTALL_DATE" | paramDateTime | Software application installed, in UTC. |
"KLHST_INVENTORY_PRODUCT_INSTALL_DIR" | paramString | Software application installation directory. |
"KLHST_INACT_BASES_PRESENT" | paramBool | Host has obsolete anti-virus bases. |
"KLHST_INVENTORY_PRODUCT_UNINSTALLSTRING" | paramString | Command to uninstall the software application. |
"KLHST_INVENTORY_PRODUCT_QUIETUNINSTALLSTRING" | paramString | Command to uninstall the software application in quiet mode. |
"KLHST_INVENTORY_INCLUDED_PRODUCT_NAME" | paramString | Used to search by display name of the software application that is not installed on host. |
"KLHST_INVENTORY_PATCH_NAME" | paramString | Display name of the software application update that is installed on host. |
"KLHST_INVENTORY_PATCH_DISPLAY_VERSION" | paramString | Display version of the software application update that is installed on host. |
"KLHST_INVENTORY_PATCH_PUBLISHER" | paramString | Publisher of the software application update that is installed on host. |
"KLHST_INVENTORY_INCLUDED_PATCH_NAME" | paramString | Used to search by display name of the software application update that is not installed on host. |
"KLHST_INVENTORY_PRODUCT_TAG_NAME" | paramString | Value of the tag that is assigned to the software application that is installed on host. |
"KLHST_INVENTORY_INCLUDED_PRODUCT_TAG_NAME" | paramString | Used to search by value of the tag that is assigned to the software application that is not installed on host. |
"KLHST_HWINV_DEVICE_NAME" | paramString | Name of hardware device that is present on host. See Full-text attribute. |
"KLHST_HWINV_DEVICE_DESCR" | paramString | Description of hardware device that is present on host. See Full-text attribute. |
"KLHST_HWINV_DEVICE_MANUFACTURER" | paramString | Manufacturer of hardware device that is present on host. See Full-text attribute. |
"KLHST_HWINV_DRIVER_VERSION" | paramString | Version of driver for hardware device that is present on host. |
"KLHST_HWINV_DRIVER_PROVIDER" | paramString | Provider of driver for hardware device that is present on host. See Full-text attribute. |
"KLHST_HWINV_STORAGE_NAME" | paramString | Name of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_DESCR" | paramString | Description of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_MANUF" | paramString | Manufacturer of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_SERIALNUM" | paramString | Serial number of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_INVNUM" | paramString | Inventory number of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_USERNAME" | paramString | User name of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_PLACEMENT" | paramString | Placement of hardware storage object that is present on host. |
"KLHST_HWINV_STORAGE_DISKSIZE" | paramInt | Size of the disk on host. |
"KLHST_HWINV_STORAGE_MEMSIZE" | paramInt | Memory size on host. |
"KLHST_HWINV_CPU_SPEED" | paramInt | CPU on host. |
"KLHST_HWINV_CPU_THREADS" | paramInt | Number of CPU threads on host. |
"KLHST_EXEFILE_HST_FILE_ID" | paramString | File instance ID on the host. |
"KLHST_EXEFILE_HST_FILE_BIN_ID" | paramBinary | File instance ID on the host; binary presentation of the "HST_FILE_ID". |
"KLHST_EXEFILE_FILE_ID" | paramInt | File ID from database (unique inside one Administration Server). |
"KLHST_EXEFILE_FILE_NAME" | paramString | File name (get from file VersionInfo). |
"KLHST_EXEFILE_FILE_VERSION" | paramInt | File version (get from file VersionInfo). |
"KLHST_EXEFILE_FILEVERSIONRAW" | paramString | File version in raw form (get from file VersionInfo). |
"KLHST_EXEFILE_PRODUCT_NAME" | paramString | Product name of the file (get from file VersionInfo). |
"KLHST_EXEFILE_PRODUCT_VERSION" | paramInt | Product version of the file (get from file VersionInfo). |
"KLHST_EXEFILE_PRODUCT_VERSIONRAW" | paramString | Product version of the file in raw form (get from file VersionInfo). |
"KLHST_EXEFILE_ORGANIZATION_NAME" | paramString | Organization name (get from file VersionInfo). |
"KLHST_VULN_VULNERABILITY_ID" | paramString | Vulnerability ID. |
"VULN_MAX_SEVERITY" | paramInt | Severity rating of the vulnerability, set of bits:
|
"KLHST_VULN_DISAPPEARANCE_TIME" | paramDateTime | Vulnerability disappearance, in UTC. |
"KLHST_WUS_UPD_UPDATE_ID" | paramString | WUS update ID. |
"KLHST_WUS_UPD_REVISION_NUMBER" | paramString | WUS update revision number. |
"KLHST_WUS_UPD_INSTALL_STATE" | paramInt | WUS update install state. For more information, see Software update installation state enum. |
"KLHST_VAPM_KL_UPDATE_ID" | paramBinary | Kaspersky product update ID. |
"KLHST_VAPM_KL_INSTALL_STATE" | paramInt | Kaspersky product update install state (same values as for "KLHST_WUS_UPD_INSTALL_STATE"). |
"KLHST_VAPM_PRODUCT_PATCH_GLOBAL_ID" | paramInt | Global ID of vapm product patch. |
"KLHST_VAPM_PRODUCT_PATCH_LCID" | paramInt | Vapm product patch LCID. |
"KLHST_VAPM_PRODUCT_PATCH_INSTALL_STATE" | paramInt | Vapm product patch install state (same values as for "KLHST_WUS_UPD_INSTALL_STATE"). |
"KLHST_CLOUD_CONTAINER" | paramBool | The parameter accepts true if host belongs to the specified cloud container (supported by Administration Server 10.5 or higher). |
"KLHST_CLOUD_CONTAINER_GP" | paramBinary | ID of cloud container where the host or its ancestor is located (supported by Administration Server 10.5 or higher). |
"KLHST_CLOUD_HOST_PLATFORM" | paramInt | Public cloud host platform type which accepts one of following values Instance platform type in public cloud. |
"KLHST_CLOUD_HOST_BINID" | paramBinary | Internal ID of the cloud host (supported by Administration Server 10.5 or higher). |
"KLHST_CLOUD_HOST_TYPE" | paramInt | Cloud type which accepts one of the values from Cloud type. |