Security Center Database API Reference Guide...DocID CS-ICSW800en-510B 3 About this Guide This document is an API guide for the ICS Shield Security Center database. Scope This guide

ICS SHIELD

R 510.2

Security Center

Database API Reference Guide

CS-ICSW800en-510B

June 2020

Notices

Trademarks Microsoft and SQL Server are either registered trademarks or trademarks of Microsoft

Corporation in the United States and/or other countries.

Trademarks that appear in this document are used only to the benefit of the trademark

owner, with no intention of trademark infringement.

Third-party licenses This product may contain or be derived from materials, including software, of third

parties. The third party materials may be subject to licenses, notices, restrictions and

obligations imposed by the licensor

DocID CS-ICSW800en-510B 3

About this Guide

This document is an API guide for the ICS Shield Security Center database.

Scope This guide includes all the APIs that allow access to the ICS Shield Security Center

database.

Intended audience This guide is intended for system engineers who are responsible for generating

custom queries into the Oracle database, which is used for reporting on historical data,

providing inventory information, and integrating with third-party solutions

Prerequisite skills This guide assumes basic knowledge of the following:

• Oracle database

• ICS Shield Security Center This guide assumes basic knowledge of the ICS Shield

modules relevant to the Security Center, the VSE, or both, depending on your

specific role.

Related documents The following list identifies publications that contain information relevant to the

information in this document.

Document Name Document Number

ICS Shield R510.1 - Security Center Getting Started

Guide CS-ICSW400en-510B

Revision history

Revision Supported Release

Date Description

B Release 510.2 June 2020 Revised version of 510.2

B Release 510.2 September

2019

This software is an upgrade-only release

from Release 510.1


Revision Supported Release

Date Description

A Release 500.1 June 2019 First release of product


Contents 1. SECURITY CONSIDERATIONS ........................................................................................ 7

2. TERMS AND DEFINITIONS .............................................................................................. 8

3. OVERVIEW ............................................................................................................................. 10

4. BACKWARD COMPATIBILITY .......................................................................................... 11

4.1 Examples ..................................................................................................................................................... 11 4.1.1 Backward compatible code ............................................................................................. 11 4.1.2 Non-backward compatible code .................................................................................. 11

4.2 Deprecated API Procedures .............................................................................................................. 11

5. DATABASE API PROCEDURES ....................................................................................... 12

5.1 Get information about sites ............................................................................................................... 12

5.2 Get information about devices ......................................................................................................... 17

5.3 Get information about user’s activities ........................................................................................ 20

5.4 Get list of installed software .............................................................................................................. 25

5.5 Get list of installed patches ............................................................................................................... 27

5.6 Get sites’ custom fields ........................................................................................................................ 29

5.7 Get alarms by product line ................................................................................................................. 31

5.8 Get list of summarized alarms ......................................................................................................... 35

5.9 Get data by specific Diagnostic routine ...................................................................................... 40

5.10 Get collected data by property ......................................................................................................... 44

5.11 Get list of detailed alarms by Security Center detection date-time .............................. 49

5.12 Get list of detailed alarms by Security Center insertion date-time ................................ 58

5.13 Get collected data by Security Center insert time .................................................................. 68

5.14 Get collected data by site report creation time ........................................................................ 71

5.15 Get device monitoring statistics...................................................................................................... 75

5.16 Get product line properties ................................................................................................................ 81

5.17 Get product line’s data units and analysis rules ..................................................................... 84

5.18 Get product line’s execution profiles ............................................................................................ 93

5.19 Get device alarm statistics ................................................................................................................. 99

5.20 Get Security Center Audit Log .......................................................................................................... 103

5.21 Get Security Center Operational Log ............................................................................................ 105

5.22 Get device properties ............................................................................................................................ 107

5.23 Get device indexes .................................................................................................................................. 110

5.24 Get latest software distribution activities (new) ...................................................................... 111

5.25 Acknowledge alarms ............................................................................................................................. 114


5.26 Get Users’ Information ......................................................................................................................... 115

6. USING WILDCARDS ............................................................................................................ 118

7. DATABASE API NAMES FOR BUILT-IN REPORTS ................................................... 119

8. DATABASE API DEPENDENCIES ................................................................................... 121

SECURITY CONSIDERATIONS


1. Security Considerations

For applicable security considerations, see the Security Center Getting Started Guide.

TERMS AND DEFINITIONS


2. Terms and Definitions

NOTE

The Terms and definitions table is sorted by alphabetical order

Term Definition

DB Database server component

device A representation of a physical or virtual server or machine in

the VSE

diagnose routine (DR)

A collection profile that runs on demand and is intended to

collect in-depth diagnostic data.

Essential security policy (ESP)

A set of actions and scripts that together instruct the VSE to

perform certain procedures on devices that are defined in the

VSE.

execution profile A collection of scripts related to one logical area, such as

machine security status, hardware information, event logs, or

storage information; these scripts can either be run on

demand (Diagnose Routine or Corrective Action) or based on

a predefined schedule.

exposure level The extent to which the specific asset is critical to ongoing

site operation; the predefined value options for the exposure

levels are one of the following:

• High

• Medium

• Low

monitoring profile (MP)

A collection profile configured to run at set time intervals,

such as Every day at 18:00.

product line A set of actions and scripts that together instruct the VSE to

perform certain procedures on devices that are defined in the

VSE.

TERMS AND DEFINITIONS


Term Definition

Security Center (SC)

ICS Shield component that is installed at the corporate data

center. The security center is composed of various software

components, which enable to remotely collect, analyze, view,

manage, and store data retrieved from the VSEs. This data

refers to the monitored assets and network devices found at

the VSE’s sites.

severity level A classification of information into one of the following

levels:

1. Critical

2. Warning

3. Error

4. Info

site A remote physical location, such as an industrial plant, which

includes one or more network environments and has at least

one VSE.

VSE The ICS Shield component that is installed at the remote site,

monitors the assets at the site, and provides additional

functionalities such as remote access.

OVERVIEW


3. Overview

The database APIs can be used for various purposes, such as the following:

• Reporting on historical data

• Providing inventory information

• Integrating with third-party solutions

The main advantages for using the APIs to access data in the database are the

following:

• Performance optimization – the APIs were written and optimized based on the ICS

Shield Security Center database schema and Oracle guidelines.

• Data access security – all APIs use the user ID and retrieve information based on

the user’s permission levels. Results are based on:

The user’s role – Administrator, Label Manager, or Operator

Sites and product lines visible to the user (minimum View permission is

required.)

BACKWARD COMPATIBILITY


4. Backward Compatibility

Backward compatibility with existing client programs is guaranteed.

NOTE

The order of the columns can be changed without breaking backward compatibility. Client programs must therefore refer to specific columns by name instead of by an ordinal number.

4.1 Examples The sections below provide examples of backward compatible and non-backward

compatible code.

4.1.1 Backward compatible code The example below shows a backward compatible code written in Java.

ResultSet rs = (ResultSet)stmt.getObject(1; Sting str = rs.getString(USR_FIRST_NAME); int i = rs.getInt(USR_ID); Date dt = rs.getDate(CREATION_DATE);'pa_Job.pr_NightlyMaintenance_Job%';

4.1.2 Non-backward compatible code The example below shows a non-backward compatible code written in Java.

ResultSet rs = (ResultSet)stmt.getObject(1); Sting str = rs.getString(1); int i = rs.getInt(2); Date dt = rs.getDate(3);;

4.2 Deprecated API Procedures All the deprecated API procedures have been removed in this release.

DATABASE API PROCEDURES


5. Database API Procedures

This chapter provides information about the APIs available to the Security Center

users, to allow custom-tailored access to the database.

5.1 Get information about sites This API retrieves data about sites (VSEs) defined in the Security Center.

Database API procedure name GetSitesInfo

Description This API retrieves data about VSEs defined in the Security Center, sorted by VSE name,

Labels, first-level, second-level, and third-level Group.

Built-in reports using this API

• Sites Summary

• Alarms Global Weekly Summary Report

• Device Inventory

Parameters

Parameter Name and Format

Parameter Type Mandatory Description

p_UserId

NUMBER(9,0)

Number Yes User ID that runs the API as

appears in

SEC_VS_USER_T.USR_ID.

This ID governs viewing and

querying permissions.

p_SiteId

NUMBER(9,0)

Number When defined, limits results

to a given site. When NULL,

provides results to all sites.

p_cv_SiteDetails

REF CURSOR

Output Yes Result set



Result set

Column Name and Format Column Type

Description/Comment

SITE_SERVER_ID

NUMBER(9,0)

Number Unique Server Identified of line

below (visible in the Security

Center UI as a tooltip while

hovering over a VSE. Visible in the

VSE UI under Registration Information tab)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name in the UI)

FIRST_LEVEL_GRP_NAME

VARCHAR2(255 BYTE)

String First level group name of Site

Management Tree

SECOND_LEVEL_GRP_NAME

VARCHAR2(255 BYTE)

String Second level group name of Site

Management Tree

THIRD_LEVEL_GRP_NAME

VARCHAR2(255 BYTE)

String Third level group name of Site

Management Tree

SITE_SERVER_TIME_ZONE

NUMBER(3,0)

Number Positive or negative offset from

UTC (Difference between Site Server local time and UTC in the

UI)

SITE_SERVER_LOCATION

VARCHAR2(255 BYTE)

String Location of Site Server (Site Location in the Security Center

UI, Location in the VSE UI)

SITE_SERVER_MAC_ADDRESS

VARCHAR2(255 BYTE)

String Site Server MAC address (MAC Address in the UI)

SITE_SERVER_VERSION

VARCHAR2(255 BYTE)

String Site Server version (Site Version in the Security Center UI and

Software Version in the VSE UI)

SITE_SERVER_VERSION_NAME

VARCHAR2(255 BYTE)

String Site Server name of line above




Description/Comment

SITE_SERVER_COM_METHOD

VARCHAR2(50 BYTE)

String One value from

REF_COMMUNICATION_TYPE_T:

1 – Manual

2 – Direct

3 – AutoHttp (Polling in the UI)

4 – AutoMail (not in use)

5 – AutoTcp (Continuous in the

UI)

SITE_MODE_CODE

NUMBER(3,0)

Number 1 – Online

2 – Offline

CONTACT_FIRST_NAME

VARCHAR2(255 BYTE)

String Site administrator first name

(Contact Name in the Security

Center UI, First Name in the VSE

UI)

CONTACT_LAST_NAME

VARCHAR2(255 BYTE)

String Site administrator last name


Center UI, Last Name in the VSE

UI)

CONTACT_COMPANY

VARCHAR2(255 BYTE)

String Site installed at company

(Contact Company in the

Security Center UI, Company in

the VSE UI)

CONTACT_PHONE

VARCHAR2(255 BYTE)

String Site administrator telephone

number (Contact Phone in the

Security Center UI, Phone Number in the VSE UI)

CONTACT_EMAIL

VARCHAR2(2000 BYTE)

String Site administrator email address

(Contact E-mail in the Security

Center UI, E-mail in the VSE UI)

SRV_RANK

NUMBER(3,0)

Number Site ranking in Security Center

(Ranking in the UI)




Description/Comment

VPN_SERVER_INTERNAL_IP

VARCHAR2(50)

String Site’s Hyper Tunnel IPv4 address

IPv4

VARCHAR2(50 BYTE)

String Site’s primary IPv4 address

OS

VARCHAR2(50 BYTE)

String Site’s operating system name

COMMUNICATION_STATUS

VARCHAR2(50 BYTE)


REF_HB_STATE_T:

1 – Up

2 – Down

3 – NA1

4 – IF2

5 – IF and NA

NO_OF_DEVICES

NUMBER(6,0)

Number Number of defined Devices in the

Site Server

DISTINCT_IP

NUMBER(6,0)

Number Number of unique Devices’ IPs in

the Site Server

LAST_REPORT_RECEIVED_DATE

DATE

Date Most recent date collected data

of a Device arrived at Security

Center, adjusted to p_UserId time

zone

NO_OF_ALLOWED_DEVICES

NUMBER(6,0)

Number Maximum licensed Devices for a

Site Server

1 NA – No Access 2 IF – Interface Failure




Description/Comment

IS_PROACTIVE

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes

-1 – Not included in license

IS_MONITORING

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes


IS_LIGHT

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes


IS_REBRANDED

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes


SUPPORTED_LANGUAGE_NUM

NUMBER(4,0)

Number Number of simultaneous

languages VSE is licensed for

IS_REVERSE_TUNNEL

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes


IS_FILE_TRANSFER

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes





Description/Comment

VPN_MODE

NUMBER(1,0)

Number Decode:

0 – No

1 – Yes


COMM_STATUS_LAST_CHANGED_

ON

Date Most recent date-time, in Site’s

time zone, communication status

has changed up/down or

down/up

5.2 Get information about devices This API retrieves data about devices for a specific site or all sites.

Database API procedure name GetDeviceInfo

Description This API retrieves data on devices for a specific site or all sites, sorted by VSE name,

first-level, second-level, and third-level Group, and Device names.

Built-in reports using this API None

Parameters


Parameter Type

