KSC Open API  13.1
Kaspersky Security Center API description
Report delivery task "KLSRV_TSK_EMAIL_REPORT"

Below is the partial structure of parameters container of report delivery task. 

    +--- (params)
        ...
        +---KLRPT_LOC_PRODUCTS (array)
        |   +---0 (params)
        |       +---KLRPT_PROD_NAME (paramString) = "1093"
        |       +---KLRPT_PROD_NAME_LOC (paramString) = "Administration Server"
        |       +---KLRPT_PROD_VER (paramString) = "1.0.0.0"
        |       +---KLRPT_PROD_VER_LOC (paramString) = "1.0.0.0"
        +---KLSRV_TP_EMAIL_REPORT_SEND_MAIL (paramBool) = true
        +---KLSRV_TP_EMAIL_REPORT_EMAIL (paramString) = "Sergey.Kostrov@kaspersky.com"
        +---KLSRV_TP_EMAIL_REPORT_SUBJECT (paramString) = "KSC Report delivery"
        +---KLSRV_TP_EMAIL_REPORT_ATTACHMENT_TYPE (paramInt) = 2
        +---KLSRV_TP_EMAIL_REPORT_FORMAT (paramInt) = 1
        +---KLSRV_TP_EMAIL_REPORT_ID (paramInt) = 19
        +---KLSRV_TP_EMAIL_REPORT_IDS (array)
        |   +---0 (paramInt) = 19
        +---KLSRV_TP_EMAIL_REPORT_SAVE (paramBool) = true
        +---KLSRV_TP_EMAIL_REPORT_FOLDER (paramString) = "C:\Users\kostrov\Downloads\"
        +---KLSRV_TP_EMAIL_REPORT_OVERWRITE (paramBool) = true
        +---KLSRV_TP_EMAIL_REPORT_USE_ACCOUNT (paramBool) = false
        +---KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS (paramBool) = true
        ...

Below is the list of attributes specific to report delivery task.

AttributeTypeDescriptionAdditional information
"KLRPT_LOC_PRODUCTS"(array)Array of product internal and localized names and versions
  • Optional
"KLRPT_PROD_NAME"(paramString)Name of product
  • Mandatory
"KLRPT_PROD_NAME_LOC"(paramString)Localized name of product
  • Mandatory
"KLRPT_PROD_VER"(paramString)Version of product
  • Mandatory
"KLRPT_PROD_VER_LOC"(paramString)Localized version of product
  • Mandatory

"KLSRV_TP_EMAIL_REPORT_SEND_MAIL"(paramBool)The parameter accepts true if a report should be sent by email, false - otherwise
  • Optional
  • Default value: true
"KLSRV_TP_EMAIL_REPORT_ATTACHMENT_TYPE"(paramInt)Email attachment type
  • Optional
  • Default value: 2
  • Ignored if "KLSRV_TP_EMAIL_REPORT_SEND_MAIL" is set to false
"KLSRV_TP_EMAIL_REPORT_EMAIL"(paramString)Email address which a report files should be sent to
  • Mandatory if "KLSRV_TP_EMAIL_REPORT_SEND_MAIL" is set to true
"KLSRV_TP_EMAIL_REPORT_SUBJECT"(paramString)Subject of the report email
  • Mandatory if "KLSRV_TP_EMAIL_REPORT_SEND_MAIL" is set to true
"KLSRV_TP_EMAIL_REPORT_FORMAT"(paramInt)Report target format, see Types of the report XML target format
  • Optional
  • Default value: 0
"KLRPT_PDF_LANDSCAPE"(paramBool)The parameter accepts true if PDF report document should be landscape oriented, false - otherwise
  • Optional
  • Default value: false
  • Ignored if "KLSRV_TP_EMAIL_REPORT_FORMAT" is not set to 2
"KLRPT_PDF_PAGE_SIZE"(paramInt)Page size for PDF report document, see Sizes of a PDF report document
  • Optional
  • Default value: 8
  • Ignored if "KLSRV_TP_EMAIL_REPORT_FORMAT" is not set to 2

"KLSRV_TP_EMAIL_REPORT_ID"(paramInt)Report ID
  • Mandatory if "KLSRV_TP_EMAIL_REPORT_IDS" is not set or empty
  • Deprecated
  • Used for compatibility with old servers only
"KLSRV_TP_EMAIL_REPORT_IDS"(array)Array of report IDs
  • Mandatory if "KLSRV_TP_EMAIL_REPORT_ID" is not set

"KLSRV_TP_EMAIL_REPORT_SAVE"(paramBool)The parameter accepts true if a report should be saved to a specified folder of the file system, false - otherwise
  • Optional
  • Default value: false
"KLSRV_TP_EMAIL_REPORT_FOLDER"(paramString)Folder of the file system which the report file must be saved to
  • Optional
  • Ignored if "KLSRV_TP_EMAIL_REPORT_SAVE" is set to false
"KLSRV_TP_EMAIL_REPORT_OVERWRITE"(paramBool)The parameter accepts true if previously generated files of the same report type must be replaced with the new ones, false - otherwise
  • Optional
  • Default value: true
  • Ignored if "KLSRV_TP_EMAIL_REPORT_SAVE" is set to false

"KLSRV_TP_EMAIL_REPORT_USE_ACCOUNT"(paramBool)Use credentials to access the folder which a report was saved to
  • Optional
  • Default value: false

"KLSRV_TP_EMAIL_REPORT_ACCOUNT"(paramString)User name
  • Optional
  • Default value: ""
  • Ignored if "KLSRV_TP_EMAIL_REPORT_USE_ACCOUNT" is set to false

"KLSRV_TP_EMAIL_REPORT_PWD"(paramBinary)Password
  • Optional
  • Default value: ""
  • Ignored if "KLSRV_TP_EMAIL_REPORT_USE_ACCOUNT" is set to false

"KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS"(paramBool)The parameter accepts true if default notification setting should be used, false - otherwise
  • Optional
  • Default value: true
  • Ignored if "KLSRV_TP_EMAIL_REPORT_SEND_MAIL" is set to false

"KLSRV_TP_EMAIL_REPORT_SMTPSERVER"(paramString)SMTP server address
  • Optional
  • Default value: ""
  • Ignored if "KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS" is set to true

"KLSRV_TP_EMAIL_REPORT_SMTPPORT"(paramInt)SMTP port
  • Optional
  • Default value: 25
  • Ignored if "KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS" is set to true

"KLSRV_TP_EMAIL_REPORT_ESMTPUSER"(paramString)SMTP user name
  • Optional
  • Default value: ""
  • Ignored if "KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS" is set to true

"KLSRV_TP_EMAIL_REPORT_ESMTPPASSWORD"(paramString)SMTP password
  • Mandatory if "KLSRV_TP_EMAIL_REPORT_ESMTPUSER" is present
  • Ignored if "KLSRV_TP_EMAIL_REPORT_ESMTPUSER" is not set or empty

Description of general attributes applicable to any server task could be found by the references below:

See also: