KSC Open API
13.1
Kaspersky Security Center API description
|
List of host attributes is presented below.
"KLHST_WKS_DN" | paramString | Host display name. | |||||||||||||||||||||||||||
"KLHST_WKS_GROUPID" | paramInt | ID of administration group where host is located. | Host may be moved by changing the value of this attribute. | ||||||||||||||||||||||||||
"KLHST_WKS_CREATED" | paramDateTime | Time of host record creation. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_LAST_VISIBLE" | paramDateTime | Last host visibility time. | |||||||||||||||||||||||||||
"KLHST_WKS_LAST_INFOUDATE" | paramDateTime | Last update host information time. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_STATUS" | paramInt | Host status - bit set.
| Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_LAST_UPDATE" | paramDateTime | Last anti-virus update, in UTC. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_LAST_NAGENT_CONNECTED" | paramDateTime | Last Network Agent connection, in UTC. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_KEEP_CONNECTION" | paramBool | "Keep connection" flag. Connection between host and Administration Server will be persistent if the attribute accepts true. Use with care - persistent connection takes a lot of system resources on the server. | There may be no more than 100 hosts with this flag set. | ||||||||||||||||||||||||||
"KLHST_WKS_HOSTNAME" | paramString | Host name. A unique server-generated string. | Read-only. | ||||||||||||||||||||||||||
"KLHST_INSTANCEID" | paramString | Network Agent ID. A unique string. Empty string if no Network Agent installed. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_WINHOSTNAME" | paramString | Host windows (NetBIOS) name. | |||||||||||||||||||||||||||
"KLHST_WKS_WINDOMAIN" | paramString | Name of NT domain or workgroup. | |||||||||||||||||||||||||||
"KLHST_WKS_DNSDOMAIN" | paramString | DNS suffix. | |||||||||||||||||||||||||||
"KLHST_WKS_DNSNAME" | paramString | DNS name without DNS suffix. | |||||||||||||||||||||||||||
"KLHST_WKS_FQDN" | paramString | Host FQDN name. | |||||||||||||||||||||||||||
"KLHST_WKS_CTYPE" | paramInt | "Computer type". Bit set.
| |||||||||||||||||||||||||||
"KLHST_WKS_PTYPE" | paramInt | "Platform type". See Platform Type enum | |||||||||||||||||||||||||||
"KLHST_WKS_OS_NAME" | paramString | Operating system name as a string. | |||||||||||||||||||||||||||
"KLHST_WKS_OS_VER_MAJOR" | paramInt | Major part of operating system version. | |||||||||||||||||||||||||||
"KLHST_WKS_OS_VER_MINOR" | paramInt | Minor part of operating system version. | |||||||||||||||||||||||||||
"KLHST_WKS_LAST_FULLSCAN" | paramDateTime | Time of last full scan for viruses, in UTC. | |||||||||||||||||||||||||||
"KLHST_WKS_VIRUS_COUNT" | paramInt | Number of viruses found. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RTP_STATE" | paramInt | State of real-time protection is one of the following:
| Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RTP_ERROR_CODE" | paramInt | Real-time protection error code. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_COMMENT" | paramString | Comments. Full-text attribute. See Full-text attribute. | |||||||||||||||||||||||||||
"KLHST_WKS_IP_LONG" | paramLong | Host IP address (in little-endian byte order). | |||||||||||||||||||||||||||
"KLHST_WKS_CONNECT_IP_LONG" | paramLong | Host "connection IP" address (in little-endian byte order). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_FROM_UNASSIGNED" | paramBool | The parameter accepts true if host is located in "Unassigned computers" or its subgroup. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_UNCURED_COUNT" | paramLong | Number of uncured items in the TIF list. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_STATUS_ID" | paramInt | Extended status ID. If KLHST_WKS_STATUS_ID is different from OK see KLHST_WKS_STATUS_MASK attribute for reasons. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_STATUS_MASK" | paramInt | Extended status mask, bit set. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_STATUS_HSDP" | paramString | One or more HSDP-reasons if KLHST_WKS_STATUS_MASK has bit 18 set. | Read-only. | ||||||||||||||||||||||||||
"HST_HAS_UPDATE_AGENT" | paramBool | Host has a distribution point. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_NAG_VERSION" | paramString | Network Agent build number in format A.B.C[.D]. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RTP_AV_VERSION" | paramString | Protection build number in format A.B.C[.D]. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RTP_AV_BASES_TIME" | paramDateTime | Anti-virus bases time. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_LAST_SYSTEM_START" | paramDateTime | Last system start time. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RBT_REQUIRED" | paramBool | If reboot is required. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RBT_REQUEST_REASON" | paramInt | Reboot request reasons mask, bit set:
| Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RBT_REQUEST_TIME" | paramDateTime | Reboot request time. | Read-only. | ||||||||||||||||||||||||||
"KLHST_APP_INFO" | paramParams | Information about products installed on the host. Has the following format: "KLHST_APP_INFO" | +--<product> (paramParams) | +--<version> (paramParams) | +--"KLHST_APP_STATE" (paramInt) | +--"KLHST_APP_STATE_TIME" (paramDateTime) Where:
| Read-only. May be used in the GetHostInfo method only. | ||||||||||||||||||||||||||
"KLHST_WKS_OSSP_VER_MAJOR" | paramInt | Service Pack version major part (since KSC 10 SP1). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_OSSP_VER_MINOR" | paramInt | Service Pack version minor part (since KSC 10 SP1). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_CPU_ARCH" | paramInt | CPU architecture from the operating system point of view (since KSC 10 SP1). The following values are possible:
| Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_OS_BUILD_NUMBER" | paramInt | Operating system version build number. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_OS_RELEASE_ID" | paramInt | Operating system version release ID (for Windows 10) encoded as a number.
| Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_NAG_VER_ID" | paramInt | Network Agent version ID, some possible values are listed below:
| Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_OWNER_ID" | paramBinary | Owner ID. For more information, see ul_binId in Users and groups list. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_OWNER_IS_CUSTOM" | paramBool | The attribute accepts true if you changed the owner by using the UpdateHost method with the KLHST_WKS_CUSTOM_OWNER_ID attribute. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_CUSTOM_OWNER_ID" | paramBinary | Custom owner ID, for UpdateHost method only (since KSC 10 SP2), all-zero 16-byte ID means 'clear'. | Write-only. | ||||||||||||||||||||||||||
"KLHST_WKS_PRODUCT_TAG_NAME" | paramString | Tag value assigned to the host by some product ( * ). This attribute can be used to search hosts to which this tag is assigned by some product (see Search filter syntax). Example: (KLHST_WKS_PRODUCT_TAG_NAME="KATA:*") | Read-only. | ||||||||||||||||||||||||||
"KLHST_INCLUDED_WKS_PRODUCT_TAG_NAME" | paramString | Similar to KLHST_WKS_PRODUCT_TAG_NAME but this attribute is used to search by tag that is not assigned to the host by any product. Example of the search-query: (&(KLHST_WKS_PRODUCT_TAG_NAME="KATA:*")(KLHST_INCLUDED_WKS_PRODUCT_TAG_NAME<>"KATA:myserver")) | search-only attribute. | ||||||||||||||||||||||||||
"KLHST_WKS_HSDP_REASON" | paramString | Searching on the product-defined host status reason ID, since KSC 10 SP2 MR1. This attribute depends on the real host status. The attribute has following format: <product>/<version>/<reason_guid_in_hex> Where:
Examples:
| Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_WKS_HSDP_ALLREASONS" | paramString | Searching on the product-defined host status reason ID, since KSC 11. This attribute does not depend on the real host status. The attribute has following format: <product>/<version>/<reason_guid_in_hex> Where:
Examples:
| Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_WKS_HSDP_REASON_ID" | paramBinary | Product-defined host status reason ID provided by any product at the host. This attribute does not depend on the real host status. KLHST_WKS_HSDP_REASON_ID is a binary(16) reason ID provided by a plug-in. Examples:
Supported since KSC 10 SP3. | Read-only attribute. | ||||||||||||||||||||||||||
"KLHST_WKS_ANTI_SPAM_STATUS" | paramInt | Anti-spam status (see Product component status). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_DLP_STATUS" | paramInt | DLP status (see Product component status). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_COLLAB_SRVS_STATUS" | paramInt | Collaboration servers protection status (see Product component status). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_EMAIL_AV_STATUS" | paramInt | Email anti-virus status (see Product component status). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_EDR_STATUS" | paramInt | EDR component status (see Product component status). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_NLA_NETWORK" | paramString | Network location name (see also srvview Network locations specified in the Network Agent connection profiles). | Read-only. | ||||||||||||||||||||||||||
"HST_VM_TYPE" | paramInt | virtual machine type:
| Read-only. | ||||||||||||||||||||||||||
"HST_VM_VDI" | paramBool | Dynamic virtual machine as a part of VDI. | Read-only. | ||||||||||||||||||||||||||
"KLHST_MANAGED_OTHER_SERVER" | paramBool | It is known that the host is managed by another Administration Server. | |||||||||||||||||||||||||||
"KLHST_HSDP_REASONS_ALL" | paramParams | Product-defined host statuses provided by any product at the host. This attribute does not depend on the real host status. KLHST_HSDP_REASONS_ALL is information provided by a plug-in. It contains an array of parameters: +--- (paramParams) +---KLHST_HSDP_REASONS_ALL (paramArray) +---0 (paramParams) | +---KLCONN_HSDP_INFO_1 (paramParams) | | +---KLCONN_HSDP_STATUS = (paramInt)... | | +---KLCONN_HSDP_STATUS_ARR (paramArray) | | +---0 (paramParams) | | | +---KLCONN_HSDP_STATUS_REASON_DESC = (paramString)... | | | +---KLCONN_HSDP_STATUS_REASON_GUID = paramBinary (size = 16): ... | | +---... | +---KLHST_WKS_PRODUCT_NAME = (paramString)... | +---KLHST_WKS_PRODUCT_VERSION = (paramString)... +---... Supported since KSC 10 SP3. | |||||||||||||||||||||||||||
"HST_CLUSTER_ID" | paramString | The cluster ID if the host is a node of the cluster. | Read-only. | ||||||||||||||||||||||||||
"HST_ISCLUSTER" | paramBool | The host is a cluster. | Read-only. | ||||||||||||||||||||||||||
"HST_ISCLUSTER_NODE" | paramBool | The host is a cluster node. | Read-only. | ||||||||||||||||||||||||||
"KLHST_CLSTNODE_WMI_SUPPORTED" | paramBool | WMI support. The attribute accepts true if the cluster type is 'Web and Messaging Integration' (WMI). | Read-only. Valid only if the host is a part of the WMI cluster. | ||||||||||||||||||||||||||
"KLHST_CLUSTER_WMI_SUPPORTED" | paramBool | WMI support. The host is a cluster, and the cluster type is 'Web and Messaging Integration' (WMI)< | Read-only. | ||||||||||||||||||||||||||
"KLHST_CLSTNODE_WMI_FULL_ACTIVE" | paramBool | WMI support. The attribute accepts the following values:
| Read-only. Valid only if the host is a part of the WMI cluster. | ||||||||||||||||||||||||||
"KLHST_CLUSTER_WMI_FULL_ACTIVE_ID" | paramString | WMI support. String host name of current active WMI cluster node | Read-only. Valid only if the host is a WMI cluster. | ||||||||||||||||||||||||||
"KLHST_CLUSTER_WMI_PRODUCT" | paramString | WMI support. Product name. | Read-only. Valid only if the host is a part of the WMI cluster. | ||||||||||||||||||||||||||
"KLHST_CLUSTER_WMI_VERSION" | paramString | WMI support. Product version. | Read-only. Valid only if the host is a part of the WMI cluster. | ||||||||||||||||||||||||||
"HST_ENCRYPTION_STATE" | paramInt | Host encryption state, with one of the following values:
| Read-only. | ||||||||||||||||||||||||||
"RECOVERY_DATA_EXISTS" | paramBool | The attribute accepts true if the encryption recovery data exists. | Read-only. | ||||||||||||||||||||||||||
"KLHST_CLOUD_HOST_BINID" | paramBinary | Public cloud ID of the host. | Read-only. | ||||||||||||||||||||||||||
"KLHST_CLOUD_HOST_PLATFORM" | paramInt | Public cloud host platform type, one of following values Instance platform type in public cloud | Read-only. | ||||||||||||||||||||||||||
"KLHST_CLOUD_HOST_TYPE" | paramInt | Cloud type, one of values from Cloud type | Read-only. | ||||||||||||||||||||||||||
"WUA_LAST_SEARCH_VALID" | paramBool | If last WUA search date (WUA_LAST_SEARCH_DATE) is valid. | Read-only. | ||||||||||||||||||||||||||
"WUA_LAST_SEARCH_DATE" | paramDateTime | Last WUA successful search, in UTC truncated to 00:00. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WUA_SWITCHED" | paramBool | If WUA has been switched to Administration Server. | Read-only. | ||||||||||||||||||||||||||
"KLSRVH_SRV_DN" | paramString | Display name of the secondary server where the found host is located. | May be queried only while using host search functionality. Read-only. | ||||||||||||||||||||||||||
"KLVSRV_DN" | paramString | Virtual server display name where the found host is located. | May be queried only while using host search functionality. Read-only. | ||||||||||||||||||||||||||
"KLVSRV_ID" | paramInt | Virtual server ID where the found host is located; 0 for non-virtual server. | May be queried only while using host search functionality. Read-only. | ||||||||||||||||||||||||||
"name" | paramString | Group name where the host is located. | Read-only. | ||||||||||||||||||||||||||
"KLHST_PRCST_COMPONENT_ID" | paramBinary | Unique binary ID of product component. Some product component identities are already defined. See Product component well-known component IDs | Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_PRCST_INCLUDED_COMPONENT_ID" | paramBinary | Include hosts where the component with the specified ID (see KLHST_PRCST_COMPONENT_ID) is installed while searching by '=', and include hosts where the component with the specified ID is not installed while searching by '<>' | Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_PRCST_COMPONENT_STATUS" | paramInt | Component status. See Product component status | Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_PRCST_COMPONENT_VERSION" | paramLong | 64-bit integer, every 16 bits of which are interpreted as one of the 4-component version like 1.0.0.0 For example 0x000a000201330000 means 10.2.307.0
| Search-only attribute | ||||||||||||||||||||||||||
"KLHST_PRCST_PRODUCT_NAME" | paramString | The name of the product in which the component is implemented. | Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_PRCST_PRODUCT_VERSION" | paramString | The version of the product in which the component is implemented. | Search-only attribute. | ||||||||||||||||||||||||||
"KLHST_WKS_WINDOMAIN_TYPE" | paramInt | Type of Windows domain
| |||||||||||||||||||||||||||
"KLHST_WKS_IP" | paramInt | Host IPv4 address with network byte order. | |||||||||||||||||||||||||||
"KLHST_WKS_SYNC_FORCED" | paramDateTime | Host has been marked for forcing synchronization by ForceSynchronization* call (since 10SP1). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_DPE_ALGORITHM" | paramString | Encryption algorithm, since 10SP3. | |||||||||||||||||||||||||||
"KLHST_LOCATION" | paramString | Host location. | |||||||||||||||||||||||||||
"KLHST_NAG_SCREEN_PROTOCOLS" | paramInt | Set of screen-access protocols supported by the host, set of bits RST_*. See Remote screen type | |||||||||||||||||||||||||||
"KLHST_WKS_LIC_EXPIRATION" | paramDateTime | Nearest license expiration time on the host (since KSC10SP1). | |||||||||||||||||||||||||||
"KLHST_WKS_NLA_LOCATION" | paramString | NLA location name (since 10SP2). | |||||||||||||||||||||||||||
"KLHST_WKS_NLA_NETWORK_ID" | paramInt | NLA-defined network ID (since 10SP2). | |||||||||||||||||||||||||||
"KLHST_UMDM_SUPPORTED" | paramBool | The attribute accepts true if the host is supported by UMDM and can be controlled by it. Call UserDevicesApi.GetHostsUmdmInfo to get UMDM information about this host (since KSC13). | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RBT_UNAVAIL_TIME" | paramDateTime | The time since which the host is inactive and requires a reboot. | Read-only. | ||||||||||||||||||||||||||
"KLHST_WKS_RBT_UNAVAIL_ACCEPT" | paramBool | Is reboot accepted by KSC administrator. | Read-only. |