Mandatory Description

p_UserId

NUMBER(9,0)

Number Yes User ID that runs the API

as appears in


This ID governs viewing

and querying permissions

p_SiteId

NUMBER(9,0)

Number When defined, limits

results to a given site.

When NULL, provides

results to all sites.




Parameter Type

Mandatory Description

p_cv_DeviceDetails

REF CURSOR


Result set

Column Name and Format Column Type Description/Comment

FIRST_LEVEL_GRP_ID

NUMBER(9,0)

Number Unique Group Identifier of line

below (not visible in the UI)


VARCHAR2(255 BYTE)


Management Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)

String Second level group name of

Site Management Tree

THIRD_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SITE_SERVER_ID

NUMBER(9,0)

Number Unique Server Identified of

line below (visible in the

Security Center UI as a tooltip

when hovering over a VSE.

Visible in the VSE UI in

Registration Information tab)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name in the Security Center

UI)

DEVICE_ID

NUMBER(9,0)

Number Unique Device Identified of

line below (not visible in the

UI)




DEVICE_NAME

VARCHAR2(255 BYTE)

String Device name (Device Name in

the UI)

DEVICE_SERIAL_NO

VARCHAR2(255 BYTE)

String Device Unique Serial Number

(Device Unique ID in the UI)

DEVICE_IP

VARCHAR2(255 BYTE)

Number Device IP Address (Device Address in the UI)

DEVICE_MODEL

VARCHAR2(255 BYTE)

String Model name a Device inherits

from (Model in the UI)

DEVICE_VERSION

VARCHAR2(255 BYTE)

String Version name a Device

inherits from (Version in the

UI)

PRODUCT_LINE_NAME

VARCHAR2(255 BYTE)

String Product Line name a Device

inherits from (to the right of

Product Line in the UI)

PRODUCT_LINE_VENDOR_NAME

VARCHAR2(255 BYTE)

String Product Line vendor a Device

inherits from (to the left of” in

the UI)

CREATION_DATE

DATE

Date Date a Device was created, in

Security Center time zone

LAST_RPRT_ARRIVAL_DATE

DATE

Date Most recent date collected

data of a Device arrived at

Security Center, in Security

Center time zone



5.3 Get information about user’s activities This API retrieves a list of activities per users, including all sub-activities.

Database API procedure name GetUsersActivitiesInfo

Description This API retrieves a list of activities per users. The result is filtered based on report

generator permissions.

• Administrators see the activities of all Security Center users.

• Label Managers see the activities of all the Security Center users that they

manage.

• Operators only see their own activities.

The activities list contains all sub-activities; for example, an activity that was applied to

multiple devices. The result set is sorted by User ID, Task ID, and Sub-task ID.


Parameters

Parameter and Format Parameter Type

Mandatory?

Description

p_UserId

NUMBER(9,0)


appears in



querying permissions

p_SiteId

NUMBER(9,0)




p_FromDate

VARCHAR2(18 CHAR)

String Yes ‘YYYYMMDD HH24:MI:SS’ per


p_ToDate

VARCHAR2(18 CHAR)






Mandatory?

Description

p_SubmitBy

NUMBER(9,0)

Number User ID that requested the

Activity as appears in


p_cv_GetUsersActivitiesInf

o

REF CURSOR


Result set


Description/Comment

TSK_ID

NUMBER(9,0)

Number Unique Task Identifier (not visible in

the UI)

SUBTSK_ID

NUMBER(9,0)

Number Unique Sub-task Identifier (not

visible in the UI)

TSK_TYPE_CODE

NUMBER(3,0)

Number Corresponding key from list below

TSK_TYPE_NAME

VARCHAR2(50 BYTE)

String One value from REF_TASK_TYPE_T:¶

1 – Distribute Product Line¶

2 – Send File

3 – Diagnose Routine¶

4 – Perform Remote Activity¶

6 – Distribute Product Line

(broadcast)

7 – Distribute User File (broadcast)

8 – Instant Command

9 – Get File

10 – Remote Access

11 – Distribute Software

12 – Fix

13 – Import Data




Description/Comment

14 – Launch Program

TSK_BRIEF

VARCHAR2(2000 BYTE)

String Brief text describing the task

TSK_DESTINATION

VARCHAR2(2000 BYTE)

String Task destinations as concatenated

list of Sites and Devices

USR_FILE_NAME

VARCHAR2(255 BYTE)

String File name sent to VSE via Send File,

or Software Distribution

TSK_DESCRIPTION

VARCHAR2(2000 BYTE)

String Task description, as entered by User

(Description in the UI)

PRDLIN_ID

NUMBER(9,0)

Number Unique Product Line Identifier of

concatenated two lines above (not

visible in the UI)

CREATED_BY_FIRST_NAME

VARCHAR2(50 BYTE)

String Task submitter’s first name

CREATED_BY_LAST_NAME

VARCHAR2(50 BYTE)

String Task submitter’s last name

CREATION_DATE

VARCHAR2(18 CHAR)

String ‘YYYYMMDD HH24:MI:SS’ per


DEST_SRV_ID

NUMBER(9,0)



DEST_SRV_TYPE

NUMBER(3,0)

Number One key from

REF_TASK_DEST_TYPE_F:

1 – List of Site Servers

2 – List of Devices

DEST_SRV_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name in

the UI)




Description/Comment

DEST_DEVICE_ID

NUMBER(9,0)

Number Unique Device Identified of line


DEST_DEVICE_SN

VARCHAR2(255 BYTE)



DEST_DEVICE_NAME

VARCHAR2(255 BYTE)

String Device name (Device Name in the

UI)

DEST_DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address (Device Address

in the UI)

PRDLIN_FULL_NAME

VARCHAR2(511 BYTE)

String Concatenation of Product Line

vendor name, single space, and

Product Line name

DEST_DEVICE_SWVER_NAME

VARCHAR2(255 BYTE)

String Device Version name

DEST_DEVICE_HWMDL_NAME

VARCHAR2(255 BYTE)

String Device Model name

SUBTSK_STATE_CODE

NUMBER(3,0)


SUBTSK_STATE

VARCHAR2(50 BYTE)


REF_TASK_STATE_TYPE_T:

1 – Not sent yet

2 – Sent

3 – Received

4 – Waiting for approval

5 – Scheduled

6 – Executing

7 – Finished

SUBTSK_STATE_CHANGE_DATE

VARCHAR2(18 CHAR)






Description/Comment

SUBSUBTSK_RES_MSG

VARCHAR2(2000 BYTE)

String Task result message on

unsuccessful finish

SUBTSK_SEVERITY

NUMBER(3,0)


SUBTSK_SEVERITY_NAME

VARCHAR2(50 BYTE)


REF_DATA_SEVERITY_TYPE_T:

0 – OK

1 – Informational

2 – Warning

3 – Error

4 – Critical



5.4 Get list of installed software This API retrieves a list of all installed software for one or all Windows devices in a

selected site.

Database API procedure name GetDeviceInstalledSoftware

Description This API retrieves a list of all installed software for one or all Windows devices in a

selected site. The list is sorted by Device Name and then by Software.

Built-in reports using this API Installed Software Report (under Inventory Reports)

Parameters


Mandatory? Description

p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number Yes Limits results to a given site.

p_DeviceName

VARCHAR2(255 BYTE)

String When defined can also use

wild cards. When NULL

applies to all Devices

p_cv_result Output Yes Result set

p_FromDate String Yes YYYYMMDD HH24:MI:SS

p_ToDate String Yes YYYYMMDD HH24:MI:SS



Result set


Description/Comment

rownum Number Line number

DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address (Device IP in the

UI)

DEVICE_NAME

VARCHAR2(255 BYTE)

String (Device Name in the UI)

Vendor

VARCHAR2(255 BYTE)

String Software vendor (Vendor in the UI)

Software

VARCHAR2(255 BYTE)

String Software name (Software in the UI)

Version

VARCHAR2(255 BYTE)

String Software version (Version in the UI)

Type

VARCHAR2(255 BYTE)

String Software type (Type in the UI).

Possible values are:

• Authorized Software

• Unauthorized Software

• N/A



5.5 Get list of installed patches This API retrieves a list of all installed patches for one or all Windows devices in a

selected site.

Database API procedure name GetDeviceInstalledPatches

Description This API retrieves a list of all installed software for one or all Windows devices in a

selected site. The list is sorted by Device Name and then by Windows Update ID.

Built-in reports using this API Installed Windows Patches Report (under Inventory Reports)

Parameters



p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)


p_DeviceName

VARCHAR2(255 BYTE)




p_cv_result Output Yes Result set

p_FromDate String Yes YYYYMMDD HH24:MI:SS

p_ToDate String Yes YYYYMMDD HH24:MI:SS



Result set


Description/Comment

rownum Number Line number

DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address (Device IP in the

UI)

DEVICE_NAME

VARCHAR2(255 BYTE)

String (Device Name in the UI)

WinUpdateId

VARCHAR2(255 BYTE)

String Unique ID of the Windows update

(Windows Update ID in the UI)

InstalledOn

VARCHAR2(255 BYTE)

String Date of the Windows update

(Installed On in the UI)



5.6 Get sites’ custom fields This API retrieves a list of custom fields per site.

Database API procedure name GetSiteCustomFields

Description This API retrieves a list of custom fields per site. The result is filtered based on the

report generator’s permissions. The list is sorted by Site ID and then by Custom Field

ID.


Parameters



p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)


p_cv_SiteCustomFields

REF CURSOR




Result set


Description/Comment

SITE_SERVER_ID

NUMBER(9,0)

Number Unique Server Identified of line below

(visible in the Security Center UI as a

tooltip when hovering over a VSE.

Visible in the VSE UI in Registration Information tab)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)


the UI)


VARCHAR2(255 BYTE)


Management Tree


VARCHAR2(255 BYTE)


Management Tree


VARCHAR2(255 BYTE)


Management Tree

SRV_CF_ID

NUMBER(9,0)

Number Unique Custom Field Identifier for a

Site (not visible in the UI)

CF_NAME

VARCHAR2(255 BYTE)

String Custom Field name (Name in the UI)

SRV_CF_VALUE

VARCHAR2(2000 BYTE)

String Custom Field value for a Site (Value in

the UI)

ORDER_NO

NUMBER(9,0)

Number Unique Custom Field Identifier (not

visible in the UI)

DEFAULT_CF_VALUE

VARCAHR2(2000 BYTE)

String Custom Field default value (Value in

the UI)



5.7 Get alarms by product line This API retrieves a list of analysis rules for a specific product line or all product lines.

Database API procedure name GetPLAlarms

Description This API retrieves a list of analysis rules for a specific product line or all product lines.

Results are sorted by Product Line ID, Analysis Rule name.

Built-in reports using this API Product Lines Analysis Rules

Parameters


Mandatory?

Description

p_UserId

NUMBER(9,0)


appears in

SEC_VS_USER_T.USR_ID. This

ID governs viewing and


p_ProductLineIdByPlPrms

NUMBER(9,0)

Number Unique Product Line ID as

appears in

APP_PRODUCT_LINE_INFO_T.

PRDLIN_ID

p_cv_GetARList

REF CURSOR


Result set


Description/Comment

PRDLIN_NAME

VARCHAR2(255 BYTE)

String Product Line name (Product Line Name in the UI)

PRDLIN_VENDOR_NAME String Product Line vendor (Product




Description/Comment

VARCHAR2(255 BYTE) Vendor in the UI)

PRDLIN_ID

NUMBER(9,0)

Number Unique Product Line Identifier

of concatenated two lines above

(not visible in the UI)

PRPTY_ID

NUMBER(9,0)

Number Unique Property Identifier of line


PRPTY_NAME

VARCHAR2(255 BYTE)

String Property name (Property Name

in the UI)

OBJ_ID

NUMBER(9,0)

Number Unique Object Identifier of line


OBJ_NAME

VARCHAR2(255 BYTE)

String Object name that encloses

above property

CORRECTIVE_ACTION_ID

NUMBER(9,0)

Number Unique Corrective Action

Identifier of line below (not

visible in the UI)

CORRECTIVE_ACTION_NAME

VARCHAR2(255 BYTE)

String Correction Action name for

Analysis Rule (Name in the

Security Center UI, Profile Name in the VSE UI)

ARULE_ID

NUMBER(9,0)

Number Unique Analysis Rule Identifier

of Analysis Rule four lines below


ARULE_SEVRTYP_CODE

NUMBER(3,0)

Number Corresponding key from list

below

SEVRTYP_NAME

VARCHAR2(50 BYTE)


REF_ARULE_SEVERITY_TYPE_T:

1 – Informational

2 – Warning

3 – Error




Description/Comment

4 – Critical

ARULE_DESC

VARCHAR2(2000 BYTE)

String Analysis Rule description


ARULE_NAME

VARCHAR2(255 BYTE)

String Analysis Rule name (Analysis Rule Name in the UI)

IS_PAIR_ALARM

NUMBER(1,0)

Number Decode

0 – Single

1 – Pair

ALRM_SET_IS_SEND_SNMPTRAP

NUMBER(1,0)

Number Decode

0 – Do not send

1 – Do send

ALRM_CLEAR_IS_SEND_SNMPTRAP

NUMBER(1,0)

Number Decode:

0 – Do not send

1 – Do send

ALRM_SET_COLPRF_ID

NUMBER(9,0)

Number Collection Profile to invoke

when Alarm is Set

ALRM_CLEAR_COLPRF_ID

NUMBER(9,0)

Number Collection Profile to invoke

when Alarm is Clear

ARULE_GRID_CELL

VARCHAR2(255 BYTE)

String Grid coordinates to high light

when Alarm is Set

ALRM_SET_IS_NOTIFY_BY_MAIL

NUMBER(1,0)

Number Decode:

0 – Do not notify

1 – Do notify

ALRM_CLEAR_IS_NOTIFY_BY_MAIL

NUMBER(1,0)

Number Decode

0 – Do not notify

1 – Do notify




Description/Comment

ARULE_OPERAND_CODE

NUMBER(3,0)


below

OPRTYP_NAME

VARCHAR2(50 BYTE)


REF_OPERAND_TYPE_T:

1 – Value

2 – Rate/[minute]

3 – Rate/[hour]

4 – Rate/[day]

5 – Delta (absolute)

6 – Delta (in percent)

ARULE_COND_CODE Number Corresponding key from list

below

CONDTYP_NAME

VARCHAR2(50 BYTE)


REF_CONDITION_TYPE_T:

1 – Contains

2 – Is equal to

3 – Is not equal to

4 – Is between

5 – Is not between

6 – Is less than

7 – Is less than or equal to

8 – Is greater than

9 – Is greater than or equal to

10 – Does not contain

11 – Matches Regular

Expression

12 – Does not match Regular

Expression

ARULE_FIRST_VALUE

VARCHAR2(255 BYTE)

String Value to compare with and

From portion of From-To range




Description/Comment

IS_ARULE_FIRST_VALUE_LAST

NUMBER(1,0)

Number Decode:

0 – Regular value

1 – Last value

ARULE_SECOND_VALUE String To portion of From-To range

IS_ARULE_SECOND_VALUE_LAST

NUMBER(1,0)

Number Always 0 (zero)

IS_SEND_REPORT

NUMBER(1,0)

Number Decode

0 – Do not send automatically

1 – Do send automatically

5.8 Get list of summarized alarms This API retrieves Knowledge Alarms (also known as Entity Alarms) data.

Database API procedure name GetAlarmList

Description This API retrieves Knowledge Alarms (also known as Entity Alarms) data (not

including System Alarms), for all alarms that occurred in the specified time frame.

Every row in the result set represents the number of alarms for a specific site, analysis

rule, severity and acknowledgement status, which occurred on a specific day. Result

set is not sorted.

Built-in reports using this API

• Site Alarms Weekly Statistics

• Site Alarms Monthly Statistics

• World Alarms Weekly Statistics

• World Alarms Monthly Statistics

• World Health Weekly Summary

• World Health Monthly Summary

Parameters





p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)




p_AlarmName

VARCHAR2(255 BYTE)



applies to all Alarms

p_FromDate

VARCHAR2(18 CHAR)


Security Center time zone.

p_ToDate

VARCHAR2(18 CHAR)


Security Center time zone.

p_AckStatuses

VARCHAR2(15 CHAR)


REF_ALARM_ACK_TYPE_T:

0 – Not Acknowledged

1 – Assigned

2 – Closed

When NULL applies to all

statuses

p_ProductLineId

NUMBER(9,0)


to a given product line. When

NULL, provides results to all

product lines.

p_CategoryName

VARCHAR2(255 BYTE)



applies to all Categories

p_cv_AlarmList Output Yes Result set





REF CURSOR

Result set


Description/Comment

FIRST_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)



THIRD_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SITE_SERVER_ID

NUMBER(9,0)

Number Unique Site Identifier of line


Center UI as a tooltip when

hovering over a VSE. Visible in

the VSE UI in Registration Information tab)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server name

SITE_SERVER_LOCATION

VARCHAR2(255 BYTE)

String Location of Site Server (Site Location in the Security

Center UI, Location in the VSE

UI)




Description/Comment

CONTACT_FIRST_NAME

VARCHAR2(255 BYTE)



Center UI, First Name in the

VSE UI)

CONTACT_LAST_NAME

VARCHAR2(255 BYTE)



Center UI, Last Name in the

VSE UI)

CONTACT_COMPANY

VARCHAR2(255 BYTE)



Security Center UI, Company

in the VSE UI)

CONTACT_PHONE

VARCHAR2(255 BYTE)


number (Contact Phone in

the Security Center UI, Phone Number in the VSE UI)

CONTACT_EMAIL

VARCHAR2(2000 BYTE)

String Site administrator email

address (Contact E-mail in

the Security Center UI, E-mail in the VSE UI)

SRV_RANK

NUMBER(3,0)

Number Site ranking in Security Center

(Ranking in the UI)

ALRM_DETECTION_DATE

VARCHAR2(8 CHAR)

String Adjusted to p_UserId time

zone

ANALYSIS_RULE_ID

NUMBER(9,0)

Number Unique Analysis Rule Identifier

of Analysis Rule below (not

visible in the UI)

ANALYSIS_RULE_NAME

VARCHAR2(255 BYTE)


ANALYSIS_RULE_CATEGORY_NAME String The name of the category to




Description/Comment

VARCHAR2(255 BYTE) which the analysis rule

belongs

ALARM_SEVERITY_CODE

NUMBER(3,0)


below

ALARM_SEVERITY_NAME

VARCHAR2(50 BYTE)


REF_ALARM_SEVERITY_TYPE

_T:

1 – Informational

2 – Warning

3 – Error

4 – Critical

11 – None

10 – Clear

11 – All

ALRM_ACKTYP_CODE

NUMBER(3,0)


below

ALRM_ACK_TYPE_NAME

VARCHAR2(50 BYTE)




1 – Assigned

2 – Closed

ALARMS_COUNT

NUMBER(9,0)

Number Total Alarms number

PRODUCT_LINE_ID

NUMBER(9,0)



PRODUCT_LINE_NAME

VARCHAR2(255 BYTE)

String Product Line name a Device

inherits from (to the right of


PRODUCT_LINE_VENDOR_NAME String Product Line vendor a Device




Description/Comment

VARCHAR2(255 BYTE) inherits from (to the left of


5.9 Get data by specific Diagnostic routine This API retrieves data collected by a specific Diagnostic routine.

Database API procedure name GetDiagnoseActivityData

Description This API retrieves data collected by a specific Diagnostic routine. The data includes

only Data Units of the type Object (no Files, Event Logs or Alarm Tables) and properties

of all types except of Identification. The result set is not sorted.

Built-in reports using this API Diagnostic Routine Results

Parameters



p_UserId

NUMBER(9,0)


as appears in




p_ActivityId

NUMBER(9,0)

Number Yes Unique Activity ID as

appears in:

TSK_TASK_INFO_T.TSK_ID

p_cv_DiagnoseActivityData

REF CURSOR




Result set


Description/Comment

OBJ_ID

NUMBER(9,0)



OBJ_NAME

VARCHAR2(255 BYTE)

String Object name (Object Name in the

UI)

PRPTY_ID

NUMBER(9,0)



PRPTY_NAME

VARCHAR2(255 BYTE)

String Property name (Property Name in

the UI)

PRPTY_CTGRY_CODE

NUMBER(3,0)


CTGRY_NAME

VARCHAR2(50 BYTE)


REF_CATEGORY_TYPE_T:

1 – Identification

2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events

TIME_STAMP

DATE

Date Diagnose Routine run date time,

per VSE time zone

COLDAT_PRPTY_RES_VALUE

VARCHAR2(255 BYTE)

String Value contained in highest Index

COLDAT_PRPTY_RES_SEQ_NO

NUMBER(9,0)

Number Unique identifier of value in line

above

INDEX_INSTANCE_ID

VARCHAR2(255 BYTE)

String Unique Identifier of collected

Collection Profile Object Index




Description/Comment

INDEX_VALUE_1

VARCHAR2(255 BYTE)

String Identification Category number 1

INDEX_VALUE_2

VARCHAR2(255 BYTE)


(nested in number 1)

INDEX_VALUE_3

VARCHAR2(255 BYTE)



INDEX_VALUE_4

VARCHAR2(255 BYTE)



INDEX_VALUE_5

VARCHAR2(255 BYTE)



PRPTY_MAX_SEVRTYP_CODE

NUMBER(3,0)

Number One key from


1 – Informational

2 – Warning

3 – Error

4 – Critical

DEVICE_ID

NUMBER(9,0)



DEVICE_NAME

VARCHAR2(255 BYTE)


UI)

FIRST_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)






Description/Comment


VARCHAR2(255 BYTE)


Management Tree

THIRD_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SRV_ID

NUMBER(9,0)





VSE UI in Registration Information tab)

SRV_NAME

VARCHAR2(255 BYTE)


SRV_LOCATION

VARCHAR2(255 BYTE)



SRV_CONTACT_COMPANY

VARCHAR2(255 BYTE)




the VSE UI)

SRV_CONTACT_FIRST_NAME

VARCHAR2(255 BYTE)




UI)

SRV_CONTACT_LAST_NAME

VARCHAR2(255 BYTE)




UI)

SRV_CONTACT_EMAIL String Site administrator email address




Description/Comment

VARCHAR2(2000 BYTE) (Contact E-mail in the Security


SRV_CONTACT_PHONE

VARCHAR2(255 BYTE)




CREATED_BY

NUMBER(9,0)

Number The unique ID of the activity’s

creator

CREATED_BY_NAME

VARCHAR2(511 BYTE)

String The first and last names of the

activity’s creator

CREATION_DATE

DATE

Date The date and time in which the

activity was created.

5.10 Get collected data by property This API retrieves the last values collected within a specified time frame.

Database API procedure name GetDataByProperty

Description This API retrieves the last values collected within a specified time frame, similar to the

Data Viewer functionality. The result set is not sorted.


Parameters

Parameter and Format

Parameter Type


p_UserId

NUMBER(9,0)


appears in


ID governs viewing and querying




Parameter Type


permissions

p_SiteId

NUMBER(9,0)

Number When defined, limits results to a

given site. When NULL, provides


p_DeviceName

VARCHAR2(255

BYTE)

String When defined can also use wild

cards. When NULL applies to all

Devices

p_PrptyCategory

VARCHAR2(255

BYTE)


REF_CATEGORY_TYPE_T, or

NULL¶


2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events

p_IsInitialData

NUMBER(1,0)

Number Decode:

NULL – Everything

0 – Everything

1 – Required for initial trouble

shooting

p_FromDate

VARCHAR2(18

CHAR)



p_ToDate

VARCHAR2(18

CHAR)



p_SeverityCode

NUMBER(3,0)

Number One key from

REF_ARULE_SEVERITY_TYPE_T,

or NULL:




Parameter Type


NULL – Everything

1 – Informational

2 – Warning

3 – Error

4 – Critical

p_cv_ViewerData

REF CURSOR


Result set


OBJ_ID

NUMBER(9,0)



OBJ_NAME

VARCHAR2(255 BYTE)

String Object name (Object Name in

the UI)

PRPTY_ID

NUMBER(9,0)

Number Unique Property Identifier of

line below (not visible in the UI)

PRPTY_NAME

VARCHAR2(255 BYTE)

String Property name (Property Name in the UI)

PRPTY_CTGRY_CODE

NUMBER(3,0)


below

CTGRY_NAME

VARCHAR2(255 BYTE)




2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events




TIME_STAMP

DATE

Date Diagnose Routine run date

time, per VSE time zone


VARCHAR2(255 BYTE)

String Value contained in highest

Index


NUMBER(9,0)

Number Unique identifier of value in

line above

INDEX_INSTANCE_ID

VARCHAR2(255 BYTE)



INDEX_VALUE_1

VARCHAR2(255 BYTE)

String Identification Category

number 1

INDEX_VALUE_2

VARCHAR2(255 BYTE)


number 2 (nested in number

1)

INDEX_VALUE_3

VARCHAR2(255 BYTE)



2)

INDEX_VALUE_4

VARCHAR2(255 BYTE)



3)

INDEX_VALUE_5

VARCHAR2(255 BYTE)



4)

PRPTY_MAX_SEVRTYP_CODE

VARCHAR2(255 BYTE)

Number One key from

REF_ARULE_SEVERITY_TYPE_

T:

1 – Informational

2 – Warning

3 – Error

4 – Critical




DEVICE_ID

NUMBER(9,0)

Number Unique Device Identified of

line below (not visible in the UI)

DEVICE_NAME

VARCHAR2(255 BYTE)


the UI)

FIRST_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)



THIRD_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SRV_ID

NUMBER(9,0)




hovering over a VSE. Visible in

the VSE UI in Registration Information tab)

SRV_NAME

VARCHAR2(255 BYTE)




5.11 Get list of detailed alarms by Security Center detection date-time This API retrieves detailed information on Knowledge Alarms for each alarm inserted

into the NSA database within the selected time frame.

Database API procedure name GetAlarmListDetailedBySCTime

Description This API retrieves detailed information on Knowledge Alarms (not including System

Alarms) for each alarm inserted into the NSA database within the selected time frame.

The result set is sorted by Alarm Severity, and User Detection Date.


Parameters


Parameter Type

Mandatory?

Description

p_UserId

MUNBER(9,0)

Number Yes User ID that runs the API as appears in

SEC_VS_USER_T.USR_ID. This ID

governs viewing and querying

permissions

p_SiteId

NUMBER(9,0)

Number When defined, limits results to a given

site. When NULL, provides results to all

sites.

p_AlarmName

VARCHAR2(255

BYTE)

String When defined can also use wild cards.

When NULL applies to all Alarms

p_FromDate

VARCHAR2(18

CHAR)

String Yes ‘YYYYMMDD HH24:MI:SS’ per Security

Center time zone

p_ToDate

VARCHAR2(18


Center time zone




Parameter Type

Mandatory?

Description

CHAR)

p_AckStatuses

VARCHAR2(15

CHAR)

String Comma separated keys string as

appears in REF_ALARM_ACK_TYPE_T:

0 – Not acknowledged

1 – Assigned

2 – Closed

When NULL applies to all statuses

p_ProductLineId

NUMBER(9,0)

Number Unique Product Line ID as appears in:

APP_PRODUCT_LINE_INFO_T.PRDLIN

_ID

When NULL provides results to all

Product Lines

p_CategoryName

VARCHAR2(255

BYTE)

String When defined can also use wild cards.

When NULL applies to all Categories

p_cv_GetAlarmLis

t

REF CURSOR


Result set


Description/Comment

ALRM_DETECTION_UTC_DATE

DATE

Date Alarm Set date time in UTC time

zone

SITE_ORIGINATOR_ID

NUMBER(9,0)

Number Unique Site Identifier of line








Description/Comment

DEVICE_NAME

VARCHAR2(255 BYTE)


the UI)

ALRM_SEVRTYP_CODE

NUMBER(3,0)

Number Key from

REF_ALARM_SEVERITY_TYPE_T:

1 – Informational

2 – Warning

3 – Error

4 – Critical

11 – None

-10 – Clear

-11 – All

ALRM_DESC

VARCHAR2(2000 BYTE)


(Description in the UI) filled with

Alarm specific values

ALRM_ID

NUMBER(9,0)

Number Unique Alarm ID sequence

number

ALRM_PART_NO

NUMBER(9,0)

Number Number of day in a year, in


ALRM_DISPLAY_ID

VARCHAR2(81 BYTE)

String Concatenation of:

ALRM_PART_NO, “-“, ALRM_ID

ALRM_TYP_ID

NUMBER(9,0)

Number -1 – Knowledge alarm

Otherwise – System alarm

REF_ALARM_TYPE_T

ALRM_COUNTER

NUMBER(9,0)

Number Number of times violation to this

Alarm occurred.

ALRM_TYP_CODE

NUMBER(3,0)

Number One key from:

1 – Single

2 – Pair




Description/Comment

ALRM_ACK_DESC

VARCHAR2(2000 BYTE)

String Description associated with

Acknowledging Alarm

ALRM_ACK_UPDATE_UTC_DATE

DATE

Date Acknowledge date time in UTC

time zone

ALRM_ACK_CREATION_UTC_DATE

DATE

Date Date and time of the first

acknowledgement of the alarm

ALRM_ACK_USER_FIRST_NAME

VARCHAR2(255 BYTE)

String Acknowledging User first name

ALRM_ACK_USER_LAST_NAME

VARCHAR2(255 BYTE)

String Acknowledging User last name

ALRM_ACK_USER_LOGIN_NAME

VARCHAR2(2000 BYTE)

String Acknowledging User login name

ALRM_DATA

VARCHAR2(4000 BYTE)

String Not in use

ALRM_ACKTYP_CODE

NUMBER(3,0)


below

ALRM_ACK_TYPE_NAME

VARCHAR2(50 BYTE)



0 –Not Ack3

1 – Assigned

2 – Closed

ALRM_IS_CLEARED

NUMBER(3,0)

Number Decode:

0 – Not cleared

1 – Cleared

3 Not Ack – Not Acknowledged




Description/Comment

ALRM_CASE_ID

VARCHAR2(255 BYTE)

String External to ICS Shield case ID

ALRM_DETECTION_SC_DATE

DATE

Date Alarm Set date time in Security

Center time zone

ALRM_DETECTION_SS_DATE

DATE

Date Alarm Set date time in Site time

zone

SRV_NAME

VARCHAR2(255 BYTE)


SRV_LOCATION

VARCHAR2(255 BYTE)




VARCHAR2(255 BYTE)




UI)


VARCHAR2(255 BYTE)




UI)

SRV_CONTACT_COMPANY

VARCHAR2(255 BYTE)




the VSE UI)

SRV_CONTACT_EMAIL

VARCHAR2(2000 BYTE)

String Site administrator email address

(Contact E-mail in the Security


SRV_CONTACT_PHONE

VARCHAR2(255 BYTE)







Description/Comment

FIRST_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

THIRD_LEVEL_GRP_ID

NUMBER(9,0)




VARCHAR2(255 BYTE)


Management Tree

SYSTM_ID

NUMBER(9,0)

Number Unique System Identifier of line


SYSTM_NAME

VARCHAR2(255 BYTE)

String System (logical group) name

IS_INVISIBLE

VARCHAR2(240 BYTE)

String Decode:

0 – Visible

1 – Invisible

DEVICE_ID

NUMBER(9,0)

Number Unique Device Identifier of line


DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address (Device Address in the UI)

SEVRTYP_NAME

VARCHAR2(50 BYTE)



1 – Information




Description/Comment

2 – Warning

3 – Error

4 – Critical

11 – None

-10 – Clear

-11 – All

RPRTINF_ID

NUMBER(9,0)

Number Unique Reported Data Identifier


COLINF_ID

NUMBER(9,0)

Number Unique Collection Identifier that

contained most recent updates

to a Device’s property (not visible

in the UI)

COLINF_PART_NO

NUMBER(9,0)



PRDLIN_ID

NUMBER(9,0)



PRDLIN_NAME

VARCHAR2(255 BYTE)


PRDLIN_VENDOR_NAME

VARCHAR2(255 BYTE)

String Product Line vendor (Product Vendor in the UI)

MODEL_ID

NUMBER(9,0)

Number Unique Model Identifier of line


DEVICE_MODEL

VARCHAR2(255 BYTE)

String Device Model name (Model in

the UI)

VERSION_ID

NUMBER(9,0)

Number Unique Version Identifier of line


DEVICE_VERSION String Device Version name (Version in




Description/Comment

VARCHAR2(255,0) the UI)

ARULE_ID

NUMBER(9,0)

Number Unique Analysis Rule Identifier of

Analysis Rule four lines below


ARULE_NAME

VARCHAR2(255 BYTE)


ARULE_CTGRY_NAME

VARCHAR2(255 BYTE)




2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events

PRPTY_NAME

VARCHAR2(255 BYTE)

String Property name (Property Name

in the UI)

OBJ_NAME

VARCHAR2(255 BYTE)

String Object name that encloses above

property

ALRM_LAST_DETECTION_SS_DAT

E

DATE

Date Most recent Alarm Set date time

in Site time zone

ARULE_DESC

VARCHAR2(2000 BYTE)



USER_DATA

VARCHAR2(255 BYTE)

String Free text by User (User Data in

Analysis Rule GUI)

PROBLEM_RESOLUTION_DESC

VARCHAR2(2000 BYTE)

String Free text describing problem

resolution

INDEX_VALUE_1 String Identification Category number 1




Description/Comment

VARCHAR2(255 BYTE)

INDEX_VALUE_2

VARCHAR2(255 BYTE)



INDEX_VALUE_3

VARCHAR2(255 BYTE)



CREATION_DATE

DATE

Date Record creation date time in


ALRM_DETECTION_USER_DATE

DATE

Date Alarm Set date time adjusted to

p_UserId time zone

ALRM_LAST_ACK_USER_DATE

DATE

Date Alarm Set Acknowledgement date

time adjusted to p_UserId time

zone

ALRM_LAST_CAK_UPDATE_USER_

DATE

VARCHAR2(17)

String Last date in which the alarm was

updated



5.12 Get list of detailed alarms by Security Center insertion date-time This API retrieves detailed information on Knowledge Alarms for each alarm that took

place within the specified time frame

Database API procedure name GetAlarmListDetailed

Description This API retrieves detailed information on Knowledge Alarms (not including System

Alarms), for each alarm that occurred within the specified time frame. Unlike the

GetAlarmList API, each row contains complete information for each alarm in the

results. The result set is sorted by Alarm Severity and User Detection Date

Built-in reports using this API Alarms History

Parameters


Parameter Type


p_UserId

NUMBER(9,0)

Number Yes User ID that runs the API as appears

in SEC_VS_USER_T.USR_ID. This ID


permissions

p_SiteId

NUMBER(9,0)

Number When defined, limits results to a

given site. When NULL, provides


p_AlarmName

VARCHAR2(25

5 BYTE)



Alarms

p_FromDate

VARCHAR2(18

CHAR)






Parameter Type


p_ToDate

VARCHAR2(18

CHAR)



p_AckStatuses

VARCHAR2(15

CHAR)

String Comma separated keys string as

appears in REF_ALARM_ACK_TYPE_T

0 – Not acknowledged

1 – Assigned

2 – Closed

When NULL applies to all statuses

p_ProductLineI

d

NUMBER(9,0)

Number Unique Product Line ID as appears

in:

APP_PRODUCT_LINE_INFO_T.PRDLI

N_ID

When NULL provides results to all

Product Lines

p_CategoryNa

me

VARCHAR2(25

5 BYTE)



categories

p_cv_GetAlarm

List

REF CURSOR




Result set


ALRM_DETECTION_UTC_DATE

DATE

Date Alarm Set date time in UTC

time zone

SITE_ORIGINATOR_ID

NUMBER(9,0)

Number Unique Site Identifier of

line below (tooltip in the

Security Center UI, ID in

the VSE UI)

DEVICE_NAME

VARCHAR2(255 BYTE)

String Device name (Device Name in the UI)

ALRM_SEVRTYP_CODE

NUMBER(3,0)

Number One key from

REF_ALARM_SEVERITY_TY

PE_T:

1 – Informational

2 – Warning

3 – Error

4 – Critical

11 – None

-10 – Clear

-11 – All

ALRM_DESC

VARCHAR2(2000 BYTE)



filled with Alarm specific

values

ALRM_ID

NUMBER(9,0)

Number Unique Alarm ID sequence

number

ALRM_PART_NO

NUMBER(9,0)



ALRM_DISPLAY_ID

VARCHAR2(81 BYTE)

String Concatenation of:

ALRM_PART_NO, “-“,

ALRM_ID




ALRM_TYP_ID

NUMBER(9,0)

Number System alarm sequence

identifier from

REF_ALARM_TYPE_T

ALRM_COUNTER

NUMBER(9,0)

Number Number of times this Alarm

occurred until cleared. (For

Single Alarms this value will

always be 1)

ALRM_TYP_CODE

NUMBER(3,0)

Number One key from:

1 – Single

2 – Pair

ALRM_ACK_DESC

VARCHAR2(2000 BYTE)

String Description associated

with Acknowledging Alarm

ALRM_ACK_UPDATE_UTC_DATE

DATE

Date Acknowledge date time in

UTC time zone

ALRM_ACK_CREATION_UTC_DAT

E

DATE

Date Date and time of the first

acknowledgement of the

alarm

ALRM_ACK_USER_FIRST_NAME

VARCHAR2(255 BYTE)

String Acknowledging User first

name

ALRM_ACK_USER_LAST_NAME

VARCHAR2(255 BYTE)

String Acknowledging User last

name

ALRM_ACK_USER_LOGIN_NAME

NVARCHAR2(2000 CHAR)

String Acknowledging User login

name

ALRM_DATA

VARCHAR2(4000 BYTE)

String Not in use

ALRM_ACKTYP_CODE

NUMBER(3,0)

Number One key from list below




ALRM_ACK_TYPE_NAME

VARCHAR2(5 BYTE)



0 –Not Ack4

1 – Assigned

2 – Closed

ALRM_IS_CLEARED

NUMBER(3,0)

Number Decode:

0 – Not cleared

1 – Cleared

ALRM_CASE_ID

VARCHAR2(255 BYTE)

String External to ICS Shield case

ID

ALRM_DETECTION_SC_DATE

DATE

Date Alarm Set date time in


ALRM_DETECTION_SS_DATE

DATE

Date Alarm Set date time in Site

time zone

SRV_NAME

VARCHAR2(255 BYTE)


SRV_LOCATION

VARCHAR2(255 BYTE)

String Location of Site Server

(Site Location in the

Security Center UI,

Location in the VSE UI)


VARCHAR2(255 BYTE)

String Site administrator first

name (Contact Name in

the Security Center UI,

First Name in the VSE UI)

4 Not Ack – Not Acknowledged





VARCHAR2(255 BYTE)

String Site administrator last

name (Contact Name in

the Security Center UI, Last Name in the VSE UI)

SRV_CONTACT_COMPANY

VARCHAR2(255 BYTE)



Security Center UI,

Company in the VSE UI)

SRV_CONTACT_EMAIL

VARCHAR2(2000 BYTE)

String Site administrator email

address (Contact E-mail in

the Security Center UI, E-mail in the VSE UI)

SRV_CONTACT_PHONE

VARCHAR2(255 BYTE)

String Site administrator

telephone number

(Contact Phone in the


FIRST_LEVEL_GRP_ID

NUMBER(9,0)

Number Unique Group Identifier of

line below (not visible in

the UI)


VARCHAR2(255 BYTE)

String First level group name of


SECOND_LEVEL_GRP_ID

NUMBER(9,0)



the UI)


VARCHAR2(255 BYTE)

String Second level group name

of Site Management Tree

THIRD_LEVEL_GRP_ID

NUMBER(9,0)



the UI)

THIRD_LEVEL_GRP_NAME String Third level group name of




VARCHAR2(255 BYTE) Site Management Tree

SYSTM_ID

NUMBER(9,0)

Number Unique System Identifier of


the UI)

SYSTM_NAME

VARCHAR2(255 BYTE)

String System (logical group)

name

IS_INVISIBLE

VARCHAR2(240 BYTE)

String Decode:

0 – Visible

1 – Invisible

DEVICE_ID

NUMBER(9,0)

Number Unique Device Identifier of


the UI)

DEVICE_IP

VARCHAR2(255 BYTE)


SEVRTYP_NAME

VARCHAR2(50 BYTE)


REF_ALARM_SEVERITY_TY

PE_T:

1 – Information

2 – Warning

3 – Error

4 – Critical

11 – None

-10 – Clear

-11 – All

RPRTINF_ID

NUMBER(9,0)

Number Unique Reported Data

Identifier (not visible in the

UI)

COLINF_ID

NUMBER(9,0)

Number Unique Collection Identifier

that contained most recent

updates to a Device’s

property (not visible in the




UI)

COLINF_PART_NO

NUMBER(9,0)



PRDLIN_ID

NUMBER(9,0)

Number Unique Product Line

Identifier of concatenated

two lines above (not visible

in the UI)

PRDLIN_NAME

VARCHAR2(255 BYTE)

String Product Line name

(Product Line Name in the

UI)

PRDLIN_VENDOR_NAME

VARCHAR2(255 BYTE)

String Product Line vendor

(Product Vendor in the UI)

MODEL_ID

NUMBER(9,0)

Number Unique Model Identifier of


the UI)

DEVICE_MODEL

VARCHAR2(255 BYTE)

String Device Model name

(Model in the UI)

VERSION_ID

NUMBER(9,0)

Number Unique Version Identifier of


the UI)

DEVICE_VERSION

VARCHAR2(255,0)

String Device Version name

(Version in the UI)

ARULE_ID

NUMBER(9,0)

Number Unique Analysis Rule

Identifier of Analysis Rule

four lines below (not visible

in the UI)

ARULE_NAME

VARCHAR2(255 BYTE)

String Analysis Rule name

(Analysis Rule Name in the

UI)




ARULE_CTGRY_NAME

VARCHAR2(255 BYTE)


REF_CATEGORY_TYPE_T


2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events

PRPTY_NAME

VARCHAR2(255 BYTE)


OBJ_NAME

VARCHAR2(255 BYTE)

String Object name that encloses

above property

ALRM_LAST_DETECTION_SS_DA

TE

DATE

Date Most recent Alarm Set date

time in Site time zone

ARULE_DESC

VARCHAR2(2000 BYTE)



USER_DATA

VARCHAR2(255 BYTE)

String Free text by User (User Data in Analysis Rule GUI)

PROBLEM_RESOLUTION_DESC

VARCHAR2(2000 BYTE)

String Free text describing

problem resolution

INDEX_VALUE_1

VARCHAR2(255 BYTE)


number 1

INDEX_VALUE_2

VARCHAR2(255 BYTE)


number 2 (nested in

number 1)

INDEX_VALUE_3

VARCHAR2(255 BYTE)


number 3 (nested in

number 2)




CREATION_DATE

DATE

Date Record creation date time

in Security Center time

zone

ALRM_DETECTION_USER_DATE

DATE

Date Alarm Set date time

adjusted to p_UserId time

zone

ALRM_LAST_ACK_USER_DATE

DATE

Date Alarm Set

Acknowledgement date

time adjusted to p_UserId

time zone

ALRM_LAST_CAK_UPDATE_USER

_DATE

VARCHAR2(17)

String Last date in which the

alarm was updated



5.13 Get collected data by Security Center insert time This API retrieves data collected based on specified parameters.

Database API procedure name GetExtendedCollectedData

Description This API retrieves data collected based on specified parameters. The API is useful in

installations where the sites are in online connected mode, as there is no gap between

the property explicit time, namely: the collection time (see TIME_STAMP description in

the table below - not visible in the UI), and the time the data was inserted into the

database. The result set is not sorted.

Built-in reports using this API Data Over Time

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number Yes When defined, limits results to

a given site. When NULL,


p_DeviceName

VARCHAR2(255

BYTE)


cards. When NULL applies to

all Devices

p_PrptyName

VARCHAR2(255

BYTE)



all Properties

p_FromDate String Yes ‘YYYYMMDD HH24:MI:SS’ per




Parameter Type


VARCHAR2(18

CHAR)


p_ToDate

VARCHAR2(18

CHAR)



p_PrtpyCategory

NUMBER(3,0)

Number Category Code as appears in



2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 – Events

p_cv_CollectedData

REF CURSOR


Result set


SITE_SERVER_ID

NUMBER(9,0)

Number Unique Server Identified

of line below (tooltip in

the Security Center UI, ID

in the VSE UI)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name

(Site Name in the UI)

DEVICE_ID

NUMBER(9,0)

Number Unique Device Identified

of line below (not visible

in the UI)

DEVICE_NAME

VARCHAR2(255 BYTE)





DEVICE_SERIAL_NO

VARCHAR2(255 BYTE)

String Device Unique Serial

Number (Device Unique ID in the UI)

DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address

(Device Address in the

UI)

DEVICE_MODEL

VARCHAR2(255 BYTE)

String Model name a Device

inherits from (Model in

the UI)

DEVICE_VERSION

VARCHAR2(255 BYTE)

String Version name a Device

inherits from (Version in

the UI)

PARENT_OBJ_ID

NUMBER(9,0)

Number Unique Object Identifier

of enclosing Object (not

visible in the UI)

PROPERTY_NAME

VARCHAR2(255 BYTE)


PRPTY_ID

NUMBER(9,0)

Number Unique Property

Identifier of line above


COLINF_ID

NUMBER(9,0)

Number Unique Collection

Identifier that contained

most recent updates to a

Device’s property (not

visible in the UI)

INDEX_VALUE_1

VARCHAR2(255 BYTE)


number 1

INDEX_VALUE_2

VARCHAR2(255 BYTE)


number 2 (nested in

number 1)




INDEX_VALUE_3

VARCHAR2(255 BYTE)


number 3 (nested in

number 2)


NUMBER(9,0)

Number Unique identifier of value

in line below


VARCHAR2(255 BYTE)

String Value contained in

highest Index

COLPRPTY_OBJINST_ID

NUMBER(10,0)

Number Unique Identifier of

collected Collection

Profile Object

INDEX_INSTANCE_ID

VARCHAR2(255 BYTE)

String Unique Identifier of

collected Collection

Profile Object Index

TIME_STAMP

VARCHAR2(18 CHAR)

String ‘YYYYMMDD

HH24:MI:SS’ adjusted to

VSE time zone

5.14 Get collected data by site report creation time This API retrieves data collected at sites in offline mode, based on specified

parameters.

Database API procedure name GetDataBySiteTime

Description This API retrieves data collected based on specified parameters. The parameters and

returned fields are identical to the GetExtendedCollectedData API. However, this

API is designed to return data collected at sites in offline mode, as the time frame

parameters are based on the report creation time in the VSE. The result set is not

sorted.




Parameters



p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number Yes Specifies the ID of the site

where the data was collected

p_DeviceName

VARCHAR2(255 BYTE)




p_PrptyName

VARCHAR2(255 BYTE)



applies to all Properties

p_FromDate

VARCHAR2(18 CHAR)


VSE time zone

p_ToDate

VARCHAR2(18 CHAR)


VSE time zone

p_PrtpyCategory

NUMBER(3,0)

Number Category Code as appears in



2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 – Events

p_cv_CollectedData

REF CURSOR




Result set


Description/Comment

SITE_SERVER_ID

NUMBER(9,0)


below (tooltip in the Security

Center UI, ID in the VSE UI)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name

in the UI)

DEVICE_ID

NUMBER(9,0)



DEVICE_NAME

VARCHAR2(255 BYTE)


UI)

DEVICE_SERIAL_NO

VARCHAR2(255 BYTE)



DEVICE_IP

VARCHAR2(255 BYTE)


DEVICE_MODEL

VARCHAR2(255 BYTE)

String Model name a Device inherits

from (Model in the UI)

DEVICE_VERSION

VARCHAR2(255 BYTE)

String Version name a Device inherits

from (Version in the UI)

PARENT_OBJ_ID

NUMBER(9,0)

Number Unique Object Identifier of

enclosing Object (not visible in

the UI)

PROPERTY_NAME

VARCHAR2(255 BYTE)


the UI)

PRPTY_ID

NUMBER(9,0)


above (not visible in the UI)

COLINF_ID Number Unique Collection Identifier that




Description/Comment

NUMBER(9,0) contained most recent updates to

a Device’s property (not visible in

the UI)

INDEX_VALUE_1

VARCHAR2(255 BYTE)


INDEX_VALUE_2

VARCHAR2(255 BYTE)



INDEX_VALUE_3

VARCHAR2(255 BYTE)




NUMBER(9,0)


below


VARCHAR2(255 BYTE)


COLPRPTY_OBJINST_ID

NUMBER(10,0)

Number Unique Identifier of collected

Collection Profile Object

INDEX_INSTANCE_ID

VARCHAR2(255 BYTE)



INDEX_VALUE_2

VARCHAR2(255 BYTE)



INDEX_VALUE_3

VARCHAR2(255 BYTE)




NUMBER(9,0)


below


VARCHAR2(255 BYTE)


COLPRPTY_OBJINST_ID Number Unique Identifier of collected




Description/Comment

NUMBER(10,0) Collection Profile Object

INDEX_INSTANCE_ID

VARCHAR2(255 BYTE)



TIME_STAMP

VARCHAR2(18 CHAR)

String ‘YYYYMMDD HH24:MI:SS’

adjusted to VSE time zone

5.15 Get device monitoring statistics This API retrieves the number of execution profiles collected and sorts the result set by

Device name.

Database API procedure name GetDeviceMonitoringStatistics

Description This API retrieves the number of execution profiles collected, and the number of

specific protocol failures and successes, grouped by device, model, version, collection

profile, and date. The result set is sorted by Device name.

Built-in reports using this API Data Collection Statistics

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number When defined limits results to

given Site. When NULL

provides results to all Sites

p_DeviceName String When defined can also use wild




Parameter Type


VARCHAR2(255

BYTE)


all Devices

p_ProductLineId

NUMBER(9,0)

Number When defined can also use wild


all Product Lines

p_ProfileName

VARCHAR2(255

BYTE)



all Profiles

p_FromDate

VARCHAR2(18

CHAR)



p_ToDate

VARCHAR2(18

CHAR)



Result set


DEVICE_ID

NUMBER(9,0)

Number Unique Device

Identified of line below


DEVICE_NAME

VARCHAR2(255 BYTE)


DEVICE_SERIAL_NO

VARCHAR2(255 BYTE)

String Device Unique Serial

Number (Device Unique ID in the UI)

DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address

(Device Address in the

UI)

MDL_ID Number Unique Model Identifier




NUMBER(9,0) (not visible in the UI)

SWVER_ID

NUMBER(9,0)

Number Unique Version

Identifier (not visible in

the UI)

COLPRF_ID

NUMBER(9,0)

Number Unique Collection

Profile Identifier (not

visible in the UI)

COLPRF_NAME

VARCHAR2(255 BYTE)

String Collection Profile name

CREATION_DATE

DATE

Date Device creation date

time, in Security Center

time zone

FIRST_LEVEL_GRP_ID

NUMBER(9,0)

Number Unique Group Identifier


in the UI)


VARCHAR2(255 BYTE)

String First level group name

of Site Management

Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)



in the UI)


VARCHAR2(255 BYTE)

String Second level group

name of Site

Management Tree

THIRD_LEVEL_GRP_ID

NUMBER(9,0)



in the UI)


VARCHAR2(255 BYTE)

String Third level group name

of Site Management

Tree




SRV_ID

NUMBER(9,0)

Number Unique Server

Identified of line below

(tooltip in the Security

Center UI, ID in the VSE

UI)

SRV_NAME

VARCHAR2(255 BYTE)

Name Site Server, VSE, name

(Site Name in the UI)

PRDLIN_ID

NUMBER(9,0)

Number Unique Product Line

Identifier (not visible in

the UI)

PRDLIN_NAME

VARCHAR2(255 BYTE)

String Product Line name a

Device inherits from (to

the right of Product Line in the UI)

PRDLIN_VENDOR_NAME

VARCHAR2(255 BYTE)

String Product Line vendor a

Device inherits from (to

the left of Product Line

in the UI)

DATA_SIZE_KB

NUMBER(10,2)

Number Total sum in collected

KB of data

COLLECTIONS_COUNT

NUMBER(9,0)

Number Total number of run

Collection Profiles

SUCCESS_SNMP_COLLECTIONS

NUMBER(9,0)

Number Total number of

successful SNMP

collections

SUCCESS_TELNET_COLLECTIONS

NUMBER(9,0)


successful Telnet

collections

SUCCESS_TL1_COLLECTIONS

NUMBER(9,0)


successful TL1

collections




SUCCESS_WMI_COLLECTIONS

NUMBER(9,0)


successful WMI

collections

SUCCESS_DBI_COLLECTIONS

NUMBER(9,0)


successful DBI

collections

SUCCESS_CUSTOM_COLLECTIONS

NUMBER(9,0)


successful Custom

collections

SUCCESS_OPC_COLLECTIONS

NUMBER(9,0)


successful OPC

collections

SUCCESS_FTP_COLLECTIONS

NUMBER(9,0)


successful FTP

collections

SUCCESS_SYSLOG_COLLECTIONS

NUMBER(9,0)


successful SYSLOG

collections

SUCCESS_SNMPTRAP_COLLECTIONS

NUMBER(9,0)


successful SNMPTrap

collections

FAILURE_SNMP_COLLECTIONS

NUMBER(9,0)

Number Total number of failed

SNMP collections

FAILURE_TELNET_COLLECTIONS

NUMBER(9,0)


Telnet collections

FAILURE_TL1_COLLECTIONS

NUMBER(9,0)


TL1 collections

FAILURE_WMI_COLLECTIONS

NUMBER(9,0)


WMI collections




FAILURE_DBI_COLLECTIONS

NUMBER(9,0)


DBI collections

FAILURE_CUSTOM_COLLECTIONS

NUMBER(9,0)


Custom collections

FAILURE_OPC_COLLECTIONS

NUMBER(9,0)


OPC collections

FAILURE_FTP_COLLECTIONS

NUMBER(9,0)


FTP collections

FAILURE_SYSLOG_COLLECTIONS

NUMBER(9,0)


SYSLOG collections

FAILURE_SNMPTRAP_COLLECTIONS

NUMBER(9,0)


SNMPTrap collections

PARTIAL_SNMP_COLLECTIONS

NUMBER(9,0)

Number Total number of partial

SNMP collections

PARTIAL_TELNET_COLLECTIONS

NUMBER(9,0)


Telnet collections

PARTIAL_TL1_COLLECTIONS

NUMBER(9,0)


TL1 collections

PARTIAL_WMI_COLLECTIONS

NUMBER(9,0)


WMI collections

PARTIAL_DBI_COLLECTIONS

NUMBER(9,0)


DBI collections

PARTIAL_CUSTOM_COLLECTIONS

NUMBER(9,0)


Custom collections

PARTIAL_OPC_COLLECTIONS

NUMBER(9,0)


OPC collections




PARTIAL_FTP_COLLECTIONS

NUMBER(9,0)


FTP collections

PARTIAL_SYSLOG_COLLECTIONS

NUMBER(9,0)


SYSLOG collections

PARTIAL_SNMPTRAP_COLLECTIONS

NUMBER(9,0)


SNMPTrap collections

5.16 Get product line properties This API retrieves a list of properties for a specific product line or for all product lines.

Database API procedure name GetPLProperties

Description This API retrieves a list of properties for a specific product line or all product lines. The

result set is sorted by Product Line ID, and Property Name.

Built-in reports using this API Product Lines Properties

Parameters



p_UserId

NUMBER(9,0)


as appears in




p_ProductLineIdByPlPrms

NUMBER(9,0)

Number When defined, limits

results to a given product

line. When NULL, provides

results to all product lines.

p_cv_GetPlPrptys Output Yes Result set





REF CURSOR

Result set


Description/Comment

PRDLIN_ID

NUMBER(9,0)

Number Unique Product Line Identifier (not

visible in the UI)

PLNAME

VARCHAR2(255 BYTE)


PLVENDOOR_NAME

VARCHAR2(255 BYTE)


PRPTY_ID

NUMBER(9,0)



PROPERTYNAME

VARCHAR2(255 BYTE)


the UI)

REQUIREDFORINITIAL

NUMBER(1,0)

Number Decode:

0 – Not required for basic trouble

shooting

1 – Required for basic trouble

shooting

PROPERTYDESCRIPTION

VARCHAR2(2000 BYTE)

String Property description (Description

in the UI)

PROPERTYDATAID

NUMBER(3,0)


PROPERTYDATATYPE

VARCHAR2(50 BYTE)


REF_DATA_TYPE_T:

1 – STRING

2 – IP




Description/Comment

3 – TEXT

4 – LONG

5 – DOUBLE

6 – FILE

7 – BOOLEAN

8 - BYTE

CATEGORYID

NUMBER(3,0)


CATEGORYNAME

VARCHAR2(50 BYTE)




2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events

OBJECTID

NUMBER(9,0)



OBJECTNAME

VARCHAR2(255 BYTE)

String Object name that encloses above

property

OBJECTDESCRIPTION

VARCHAR2(2000 BYTE)

String Object description that encloses

above property

OBJECTTYPEID

NUMBER(3,0)


OBJECTTYPENAME

VARCHAR2(50 BYTE)


REF_OBJECT_TYPE_T:

1 – Object

2 – Event log

3 – File




Description/Comment

4 – Alarm table

5.17 Get product line’s data units and analysis rules This API retrieves the detailed information on one or multiple product lines, including

all data units and the analysis rules associated with the properties.

Database API procedure name GetPLTree

Description This API retrieves the detailed information related to a specific product line or all

product lines. The information includes all data units and the analysis rules associated

with the properties.

Built-in reports using this API Product Lines Properties

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in




p_ProductLineId

NUMBER(9,0)

Number When defined, limits results to

a given product line. When


product lines.

p_cv_GetARList

REF CURSOR




Result set


Description/Comment

PRDLIN_NAME

VARCHAR2(255 BYTE)

String Product Line name a Device inherits

from (to the right of Product Line in

the UI)

PRDLIN_VENDOR_NAME

VARCHAR2(255 BYTE)

String Product Line vendor a Device

inherits from (to the left of Product Line in the UI)

PRDLIN_VERSION

VARCHAR2(255 BYTE)

String Product Line version (Product Line Version in the Security Center UI,

Version in the VSE UI)

PRDLIN_OID

VARCHAR2(296)

String Product Line OID (Product Line OID

in the UI)

PRDLIN_DESC

VARCHAR2(2000 BYTE)

String Product Line description


PRDLIN_LAST_UPDATE_DATE

DATE

Date Most recent Product Line update

date, adjusted to p_UserId time zone

PRDLIN_ID

NUMBER(9,0)


visible in the UI)

UPDATER_FIRST_NAME

VARCHAR2(255 BYTE)

String Product Line Developer first name


Center UI, First Name in the VSE UI)

UPDATER_LAST_NAME

VARCHAR2(255 BYTE)

String Product Line Developer last name


Center UI, Last Name in the VSE UI)

UPDATER_LOGIN_NAME

NVARCHAR2(300 CHAR)

String Product Line Developer login name

(User Name in the Security Center

UI, Login Name in the VSE UI)




Description/Comment

PRPTY_ID

NUMBER(9,0)



PRPTY_NAME

VARCHAR2(255 BYTE)


the UI)

IS_BASIC

NUMBER(1,0)

Number Decode:

0 – Not required for basic trouble

shooting

1 – Required for basic trouble

shooting

PRPTY_DESC

VARCHAR2(2000 BYTE)

String Property description (Description in

the UI)

DATYP_NAME

VARCHAR2(50 BYTE)

String One value from REF_DATA_TYPE_T:

1 – STRING

2 – IP

3 – TEXT

4 – LONG

5 – DOUBLE

6 – FILE

7 – BOOLEAN

8 – BYTE

CTGRY_NAME

VARCHAR2(50 BYTE)




2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 – Events




Description/Comment

OBJ_ID

NUMBER(9,0)



OBJ_NAME

VARCHAR2(255 BYTE)

String Object name of the ID above

OBJ_SEQ_NO

NUMBER(9,0)

Number Unique Object Identification (not

visible in the UI)

OBJ_DESC

VARCHAR2(2000 BYTE)

String Object description that encloses

above property

OBJ_OBJTYP_CODE

NUMBER(3,0)


OBJTYP_NAME

VARCHAR2(50 BYTE)


REF_OBJECT_TYPE_T:

1 – Object

2 – Event log

3 – File

4 – Alarm table

OBJ_STATUS_CODE

NUMBER(3,0)


OBJ_STATUS_NAME

VARCHAR2(50 BYTE)


REF_STATUS_TYPE_T:

1 – Valid

2 – Invalid

OBJ_PROTOCOL_NAME

VARCHAR2(50 BYTE)


REF_PROTOCOL_TYPE_T:

1 – SNMP

2 – Telnet

3 – Syslog

4 – FTP




Description/Comment

5 - TL1

6 – SNMPTrap

7 – WMI

8 – DBI

9 – Custom

10 – OPC

CORRECTIVE_ACTION_ID

NUMBER(9,0)

String Not in use

CORRECTIVE_ACTION_NAME

VARCHAR2(255 BYTE)

String Not in use

ARULE_ID

NUMBER(9,0)

Number Unique Analysis Rule Identifier (not

visible in the UI)

ARULE_SEVRTYP_CODE

NUMBER(3,0)


SEVRTYP_NAME

VARCHAR2(50 BYTE)



1 – Informational

2 – Warning

3 – Error

4 – Critical

ARULE_DESC

VARCHAR2(2000 BYTE)



ARULE_NAME

VARCHAR2(255 BYTE)


ARULE_CTGRY_NAME

VARCHAR2(255 BYTE)




2 – Inventory




Description/Comment

3 – Configuration

4 – Status

5 – Performance

6 - Events

IS_PROPAGATED

NUMBER(1,0)

Number Decode:

0 – Alarm is not propagated

1 – Alarm is propagated

IS_PAIR_ALARM

NUMBER(1,0)

Number Decode:

0 – Single alarm

1 – Pair alarm

ARTICLE_LINK

VARCHAR2(255 BYTE)

String Hyperlink to external article

USER_DATA

VARCHAR2(255 BYTE)

String Free text by User (User Data in

Analysis Rule GUI)

ARULE_GRID_CELL

VARCHAR2(255 BYTE)

String Grid coordinates to high light when

Alarm is Set

PROBLEM_DESC

VARCHAR2(2000 BYTE)

String Free text describing problem cause

PROBLEM_RESOLUTION_DES

C

VARCHAR2(2000 BYTE)

String Free text describing problem

resolution

ALRM_SET_COND_CODE

NUMBER(3,0)


SET_CORRELATION_COND_NA

ME

VARCHAR2(50 BYTE)


REF_ALARM_CORRELATION_TYPET

:

1 – In a row

2 – In a time frame




Description/Comment

ALRM_CLEAR_COND_CODE

NUMBER(3,0)


CLEAR_CORRELATION_COND_

NAME

VARCHAR2(50 BYTE)


REF_ALARM_CORRELATION_TYPE_

T:

1 – In a row

2 – In a time frame

ALRM_SET_COND_VALUE1

VARCHAR2(255 BYTE)

String ”From” value in Analysis Rule GUI

ALRM_SET_COND_VALUE2

VARCHAR2(255 BYTE)

String Not in use

ALRM_SET_IS_SEND_SNMPTRA

P

NUMBER(1,0)

Number Decode:

0 – Send SNMPTrap on Alarm Set

1 – Do not send SNMPTrap on Alarm

Set

ALRM_CLEAR_IS_SEND_SNMP

TRAP

NUMBER(1,0)

Number Decode:

0 – Send SNMPTrap on Alarm Clear

1 – Do not send SNMPTrap on Alarm

Clear

ALRM_SET_COLPRF_ID

NUMBER(9,0)

Number Collection Profile Identified to

execute on Alarm Set

ALRM_SET_COLPRF_NAME

VARCHAR2(255 BYTE)

String Collection Profile name to execute

on Alarm Set

ALRM_SET_COLPRF_TYPE

VARCHAR2(255 BYTE)


REF_PROFILE_TYPE_T:

1 – Monitoring Profile

2 – Diagnose Routine

3 – Corrective Action




Description/Comment

ALRM_CLEAR_COLPRF_ID

NUMBER(9,0)

Number Collection Profile Identified to

execute on Alarm Clear

ALRM_CLEAR_COLPRF_NAME

VARCHAR2(255 BYTE)

String Collection Profile name to execute

on Alarm Clear

ALRM_CLEAR_COLPRF_TYPE

VARCHAR2(255 BYTE)


REF_PROFILE_TYPE_T:




ALRM_SET_IS_NOTIFY_BY_MAI

L

NUMBER(1,0)

Number Decode:

0 – Do not notify

1 – Do notify

ALRM_CLEAR_IS_NOTIFY_BY_

MAIL

NUMBER(1,0)

Number Decode:

0 – Do not notify

1 – Do notify

ALRM_SET_OID

NUMBER(9,0)

Number Decode:

0 – Do not send SNMPTrap

1 – Do send SNMPTrap

ALRM_CLEAR_OID

NUMBER(9,0)

Number SNMPTrap OID to execute on Alarm

Clear

ARULE_OPERAND_CODE

NUMBER(3,0)


OPRTYP_NAME

VARCHAR2(50 BYTE)


REF_OPERAND_TYPE_T:

1 – Value

2 – Rate/[minute]

3 – Rate/[hour]

4 – Rate/[day]




Description/Comment

5 – Delta (absolute)

6 – Delta (in percent)

ARULE_COND_CODE

NUMBER(3,0)


CONDTYP_NAME

VARCHAR2(50 BYTE)


REF_CONDITION_TYPE_T:

1 – Contains

2 – Is equal to

3 – Is not equal to

4 – Is between

5 – Is not between

6 – Is less than

7 – Is less than or equal to

8 – Is greater than

9 – Is greater than or equal to

10 – Does not contain

11 – Matches Regular Expression

12 – Does not match Regular

Expression

ARULE_FIRST_VALUE

VARCHAR2(255 BYTE)

String Value to compare with and From

portion of From-To range

IS_ARULE_FIRST_VALUE_LAST

NUMBER(1,0)

Number Decode:

0 – Regular value

1 – Last value

ARULE_SECOND_VALUE

VARCHAR2(255 BYTE)

String To portion of From-To range

IS_ARULE_SECOND_VALUE_LA

ST

NUMBER(1,0)

Number Always 0 (zero)



5.18 Get product line’s execution profiles This API retrieves a list of all execution profiles for a specific product line or all product

lines.

Database API procedure name GetPLExecutionProfilesDetails

Description This API retrieves a list of all execution profiles for a specific product line or all product

lines. The result set is not ordered.

Built-in reports using this API Product Line Execution Profiles

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in




p_ProductLineId

NUMBER(9,0)

Number When defined, limits results to



product lines.

p_cv_GetProfilesList

REF CURSOR


Result set


PRDLIN_ID

NUMBER(9,0)



PRDLIN_NAME String Product Line name (Product




VARCHAR2(255 BYTE) Line Name in the UI)

PRDLIN_VENDOR_NAME

VARCHAR2(255 BYTE)


PRDLIN_VERSION

VARCHAR2(255 BYTE)

String Product Line version (Product Line Version in the Security

Center UI, Version in the VSE

UI)

PRDLIN_OID

VARCHAR2(296)

String Product Line OID (Product Line OID in the UI)

PRDLIN_DESC

VARCHAR2(2000 BYTE)

String Product Line description


UPDATE_DATE

VARCHAR2(17 CHAR)

String ‘YYYYMMDD HH24:MI:SS’

most recent Product Line

update date, adjusted to


COLPRF_ID

NUMBER(9,0)

Number Collection Profile Identifier

COLPRF_NAME

VARCHAR2(255 BYTE)

String Collection Profile name

COLPRF_TYP_CODE

NUMBER(3,0)


below

PRFTYP_NAME

VARCHAR2(255 BYTE)


REF_PROFILE_TYPE_T:




COLPRF_DESC

VARCHAR2(2000 BYTE)

String Collection Profile description





IS_AUTO_SEND

NUMBER(1,0)

Number Decode:

0 – Do not automatically send

1 – Do automatically send

(Send collected date to Security Center automatically in the UI)

IS_ACTIVATION_TO_ALL_DEVICES

NUMBER(1,0)

Number Decode:

0 – Do not automatically

activate

1 – Do automatically active

(Automatic activation on all Devices in the UI)

IS_FIX

NUMBER(1,0)

Number Decode:

0 – Not a fix

1 – Is a fix

(Fix in the UI)

IS_SELF_HEAL

NUMBER(1,0)

Number Decode:

0 – Not a self-heal

1 – Is a self-heal

(Self heal in the UI)

IS_PREVENTIVE_MAINTENANCE

NUMBER(1,0)

Number Decode:

0 – Not a preventive

maintenance

1 – Is a preventive

maintenance

(Preventive maintenance in

the UI)

COLPRF_EXECTYP_CODE

NUMBER(3,0)


below




EXECTYP_NAME

VARCHAR2(50 BYTE)


REF_EXECUTION_TYPE_T:

1 – Once

2 – Triggered

3 – Periodic

4 – Daily schedule

5 – Once partial

6 – On OPC notification

COLPRF_INTERVAL_IN_MIN

NUMBER(9,0)

Number Interval in minutes between

consecutive Collection Profile

runs (Collect Every in the

Security Center UI, Execution Type in the VSE UI)

COLPRF_REPETITIONS_NO

NUMBER(9,0)

Number Total number of consecutive

Collection Profile runs, -1 for

indefinitely (Number of Collections in the Security

Center UI, Execution Type in

the VSE UI)

COLPRF_STRT_HOUR

NUMBER(9,0)

Number Collection Profile start hour-

minute (Start at in the

Security Center UI, Collection Type in the VSE UI)

COLPRF_END_HOUR

NUMBER(9,0)

Number Collection Profile finish hour-

minute (End at in the Security

Center UI, Collection Type in

the VSE UI)

COLPRF_DAYS

NUMBER(9,0)

Number Number whose digits

represent days Collection

Profile runs (Collect on in the

Security Center UI, Collection Type in the VSE UI)




OBJ_NAME

VARCHAR2(255 BYTE)

String Object name

OBJ_SEQ_NO

NUMBER(9,0)

Number Unique Object Identifier of

line above (not visible in the

UI)

OBJ_OBJTYP_CODE

NUMBER(3,0)


below

OBJTYP_NAME

VARCHAR2(50 BYTE)


REF_OBJECT_TYPE_T:

1 – Object

2 – Event log

3 – File

4 – Alarm table

OBJ_STATUS_CODE

NUMBER(3,0)


below

OBJ_STATUS_NAME

VARCHAR2(50 BYTE)


REF_STATUS_TYPE_T:

1 – Valid

2 – Invalid

OBJ_PRTCL_CODE

NUMBER(3,0)


below

OBJ_PROTOCOL_NAME

VARCHAR2(50 BYTE)


REF_PROTOCOL_TYPE_T:

1 – SNMP

2 – Telnet

3 – Syslog

4 – FTP

5 - TL1

6 – SNMPTrap

7 – WMI




8 – DBI

9 – Custom

10 – OPC

PRPTY_NAME

VARCHAR2(255 BYTE)


CTGRY_NAME

VARCHAR2(50 BYTE)




2 – Inventory

3 – Configuration

4 – Status

5 – Performance

6 - Events

DATYP_NAME

VARCHAR2(50 BYTE)


REF_DATA_TYPE_T:

1 – STRING

2 – IP

3 – TEXT

4 – LONG

5 – DOUBLE

6 – FILE

7 – BOOLEAN

8 - BYTE

MONITOR_PRF_ID

NUMBER(9,0)

Number Unique Monitoring Profile

(Collection Profile) Identifier


MONITOR_PRF_NAME

VARCHAR2(255 BYTE)

String Monitoring Profile (Collection

Profile) name (Name in the





DIAGNOSTIC_PRF_ID

NUMBER(9,0)

Number Unique Diagnose Routine



DIAGNOSTIC_PRF_NAME

VARCHAR2(255 BYTE)

String Diagnose Routine (Collection



CORRECTIVE_PRF_ID

NUMBER(9,0)

Number Unique Corrective Action



CORRECTIVE_PRF_NAME

VARCHAR2(255 BYTE)

String Corrective Action (Collection



5.19 Get device alarm statistics This API retrieves a list of alarms for a device aggregated by severity.

Database API procedure name GetDeviceAlarmStatistics

Description This API retrieves a list of alarms for a device aggregated by severity. Devices are

retrieved by their product line, or all devices if the product line is NULL.


Parameters


Parameter Type

Mandatory?

Description

p_UserId

NUMBER(9,0)

Number Yes User ID that runs the API as appears in



permissions




Parameter Type

Mandatory?

Description

p_ProductLineId

NUMBER(9,0)

Number No Unique Product Line ID as appears in

APP_PRODUCT_LINE_INFO_T.PRDLIN_I

D

p_FromDate

VARCHAR2(18

CHAR)


Center time zone

p_ToDate

VARCHAR2(18

CHAR)


Center time zone

p_DeviceModelId

NUMBER(9,0)

Number No Unique Model ID as appears in

APP_MODEL_INFO_T.MDL_ID

p_DeviceVersionI

d

NUMBER(9,0)

Number No Unique Version ID as appears in

APP_SWVERSION_INFO_T.SWVER_ID

p_cv_AuditLogLis

t

REF CURSOR


Result set


Description/Comment

FIRST_LEVEL_GRP_ID

NUMBER(9,0)

Number Unique Group Identifier of line below


FIRST_GRP_NAME

VARCHAR2(255 BYTE)


Management Tree

SECOND_GRP_ID

NUMBER(9,0)



SECOND_GRP_NAME String Second level group name of Site

Management Tree




Description/Comment

VARCHAR2(255 BYTE)

THIRD_GRP_ID

NUMBER(9,0)



THIRD_GRP_NAME

VARCHAR2(255 BYTE)


Management Tree

SITE_ORIGINATOR_ID

NUMBER(9,0)

Number Unique Server ID that collected the

Alarms

SRV_ID

NUMBER(9,0)

Number Unique Server Identified of line below


SRV_NAME

VARCHAR2(255 BYTE)


the UI)

DEVICE_ID

NUMBER(9,0)

Number Unique Device Identified of line below


DEVICE_NAME

VARCHAR2(255 BYTE)


PRDLIN_ID

NUMBER(9,0)


visible in the UI)

PRDLIN_VENDOR_NAME

VARCHAR2(255 BYTE)

String Product Line vendor (Product Vendor

in the UI)

PRDLIN_NAME

VARCHAR2(255 BYTE)


MODEL_ID

NUMBER(9,0)

Number Unique Model ID as appears in

APP_MODEL_INFO_T.MDL_ID

DEVICE_MODEL

VARCHAR2(255 BYTE)

String Unique Model name as appears in

APP_MODEL_INFO_T. MDL_NAME




Description/Comment

VERSION_ID

NUMBER(9,0)

Number Unique Version ID as appears in

APP_SWVERSION_INFO_T. SWVER_ID

DEVICE_VERSION

VARCHAR2(

String Unique Version name as appears in

APP_SWVERSION_INFO_T.

SWVER_NAME

DEVICE_SWVER_ID

Number(9,0)

Number Unique Version ID as appears in

APP_SWVERSION_INFO_T. SWVER_ID

CREATION_DATE

DATE

Date

DELETION_DATE

DATE

Date

IS_DELETED

NUMBER(1,0)

Number Is this a deleted Device:

0 – No

1 – Yes

SEVERITY_STAT_PART_NO

NUMBER(9,0)

Number The partition ordinal number where

Alarms collected from

INFO_CNTR

NUMBER(9,0)

Number Sum of all Info Alarms

WARNING_CNTR

NUMBER(9,0)

Number Sum of all Warning Alarms

ERROR_CNTR

NUMBER(9,0)

Number Sum of all Error Alarms

CRITICAL_CNTR

NUMBER(9,0)

Number Sum of all Critical Alarms

UPDATE_DATE

DATE

Date



5.20 Get Security Center Audit Log This API retrieves a list of Audit Log system alarms for a specified period and alarm

category.

Database API procedure name GetAuditLog

Description This API retrieves a list of Audit Log system alarms for a specified period of time and

alarm Category (optional – Communication, Security or User Action).

Built-in reports using this API Audit Log

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in



permissions

p_FromDate

VARCHAR2(18

CHAR)



p_ToDate

VARCHAR2(18

CHAR)



p_CategoryName

VARCHAR2(255

BYTE)

String No When defined can also use wild


Categories

p_cv_AuditLogList

REF CURSOR




Result set


Description/Comment

EVNT_ID

NUMBER(9,0)

Number Unique Server Identifier for the

audit log entry

ALRM_TYP_ID

NUMBER(9,0)

Number Unique Server Identified for every

system alarms type (visible in the

Security Center UI as the Event ID column in the Audit Log table)

EVNT_CATGRY_CODE

NUMBER(3,0)


below

ENTRY_CTGRY_NAME

VARCHAR2(50 BYTE)

String One value from:

2 – Communication

3 – Security

6 – User Action

EVNT_SEVRTYP_CODE

NUMBER(3,0)


below

SEVRTYP_NAME

VARCHAR2(50 BYTE)


1 – Informational

2 – Warning

3 – Error

4 – Critical

EVNT_DESC

VARCHAR2(2000 BYTE)

String System Alarm auto generated

description

USER_NAME

VARCHAR2(511 BYTE)

String User generating the event (can

be NULL)

EVNT_DETECTION_USER_DATE

VARCHAR2(17 BYTE)

String Event detection date time

adjusted to p_UserId time zone



5.21 Get Security Center Operational Log This API retrieves a list of Operational Log system alarms for a specified period and

alarm category.

Database API procedure name GetOperationalLog

Description This API retrieves a list of Operational Log system alarms for a specified period and

alarm Category (optional – Activity, Communication, Security, Site Message, System,

or User Action).

Built-in reports using this API Operational Log

Parameters



p_UserId

NUMBER(9,0)


appears in




p_FromDate

VARCHAR2(18 CHAR)

String Yes ‘YYYYMMDD HH24:MI:SS’

per Security Center time

zone

p_ToDate

VARCHAR2(18 CHAR)

String Yes ‘YYYYMMDD HH24:MI:SS’

per Security Center time

zone

p_CategoryName

VARCHAR2(255 BYTE)

String No When defined can also use


applies to all Categories

p_cv_OpeartionalLogList

REF CURSOR




Result set

Column Name and Format

Column Type Description/Comment

ALRM_ID

NUMBER(9,0)

Number Unique Server Identifier

ALRM_TYP_ID

NUMBER(9,0)

Number Unique Server Identifier for every

system alarm type (visible in the

Security Center UI as the Event ID

column in the Operational Log table)

ALRM_CATGRY_CODE

NUMBER(3,0)


ENTRY_CTGRY_NAME

VARCHAR2(50 BYTE)


1 – System

2 – Communication

3 – Security

4 – Activity

5 – Site Message

6 – User Action

ALRM_SEVRTYP_CODE

NUMBER(3,0)


SEVRTYP_NAME

VARCHAR2(50 BYTE)


1 – Informational

2 – Warning

3 – Error

4 – Critical

ALRM_IS_CLEARED

NUMBER(1,0)

Number Indicates if the alarm was cleared,

values can be:

0 – false

1 – true

ALRM_DESC String The system alarm auto generated





VARCHAR2(2000 BYTE) description

ALRM_DETECTION_USE

R_DATE

VARCHAR2(17 BYTE)

DATE Event detection date time adjusted to

p_UserId time zone

5.22 Get device properties This API retrieves a list of device properties for a specified site/device/product

line/property

Database API procedure name GetDeviceProperties

Description This API retrieves a list of device properties for a specified site, device, product line or

property


Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number No When defined limits results to

given Site. When NULL

provides results to all Sites

p_DeviceName

VARCHAR2(255

BYTE)







Parameter Type


p_ProductLineId

NUMBER(9,0)

Number No When defined, limits results to



product lines.

p_PrptyName

VARCHAR2(255

BYTE)



applies to all Properties

p_cv_DeviceDetails

REF CURSOR


Result set



VARCHAR2(255 BYTE)


Management Tree


VARCHAR2(255 BYTE)


Management Tree


VARCHAR2(255 BYTE)


Management Tree

SRV_ID

NUMBER(9,0)

Number Unique Server Identifier of line





SRV_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name in the Security Center UI)

DEVICE_ID

NUMBER(9,0)






DEVICE_NAME

VARCHAR2(255 BYTE)


the UI)

