KSC Open API
Kaspersky Security Center API description
List of deployment task attributes
NameTypeDescription
"DisplayName"paramStringDeployment task display name.
"KLTSK_RI_PACKAGES_IDS"paramArray (paramInt)Array of package IDs.
"KLTSK_RI_GROUP_TO_MOVE_HOST"paramIntGroup where destination hosts will be moved after deployment finishes. Attribute absence or value of -1 means "don't move."
"KLTSKDPL_PACKAGE_PRODUCT"paramIntID of application package to deploy.
"KLTSKDPL_PACKAGE_NAGENT"paramIntID of the Network Agent package to deploy.
"KLTSK_RI_CHECK_OS"paramBoolThe attribute accepts true if it is necessary to check operating system before installing the application package.
"KLTSK_RI_USE_NAGENT"paramBoolThe attribute accepts true if it is necessary to try deployment via Network Agent installed on the target host.
"KLTSK_RI_USE_SHARE"paramBoolThe attribute accepts true if it is necessary to use push installation.
"KLTSK_RI_USE_SHARE_SRV"paramBoolUse operating system resources by using Administration Server.
"KLTSK_RI_USE_SHARE_UA"paramBoolUse operating system resources by using distribution points.
"KLTSK_RI_SKIP_PRESENT_PRODS"paramBoolDo not install application if it is already installed.
"UseGPO"paramBoolThe attribute accepts true if it is necessary to use GPO.
"KLTSK_RI_DONT_WAIT_FOR_INSTALLER"paramStringFinish the task immediately, without waiting for the actual completion of the installer.
"KLNAG_TASK_REMOTE_INSTALL_ACCOUNT"paramString(Only for deployment using Network Agent) Account to be used to start the installer.
"KLNAG_TASK_REMOTE_INSTALL_ACCOUNT_PSWD"paramBinary(Only for deployment using Network Agent) Password to be used for KLNAG_TASK_REMOTE_INSTALL_ACCOUNT. Protected globally.
"klprts-TaskAccounts"paramArrayArray of (paramParams) containers. Each container may contain the following attributes:
  • "klprts-TaskAccountAuthType" — Type of an account authentication. See AT_AUTH_TYPE_XXX for valid values.
    • AT_AUTH_TYPE_BASIC = 1 — Credentials to authorize by using login and password. The attributes "klprts-TaskAccountUser" and "klprts-TaskAccountPassword" are required.
    • AT_AUTH_TYPE_CLOUD_BASIC = 2 — Credentials to authorize in cloud. The attributes "klprts-TaskAccountUser" and "klprts-TaskAccountPassword" are required.
    • AT_AUTH_TYPE_CERT = 4 — Credential to authorize by using certificates. The attributes "klprts-TaskAccountCertPublic" and "TaskAccountCertPrivate" are required.
    • AT_AUTH_TYPE_CLOUD_IAM_ROLE = 8 — AWS IAM role assigned to the host with Administration Server installed will be used. No any other attributes are needed.
  • "klprts-TaskAccountUser" — User account (paramString).
  • "KLNAG_TASK_REMOTE_INSTALL_AWS_USERDN" — User's display name (used in AT_AUTH_TYPE_CLOUD_BASIC mode).
  • "klprts-PcloudType" — (paramInt) Type of public cloud, one of the following values:
    • 1 AWS
    • 2 Azure
    • 3 The host is not located in the public cloud
  • "klprts-TaskAccountPassword" — An encrypted user account password, as an UTF16 encrypted string.
  • "klprts-TaskAccountCertPublic" — Encrypted account's public certificate (paramBinary).
  • "TaskAccountCertPrivate" — Encrypted account's private certificate (paramBinary).
"KLTSK_RI_MGD_BY_OTHER_SERVER"paramIntInstall package to hosts that are managed by another server. The attribute accepts the following values:
  • 0 = Always install
  • 1 = Never install
"KLTSK_RI_TMP_FOLDER"paramStringPath to tmp folder with execute permissions on the target host (only for deployment using SSH).
"KLTSK_RI_ROOT"paramBinaryPassword for root account (only for deployment using SSH). Use ProtectDataGlobally of UTF-8.
"KLTSK_RI_AZURE_PUBLIC_EXT"paramIntUse "Azure public extention" instead of Package.
  • 0 = KESL (install Kaspersky Endpoint Security for Linux)
  • 1 = KSWS (install Kaspersky Security for Windows Server)
  • 2 = KESW (install Kaspersky Endpoint Security for Windows)
"AskUserData"paramParamsContainer contains following data to prompt the user to close running applications:
  • "AskUser" (paramBool) — true if needs to ask the user to close running applications
  • "AskUserSec" (paramInt) — period in seconds to re-show the prompt to the user (300 seconds by default)
  • "ForceInstallSec" (paramInt) — period in seconds to force installation after it expires (0 seconds by default, 0 means disabled)

See also Task settings format List of task operating system reboot options