KSC Open API
Kaspersky Security Center API description
|
List of administration group attributes is presented below.
Attribute | Type | Description | Remarks |
---|---|---|---|
"id" | paramInt | Group ID. | Read-only |
"name" | paramString | Group name. | Group may be renamed by changing the value of this attribute. |
"parentId" | paramInt | ID of parent group. | Group may be moved by changing the value of this attribute. |
"autoRemovePeriod" | paramInt | Maximum number of days of host inactivity before deleting inactive computer. | May be changed. |
"notifyPeriod" | paramInt | Maximum number of days of host inactivity before a notification event will be published. | May be changed. |
"creationDate" | paramDateTime | Time of group creation, in UTC. | Read-only. |
"KLGRP_HlfInherited " (with space at the end) | paramBool | Whether the "autoRemovePeriod" and "notifyPeriod" attributes must be inherited from the parent group. | Changing this attribute turns on and off the inheritance. The attribute can be changed only if KLGRP_HlfForced is False. |
"KLGRP_HlfForceChildren" | paramBool | Whether the "KLGRP_HlfInherited " attribute is locked into the True state for all child groups at all levels. | Changing this attribute changes "KLGRP_HlfInherited " of child groups. |
"KLGRP_HlfForced" | paramBool | Whether the parent group has KLGRP_HlfForceChildren set into True. | Read-only |
"lastUpdate" | paramDateTime | Time of the last modification of group attributes, in UTC. | Read-only. |
"hostsNum" | paramInt | Number of hosts in group and subgroups on all levels, see also KLGRP_CHLDHST_CNT. | Read-only. |
"childGroupsNum" | paramInt | Number of subgroups on all levels. See also KLGRP_CHLDGRP_CNT. | Read-only. |
"grp_full_name" | paramString | Full name of the administration group. You cannot search by this attribute. | Read-only. |
"level" | paramInt | Depth of the group in the groups tree. | |
"KLSRV_HSTSTAT_CRITICAL" | paramParams | Settings for the host status 'Critical' calculation. | (paramParams) that contains Settings for host status calculation. |
"KLSRV_HSTSTAT_WARNING" | paramParams | Settings for the host status 'Warning' calculation. | (paramParams) that contains Settings for host status calculation. |
"KLGRP_GRP_GROUPID_GP" | paramInt | ID of an ancestor group. Use this attribute to search groups that are located inside the specified group. | Search-only attribute. |
"c_grp_autoInstallPackageId" | paramArray | Array. Each entry of type Integer is the ID of the installation package to install automatically on computers located in the group and all child subgroups. | Changing this attribute [re-]creates or destroys the automatically created remote deployment task. |
"grp_from_unassigned" | paramBool | Whether the group is a child (of any level) of the group Unassigned. This attribute has the value 'True' for Groups that are located under the group "Unassigned", and 'False' for Groups that are located under the group "Managed computers". | Read-only. |
"grp_enable_fscan" | paramBool | Enable full scan. | |
"KLSRVH_SRV_DN" | paramString | Display name of the secondary server where the found group is located. | May be queried only while using group search functionality. Read-only. |
"KLVSRV_ID" | paramInt | Virtual server ID where the found group is located. | May be queried only while using group search functionality. Read-only. |
"KLVSRV_DN" | paramString | Virtual server display name where the found group is located. | May be queried only while using group search functionality. Read-only. |
"KLGRP_CHLDGRP_CNT" | paramInt | Number of subgroups located directly in this group (not including those located in subgroups). | Read-only. |
"KLGRP_CHLDHST_CNT" | paramInt | Number of hosts located directly in this group (not including those located in subgroups). | Read-only. |
"KLGRP_CHLDHST_CNT_OK" | paramInt | Number of hosts without host status 'Critical' or 'Warning' located directly in this group (not including those located in subgroups). | Read-only. |
"KLGRP_CHLDHST_CNT_CRT" | paramInt | Number of hosts with the host status 'Critical' located directly in this group (not including those located in subgroups). | Read-only. |
"KLGRP_CHLDHST_CNT_WRN" | paramInt | Number of hosts with the host status 'Warning' located directly in this group (not including those located in subgroups). | Read-only. |