PROPERTY_ID

NUMBER(9,0)

Number Unique Device property Identifier

of line below (not visible in the UI)

as defined in

DAT_DEVICE_PROPERTY_DEF_T.

PROPERTY_ID

PROPERTY_NAME

VARCHAR2(255 BYTE)

String Device property name as defined

in

DAT_DEVICE_PROPERTY_DEF_T.

PROPERTY_NAME

MANDATORY

NUMBER(1,0)

Number Indicates if the device property is

mandatory, values can be:

0 – false

1 – true

EDITABLE

NUMBER(1,0)

Number Indicates if the device property

can be modified, values can be:

0 – false

1 – true

HIDDEN

NUMBER(1,0)

Number Indicates if the device property is

hidden, values can be:

0 – false

1 – true

PROPERTY_VALUE

VARCHAR2(4000 BYTE)

String The device property actual value.



5.23 Get device indexes This API retrieves a list of devices and associated indexes for a given site, or all sites.

Database API procedure name GetDeviceIndexes

Description This API retrieves a list of devices and associated indexes for a given site, or all sites.

Built-in reports using this API Get Device Indexes

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number Yes Unique Server Identified of line


p_FromDate

VARCHAR2(18

BYTE)



p_ToDate

VARCHAR2(18

BYTE)



p_cv_Allindexes

REF CURSOR




Result set



SITE_SERVER_ID

NUMBER(9,0)

Number Unique Site Identifier of line below

(visible in the Security Center UI as a

tooltip when hovering over a VSE. Visible

in the VSE UI in Registration Information tab)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name in the

UI)

DEVICE_ID

NUMBER(9,0)

Number Unique Device Identified of line below


DEVICE_NAME

NVARCHAR2(255 CHAR)


DEVICE_IP

VARCHAR2(255 BYTE)

String Device IP Address (Device Address in

the UI)

INDEX_VALUE

VARCHAR2(2568 BYTE)

String Index on which data was collected

5.24 Get latest software distribution activities (new) This API retrieves a list of software distribution packages (SDPs) that run on selected

sites or a single site.

Database API procedure name GetLatestSftwDistActivities

Description This API retrieves a list of software distribution packages (SDPs) that run on a site, all

sites, or a list of sites that a given SDP runs on.




Parameters



p_UserId

NUMBER(9,0)


appears in




p_SiteId

NUMBER(9,0)

Number Unique Server Identified of

line below (not visible in the

UI)

p_FromDate

VARCHAR2(18 BYTE)



p_ToDate

VARCHAR2(18 BYTE)



p_SftDstName

VARCHAR2(255

BYTE)

String The name of the distribution

package. When NULL, applies

to all distributed package file

names.

p_IncludeAll

NUMBER(9,0)

Number 1 – Return all Sites

0 – Return only Sites SDP had

run on

p_cv_GetSftwDisList

REF CURSOR


Result set


Description/Comment

SITE_SERVER_ID

NUMBER(9,0)

Number Unique Site Identifier of line below

(visible in the Security Center UI

as a tooltip when hovering over a

VSE. Visible in the VSE UI in




Description/Comment

Registration Information tab)

SITE_SERVER_NAME

VARCHAR2(255 BYTE)

String Site Server, VSE, name (Site Name

in the UI)

FIRST_LEVEL_GRP_ID

NUMBER(9,0)

Number First level group id of Site

Management Tree


VARCHAR2(255 BYTE)


Management Tree

SECOND_LEVEL_GRP_ID

NUMBER(9,0)

Number Second level group id of Site

Management Tree


VARCHAR2(255 BYTE)


Management Tree

THIRD_LEVEL_GRP_ID

NUMBER(9,0)

Number Third level group id of Site

Management Tree


VARCHAR2(255 BYTE)


Management Tree

IS_SITE_UP

NUMBER(9,0)

Number One value of:

1 – Up

2 – Down

SEVERITY

NUMBER(9,0)

Number SDP run returned severity in range

from 0 to 5

SEVERITY_NAME

VARCHAR2(50 BYTE)

String Decoded severity above from

REF_DATA_SEVERITY_TYPE_T:

0 – OK

1 – Informational

2 – Warning

3 – Error

4 – Critical




Description/Comment

RESULT_CODE

NUMBER(9,0)

Number SDP execution result on a Site:

0 – Successfully completed

Other – message appear below

RESULT_MSG

VARCHAR2(2000 BYTE)

String SDP execution result text

message

USR_CREATION_DATE

VARCHAR2(17 BYTE)

String ‘YYYYMMDD HH24:MI:SS’ SDP

request created to run on a Site

CREATED_BY

VARCHAR2(511 BYTE)

String User’s first and last name who

submitted SDP request to run on

a Site

5.25 Acknowledge alarms Acknowledges an alarm according to parameters.

Database API procedure name AckAlarm

Description Acknowledges an alarm according to parameters. The user’s permissions are not

validated. The user ID is used for logging the user that performed the

acknowledgement action.

Built-in reports using this API Not applicable; used for integration with third-party applications

Parameters


Parameter Type


p_UserId

NUMBER(9,0)


appears in


ID governs viewing and querying

permissions




Parameter Type


p_AlarmId

NUMBER(9,0)

Number Yes Unique Alarm Identifier to query

p_AlarmPartNo

NUMBER(9,0)

Number Day of the year, per Security

Center5 time zone, to query

p_AlarmAckStatus

NUMBER(1,0)

Number Acknowledge Status as appears

in REF_ALARM_ACK_TYPE_T:


1 – Assigned

2 – Closed

p_AlarmAckDesc

VARCHAR2(2000

BYTE)

String Alarm Acknowledge text to add

to Alarm in query

p_AlarmAckCase

VARCHAR2(255

BYTE)

String Case number to add to Alarm in

query

p_ResCode

NUMBER(1,0)

Output Yes Code as defined in

PA_GLOBALDEF

p_ResMsg

VARCHAR2(4 CHAR)

Output Yes Text as defined in

PA_GLOBALDEF

Result set Not applicable; this DB-API updates NSA database.

5.26 Get Users’ Information This API retrieves a list of the Security Center users that the invoking user has

permission to view.

5 To find relevant partition number: EXEC F_CURR_PART_NO(“YYYY-MM-DD);”



Database API procedure name GetUsersInfo

Description This API retrieves a list of the Security Center users that the invoking user has

permission to view. The information includes each user’s system, access, and product

line permissions.

Built-in reports using this API Users Info

Parameters


Parameter Type


p_UserId

NUMBER(9,0)

Number Yes User ID that runs the API as it

appears in




p_cv_UsersDetails

REF CURSOR


Result set


USR_ID

NUMBER(9)

Number The user’s internal ID (not visible in

the UI)

USR_FIRST_NAME

VARCHAR2(255)

String The user’s first name

USR_LAST_NAME

VARCHAR2(255)

String The user’s last name

USR_LOGIN

VARCHAR2(300)

String The user’s login name

CREATION_DATE Date The date and time (Security Center




DATE time) when the user was created

USR_LAST_LOGIN_DATE

DATE

Date The most recent date and time

when the user logged into the

Security Center

SYSTEM_ROLES

VARCHAR2(4000)

String The system-level roles

(permissions) assigned to the user;

names of roles are separated by a

comma.

ACCESS_ROLES

VARCHAR2(4000)

String The access (entity-level) roles

assigned to the user; names of roles

are separated by a comma.

PRODUCT_LINE_ROLES

VARCHAR2(4000)

String The product-line permissions

assigned to the user; names of roles

are separated by a comma.

USING WILDCARDS


6. Using Wildcards

Leading and/or trailing asterisk may be added to the property name, which is not case

sensitive.

Examples:

• 'Status' searches for an exact 'Status' value

• '*Status' searches for values ending with 'Status', and may return: 'Status', 'CPU

Status', 'Memory Status'

• 'Status*' searches for values beginning with 'Status', and may return 'Status',

'Status1'. It will not return 'CPU Status'

• '*Status*' searches for value containing word ‘Status’, and will return all the

variations described above.

DATABASE API NAMES FOR BUILT-IN REPORTS


7. Database API names for built-in reports

In the table below:

• The left column provides the name of the report and the section where it appears in

the Reports page.

• The right column lists the database API name used by the report displayed on the

same row in the other column.

Section/Report Name Database API Name

Health Check / Site Alarms Monthly Statistics GetAlarmList

Health Check / Site Alarms Weekly Statistics GetAlarmList

Health Check / World Alarms Monthly Statistics GetAlarmList

Health Check / World Alarms Weekly Statistics GetAlarmList

Health Check / World Health Monthly Summary GetAlarmList

Health Check / World Health Weekly Summary GetAlarmList

Health Check / Diagnose Results GetDiagnoseActivityData

Health Check / Sites Summary GetSitesInfo

Health Check / Alarm History GetAlarmListDetailed

Health Check / Alarms Global Weekly Summary GetSitesInfo

Health Check / Product Line Data Units GetPLTree

Health Check / Product Lines Analysis Rules GetPLAlarms

Health Check / Product Lines Execution

Profiles

GetPLExecutionProfilesDetails

Health Check / Product Lines Properties GetPLProperties

System / Data Collection Statistics GetDeviceMonitoringStatistics

System / Users Info GetUsersInfo

Inventory / Devices Inventory GetSitesInfo

Custom / Devices Data GetInstallBaseInfo

DATABASE API NAMES FOR BUILT-IN REPORTS


Section/Report Name Database API Name

Performance / Data Over Time GetExtendedCollectedData

Health Check / Site Alarms Monthly Statistics GetAlarmList

DATABASE API DEPENDENCIES

8. Database API dependencies

DocID CS-ICSE800en-500A 121


Documents

Security Center Database API Reference Guide...DocID CS-ICSW800en-510B 3 About this Guide This document is an API guide for the ICS Shield Security Center database. Scope This guide