Develop Section
Develop Section
AI Operations Management -
Containerized
Version : 24.4
Table of Contents
1. Develop 71
1.1.2.2.2. Examples 87
1.1.2.4.1. Forward events and event changes from OPR client 100
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 2
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 3
AI Operations Management - Containerized 24.4
1.1.4.1.9. Write to log files from the Rules API code 206
1.1.4.1.12. Example - Average Performance Rule Using a Rule Parameter Filter 211
1.1.4.1.13.4. Example - Sibling Rule Based on Availability and Performance KPIs 217
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 4
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 5
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 6
AI Operations Management - Containerized 24.4
Mapping Cache
1.1.5.2.2.7. Examples 348
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 7
AI Operations Management - Containerized 24.4
1.1.5.2.3.5. Step By Step: How to Retrieve CIs Using REST API 373
1.3.1.1. Custom metric ingestion using CMI tools and Agent Metric Collector 402
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 8
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 9
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 10
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 11
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 12
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 13
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 14
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 15
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 16
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 17
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 18
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 19
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 20
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 21
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 22
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 23
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 24
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 25
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 26
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 27
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 28
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 29
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 30
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 31
AI Operations Management - Containerized 24.4
1.4.2.12.53. 1624
opsb_cassandra_threadpools_internal_memtable_reclaim_memory_1d
1.4.2.12.54. 1625
opsb_cassandra_threadpools_internal_memtable_reclaim_memory_1h
1.4.2.13. Management Pack for SAP HANA 1626
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 32
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 33
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 34
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 35
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 36
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 37
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 38
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 39
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 40
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 41
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 42
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 43
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 44
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 45
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 46
AI Operations Management - Containerized 24.4
1.4.13.1. Mapping actual metric names with column names in the schema table 2489
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 47
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 48
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 49
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 50
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 51
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 52
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 53
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 54
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 55
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 56
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 57
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 58
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 59
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 60
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 61
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 62
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 63
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 64
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 65
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 66
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 67
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 68
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 69
AI Operations Management - Containerized 24.4
1.5.6. Develop reports for Operations Bridge Integration Hub content 5874
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 70
AI Operations Management - Containerized 24.4
1. Develop
Read the following sections to know how you can customize content in the application, extend its functionality, and use APIs to perform
different operations across capabilities:
Develop OBM
Develop Stakeholder Dashboards and reports
Custom data integration
Data Model
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 71
AI Operations Management - Containerized 24.4
The topic Web Service Interfaces describes several web services that allow integrators to automate OBM functions.
The topic Groovy scripts describes how Groovy scripts are developed and deployed to implement customizations.
The topic Service Health describes Service Health rules APIs and Service Health external APIs.
The topic RTSM Developer Reference describes how to create discovery and integration adapters and using APIs.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 72
AI Operations Management - Containerized 24.4
You should be familiar with the relevant products and components, including the associated documentation. As an example, the
following list includes the essential steps required to extend the integration between OM:
Run-Time Service Model (RTSM). Detailed administrative and operational knowledge is assumed. For details about RTSM
concepts, including CI types, CI attributes, and views, see the RTSM Modeling topic. For details on importing data from Excel
Workbooks and other external sources, see the UCMDB Help.
Operations Manager (OM) for Windows and UNIX. In particular, take a look at the Service Tree in OM, and decide which
services should be synchronized with the RTSM.
Note: Services that are used only to build up the parents of a tree (for example, Applications, and Systems Infrastructure)
probably do not need to be synchronized, because the RTSM uses graphs and does not require a tree structure.
Operations Bridge Manager (OBM). For example, the following steps must be executed in OBM:
1. Using the OM service tree as a reference, mark the services that you want to synchronize with a Context in the contextm
apping.xml file.
2. Choose the CI type for each OM service. Enter the mapping from an OM service to a CI type in the typemapping.xml file.
3. Make sure that all required CI Attributes (key attributes) are filled from OM service attributes in the attributemapping.xml
file.
4. Create all relationships in accordance with the RTSM model in the relationmapping.xml file.
Note: Some CI types (for example, Running Software) have keys that consist of simple CI attributes and relations. For these
CI types, the attributemapping.xml must set all key attributes and the relationmapping.xml must create the correct relations, to
instantiate the CI correctly.
You can refer to the standard topology synchronization packages, such as default , operations-agent and nodegroups , as
examples of how to work with synchronization packages. You can find these under:
Knowledge of Groovy scripting and syntax is required for creating Groovy scripts. Groovy is supported for scripting, and Groovy
scripts are used in the topology synchronization process, for Event Processing Interface (EPI) and custom action scripts, for
automating operator functions, and for integrating external event processes.
Knowledge of the XPath query language is required to navigate through the CI data structure in the mapping engines.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 73
AI Operations Management - Containerized 24.4
The section details several general aspects that need to be observed when using any of the web services. The remainder of the section
comprises one section for each available web service with reference information and examples.
To view the API content on the Developer Central page, choose your values from the drop-down for the following attributes:
Product Name
Product Version
Service Name
Service Version
All fields are mandatory. After all the values are chosen, you will see the respective API documentation.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 74
AI Operations Management - Containerized 24.4
Authentication
Consider the following with regard to authentication and security when using web services:
The following code sample shows a JAVA implementation of basic authentication using a username/password combination:
Example:
import org.apache.commons.codec.binary.Base64;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
/** Create the request URL (assuming the capitalized variables are set to appropriate values). **/
String url = "http://" + WS_SERVER_HOSTNAME + ROOT_PATH + REQUEST;
byte[] encodedUserPassword =
Base64.encodeBase64((username + ":" + password).getBytes());
Response response =
client.target(url).request(MediaType.APPLICATION_XML_TYPE).
header("Authorization", "Basic" +
new String(encodedUserPassword)).get();
Manual entry of user name and password combination valid for logging on to OBM. This method is useful for ad-hoc access to the
web service, for example when using a plug-in such as a Poster.
Light-Weight Single Sign-on (LWSSO)
Windows Authentication (WinAuth)
Common Access Card (CAC)
Error handling
If you implement a web service endpoint that can be directly called by OBM, error handling is as follows:
HTTP status of 2xx returned. The following HTTP status codes indicate a request was processed successfully:
200 (OK)
201 (Created)
202 (Accepted)
HTTP status of 3xx returned. These are redirection status. Redirection is not supported by the service. They are treated the
same as 4xx , therefore the request will be marked as FAILED and no further retries are done.
HTTP status of 4xx returned. Any status of 4xx is considered an error in the client request, therefore the request will be
marked as FAILED and no further retries are done.
HTTP status of 5xx returned. Any status of 5xx is considered an error on the server. In this case, it is expected that the server
will recover at some future time and be able to accept the request. The request will be put back in the queue. Retries are done
once a minute until the request succeeds or the request times out (default is 12 hours and may be changed in the Infrastructure
Settings). New events and updates are forwarded in the order the forward request was received. Should a request fail due to an 5
xx error it will block all other requests for this server. All new events in the queue are delivered before delivering any outstanding
updates.
Any type of IOException encountered while trying to communicate with the server will result in the request being re-queued and
then retried as described for HTTP status of 5xx .
Error verbosity
Web Services return error codes that help administrators identify the cause of possible problems. Administrators can control the types
of error codes returned from the Web Service by changing the level of verbosity in the Infrastructure Settings Manager. The following
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 75
AI Operations Management - Containerized 24.4
Option Description
Verbos
Default. Recommended for development environments. Returns a detailed message describing the reason for the error.
e
Standa Returns to the caller of the web service the appropriate HTTP error code, as listed in the HTTP 1.1 standard, along with a standard error text
rd message describing the error.
Returns only error codes 400 (Bad Request) or 503 (Service Unavailable), depending on the type of the error, and an error identifier. A
Brief
detailed error message may be obtained by locating the identifier and detailed error message in the error logs.
<OMi_HOME>/log/opr-ws-response.log
Protection for modify operations is by default enabled in the Web Service Settings in the Infrastructure Settings Manager. You can
disable the setting for backward compatibility.
1. Obtain the secureModifyToken cookie before executing any modify requests (PUT, POST, or DELETE).
The recommended approach to obtain the secureModifyToken cookie at client startup is to execute an HTTP GET request for the
Web Service Service Document at /opr-web/rest .
After the HTTP GET operation has completed the cookie is set. During the life of the client and the single sign-on session, the value
of the cookie may change. Before each modify operation the HTTP client should get the current value of the cookie from the client.
It is not recommended to save this value in a local variable for later use, as it may change during the life of the HTTP client.
The X-Secure-Modify-Token HTTP header must be set by all Web Service clients when executing modify operations (PUT, POST, or
DELETE). The value to set this HTTP header to is specified in the secureModifyToken cookie.
Note: The client must set all cookies returned by the server in subsequent requests. For example, LWSSO_COOKIE_KEY and JSESSIONID
are additional cookies returned by the server and must be set in subsequent requests to the server. If a new session is established, the
secureModifyToken previously obtained through a GET request becomes invalid. Therefore the other cookies are also required.
The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 76
AI Operations Management - Containerized 24.4
connection.setRequestMethod("GET");
connection.connect();
int response = connection.getResponseCode();
if (response == 200)
{
for (int i=1; (final String headerName = connection.getHeaderFieldKey(i)) != null; i++)
{
if (headerName.equals("Set-Cookie"))
{
final String cookieString = connection.getHeaderField(i);
final List<HttpCookie> cookies = HttpCookie.parse(cookieString);
if (cookies != null && !cookies.isEmpty())
result.addAll(cookies);
}
}
}
return result;
}
The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 77
AI Operations Management - Containerized 24.4
{
int rc = -1;
The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 78
AI Operations Management - Containerized 24.4
The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 79
AI Operations Management - Containerized 24.4
Web service clients that set the X-Secure-Modify-Token HTTP header may fail when communicating with web services installed with the
OBM version 9.0x and lower. You may therefore disable enhanced security protection in the Web Service Settings in the Infrastructure
Settings Manager.
3. Optional. Implement the following additional measures for end users to reduce their exposure to malicious attacks when using
OBM:
Do not allow your web browser to save user names and passwords.
Do not use the same web browser to access OBM and the Internet at the same time (tabbed browsing). While logged in to
OBM, the web browser should not be used to browse other web sites.
HTML-enabled applications that integrate web browsers (for example email or newsreader applications) pose additional risks
because simply viewing an email message or a news message may lead to the execution of an attack. Caution should be
taken when using client workstations connected to OBM and to such applications.
Event Web Service clients must not use these characters in the query parameter section of the URL:
String literals: As the single quotation mark (') may be rejected in environments with CA SiteMinder, surround string literals with
double quotation marks (""). See the topic Value types for more information.
As CA SiteMinder blocks the % encoding, the string literal itself must escape the offending characters using the dollar sign ($)
instead of percent (%), for example:
Operators: As the greater than sign (>) and less than sign (<) may be rejected by the CA SiteMinder agent, use the GT and LT
aliases instead. See the topic Operator aliases for more information.
Session handling
By default, the timeout period of an OBM REST web service session is 30 seconds. You can change the default in the Infrastructure
Settings Manager:
Search for the REST web service Session timeout setting and edit as required.
Alternatively, add the sessionTimeOut property to the HTTP request header, or add the query parameter sessionTimeOut to the HTTP
URL. The sessionTimeOut parameter in the HTTP URL overrides the sessionTimeOut property in the HTTP request header, and both
override the default timeout set in the infrastructure setting.
The timeout period is set when the web service client logs onto OBM for the first time.
Settings
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 80
AI Operations Management - Containerized 24.4
You can define a number of settings for web services in the Infrastructure Settings:
Details about the effect of these settings are provided with each setting in the Infrastructure Settings Manager.
Related topics
URL escape codes
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 81
AI Operations Management - Containerized 24.4
Execute an arbitrary command string on one or more monitored nodes. Requests can be run in parallel.
A command type must be specified. A command can be executable (default), a Perl script, VBScript, JavaScript, or a Windows
Scripting Host script. The script code must be passed in the web service call. For Unix agents, commands are executed in a shell.
For Windows agents, commands aren't executed in a shell. For example, an "echo hello world" command would read echo hello wor
ld on Unix, and cmd /c echo hello world on Windows.
Target hosts can be specified by hostname (from the RTSM) and by IP address.
Requests are dropped when the OBM is disabled or restarted. In some cases, an Action Web Service request won't finish. For
example, if you use the ovc- stop command to stop the action agent process, which sends back a call response, the call will
continue to run until the OBM is disabled or restarted.
On the agents, environment variables such as OvDataDir and OvInstallDir are predefined. For a complete list, you can call the OBM
server using the following command:
Retrieve the command status for the managed nodes. The OBM keeps the execution results for 10 minutes after the last managed
node has finished execution. Web service clients must retrieve the results within that time.
The Action Web Service only triggers command strings entered by the user. In this case, an "action" is an arbitrary string entered by
the web service user, as opposed to a "tool", which is a predefined string stored in the database. The Action Web Service doesn't
trigger automatic actions or user actions.
When using a JAVA client, the classes provided in opr-external-api.jar can be used to marshal or unmarshal the XML content directly. See
also the example code in <OMi_HOME>/opr/examples/action-ws-client
<serviceURL> <server>:<port>/opr-web/rest/<version>
where <server> is the name of the OBM server and <version> is the web service interface version (for example 10.10 ).
<request> The service request. For a complete list and syntax of possible service requests, see the topicAction Web Service request reference.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 82
AI Operations Management - Containerized 24.4
1. Check if the Action Web Service is enabled. By default, the web service is disabled. You can enable it by setting the Allow
command execution through Action Web Service infrastructure setting to true .
Go to Administration > Setup and Maintenance > Infrastructure Settings > Operations Management > Action Web
Service Settings and set the Allow command execution through Action Web Service setting to true .
2. To be able to access the Action Web Service, a user must have a role with the Action Web Service permission. This permission is
available under the Operations Console category in the Permissions section. For more information on permissions, see the
topic Users, Groups, and Roles.
3. The Action Web Service user must specify a valid username and password in the web service.
Error handling
Error handling for the Action web service is as follows:
Individual return codes per requested host (the HTTP code is always 200):
Return code 404: The requested host isn't in the RTSM or the CI doesn't meet the requirements.
Return code 500: communication problem with the host
Return code 0: execution succeeded
Other return codes (for example, 1): error code from the command to executed
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 83
AI Operations Management - Containerized 24.4
Action Service
Request
Request Web Service Action
Type
direct_execution[/{executionContextID
GET Retrieve the command status.
}[/{nodeSpecificResultID}]]
/<executionContextID>/<nodeSpecific
GET is specified: Get the detailed command status for one specific managed node.
ResultID>
is specified, but /<nodeSpecificResultID> is omitted: Get the overview status for all
concerned managed nodes.
/<executionContextID> POST
Note:
/<executionContextID> is required.
/<executionContextID> is required.
XML Structures
For more information on XML structures, see also the OBM public web service schema definitions in <OMi_HOME>/opr/api/schema/OprData
Model.xsd .
The following XML structure examples include comments to help you to tailor them to your specific uses.
POST - https://<server>:<port>/opr-web/rest/10.10/direct_execution
Input:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 84
AI Operations Management - Containerized 24.4
Output:
<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" x
mlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- wrapper element for the execution context-->
<id>
<!-- executionContextID; needed for all later calls-->
<tool_ref>
<!-- only relevant for tool web service, not for action web service-->
<user_parameters/>
<!-- only relevant for tool web service, not for action web service.-->
<tool_execution_result_ref>
<!-- status for a specific managed node-->
<id>
<!-- the <nodeSpecificResultId>; needed when later fetching result details.-->
<execution_host>
<!-- the host the command is running on-->
<tool_command>
<!-- only available for tools of type om_agent_command. command string executed on the host-->
<tool_execution_state>
<!-- can be: pending (not yet started), running, canceling, canceled, failed and finished-->
<!-- finished = successful execution-->
<started>
<!-- start time in long format, like 2015-09-30T13:03:56.980+02:00-->
<started_text>
<!-- start time in shortened human readable format, like 01:03:56 PM-->
<finished>
<!-- end time (if already terminated) in long format, like 2015-09-30T13:03:56.980+02:00-->
<finished_text>
<!-- end time in shortened human readable format, like 01:03:56 PM-->
GET - https://<server>:<port>/opr-web/rest/10.10/direct_execution/<executionContextID>
GET - https://<server>:<port>/opr-web/rest/10.10/direct_execution/<executionContextID>/<nodeSpecificResultId>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 85
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 86
AI Operations Management - Containerized 24.4
1.1.2.2.2. Examples
The following XML examples show you how to perform a sample workflow using the Action Web Service.
Submit a request (command "ovc") on three nodes, poll for the overall
status, retrieve the detailed result as soon as the command has finished
for a host
1. Start the command:
POST – https://<server>:<port>/opr-web/rest/10.10/direct_execution
Output:
<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" x
mlns:xs="http://www.w3.org/2001/XMLSchema">
<id>ec172b83-277e-4853-90fa-ad7f49ad7262</id>
<tool_ref>
<id>79aa0a94-a717-4301-b22d-6c9728d52f93</id>
<target_id>79aa0a94-a717-4301-b22d-6c9728d52f93</target_id>
<label>DirectExecution</label>
<tool_type>om_agent_command</tool_type>
<has_user_parameter>false</has_user_parameter>
<requires_run_as_user>true</requires_run_as_user>
</tool_ref>
<user_parameters/>
<tool_execution_result_ref>
<id>d1714284-5d42-4b45-a95a-ad110555630d</id>
<execution_host>ia2.example.net</execution_host>
<tool_command>ovc</tool_command>
<tool_execution_state>running</tool_execution_state>
<started>2015-09-30T13:03:56.980+02:00</started>
<started_text>01:03:56 PM</started_text>
</tool_execution_result_ref>
<tool_execution_result_ref>
<id>1c4b0db4-2e82-4657-a1c6-ecfa1d2a2e29</id>
<execution_host>asdf</execution_host>
<tool_command>ovc</tool_command>
<tool_execution_state>failed</tool_execution_state>
<started>2015-09-30T13:03:56.378+02:00</started>
<started_text>01:03:56 PM</started_text>
<finished>2015-09-30T13:03:56.397+02:00</finished>
<finished_text>01:03:56 PM</finished_text>
</tool_execution_result_ref>
<tool_execution_result_ref>
<id>3a39dd97-bee1-4acb-a595-18c8b4daeaad</id>
<execution_host>example.example.net</execution_host>
<tool_command>ovc</tool_command>
<tool_execution_state>running</tool_execution_state>
<started>2015-09-30T13:03:56.984+02:00</started>
<started_text>01:03:56 PM</started_text>
</tool_execution_result_ref>
</tool_execution_context>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 87
AI Operations Management - Containerized 24.4
2. Get a status overview for all nodes; use the execution context ID from the previous step.
GET - https://<server>:<port>/opr-web/rest/10.10/direct_execution/ec172b83-277e-4853-90fa-ad7f49ad7262
Check the output (also of type <tool_execution_context>) for terminated commands. Repeat the step until the XML tag
<tool_execution_state> of one or more nodes changes to "finished" or "failed". To get the details, proceed to step 3. Continue
polling the status until the last host is finished.
3. Get the detailed status of one node. Use the execution context ID and appropriate node-specific result ID.
GET - https://<server>:<port>/opr-web/rest/10.10/direct_execution/ec172b83-277e-4853-90fa-ad7f49ad7262/d1714284-5d42-4b45-a95a-ad110
555630d
Output:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 88
AI Operations Management - Containerized 24.4
Logging
All actions taken by the web service are logged in the following log file:
<OBM_HOME>/log/webapps/opr-webapp.log
Debugging
To enable debugging for the action web service, do the following:
1. Go to:
<OBM_HOME>/conf/core/Tools/log4j/webapps/opr-webapp.properties
2. In the opr-webapp.properties file, set the loglevel to the desired value. The debug loglevel ( loglevel=DEBUG ) is useful for finding
problems.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 89
AI Operations Management - Containerized 24.4
To use the Downtime REST API, a user with Full Control permission for Downtime Management under Service Health is needed.
https://<serviceURL>/<request>
CustomerID is always 1.
Request Reference
The downtime REST service supports the following HTTP requests:
CustomerID is always 1.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 90
AI Operations Management - Containerized 24.4
Enforce downtime on Reports and KPI calculations; suppress <action name="ENFORCE_ON_REPORTS"> <propGroup name="SLA" value="SELEC
alerts and close events (continue monitoring), including TED"> <prop>dda3fb0b20c0d83e078035ee1c005201</prop> </propGroup> </acti
specific SLA on>
Note
In Oracle, if you are using East Asian Languages (Chinese, Japanese, or Korean), the maximum number of characters may be less than
specified above.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 91
AI Operations Management - Containerized 24.4
<approver>The approver n
approver Name of the approver of the downtime.
ame</approver>
<notification>
<recipients>
<recipient name="Recipie
nt1"/>
A list of recipients identified by names. You can create the recipients by using the Recipient
modification <recipient name="Recipie
Management page (Administration > Users > Recipient Management).
nt2"/>
...
</recipients>
</notification>
Schedule
Note
For weekly and monthly downtime values, the <startDate> and <endDate> should be defined at midnight.
For downtime that occurs once, the <startTimeInSecs> and <durationInSecs> have no significance.
The <startTimeInSecs> and <durationInSecs> are relative to the specified timezone and not GMT.
The actual start time of downtime is controlled by the <startTimeInSecs> and not by the time in <startDate
>.
The following table describes the types of schedules supported for downtime values. Each schedule has a unique XML structure.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 92
AI Operations Management - Containerized 24.4
<schedule <a
rel="nofollow">xsi:type="OnceScheduleType</a>">
<type>ONCE</type>
The downtime occurs only once on a specified start date and lasts
ONCE <startDate>2018-05-13T14:40:00</startDate>
till a specified end date.
<endDate>2018-05-13T14:45:00</endDate>
<timeZone>Europe/Berlin</timeZone>
</schedule>
<type>MONTHLY</type>
The downtime reoccurs based on monthRecurrence until the
<startDate>2018-06-04T00:00:00</startDate>
specified end date. If no end date is specified, the downtime
<endDate>2019-05-01T11:59:00</endDate>
occurs endlessly. monthRecurrence is a numerical value that
MONTHLY <timeZone>America/Merida</timeZone>
indicates the number of months until the next occurrence. For
(descriptive <dayOfWeek>3</dayOfWeek>
example, if monthRecurrenceSkipping is 1 then the downtime
selection) <weekInMonth>2</weekInMonth>
occurs every month. If monthRecurrenceSkipping is 2 then the
<monthRecurrenceSkipping>1</monthRecurrenceSkipping>
downtime will occur every second month.
<startTimeInSecs>300</startTimeInSecs>
The downtime is active from the sum of the start date time and
<durationInSecs>2100</durationInSecs>
the value of startTimeInSecs to the sum of the start date time,
the value of startTimeInSecs , and the value of durationInSecs . </schedule>
For example, the start date is 2018-06-04T00:00:00 . Therefore
the start date time is 12:00 AM . startTimeInSecs is 300 seconds
and durationInSecs is 2100 seconds. The downtime will be active
from 12:05 AM to 12:40 AM .
<schedule <a
The downtime occurs on a weekly basis starting on the specified
rel="nofollow">xsi:type="WeeklyScheduleType</a>">
start date and the selected weekdays.
The downtime reoccurs based on the following weeks until the <type>WEEKLY</type>
specified end date. If no end date is provided, then the downtime <startDate>2018-05-12T00:00:00</startDate>
occurs endlessly. <timeZone>Europe/Berlin</timeZone>
The downtime is active from (start date time+value of startTimeIn <days>
WEEKLY Secs ) to (start date time+value of <selectedDays>MONDAY</selectedDays>
startTimeInSecs +value of durationInSecs ). <selectedDays>TUESDAY</selectedDays>
For example, the start date is 2018-05-14T00:00:00 . Therefore <selectedDays>WEDNESDAY</selectedDays>
the start date time is 12:00 AM , startTimeInSecs is 600 seconds </days>
and durationInSecs is 300 seconds. The downtime will be active <startTimeInSecs>600</startTimeInSecs>
from 12:10 AM to 12:15 AM . <durationInSecs>300</durationInSecs>
</schedule>
Related topics
Downtime Management
opr-downtime
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 93
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 94
AI Operations Management - Containerized 24.4
When importing definitions from an external source, take into account both the import scope and mechanism.
Import Scope
Downtime properties may be different in different systems and software platforms. The common set of downtime properties includes
scheduling information and configuration items. In OBM downtime, the mandatory fields are:
Downtime Name
CI ID
Schedule
Action
Import Mechanism
Importing downtimes into OBM is performed by an external utility with access to the formats and properties of the external source. This
utility translates the external properties to correlate to the required and optional OBM downtime properties in XML format.
Import Example
The DTImport.zip file includes:
DTImport.jar – Contains Java classes that run the Groovy script and provide script dependencies (mainly the HTTP client that's
used to access the REST services).
DTImport.bat – Runs the Java application and sends the OBM URL and user name and password.
downtimeFiles folder – Contains XML files with the downtime definitions.
DTImport.groovy – Groovy script that reads and posts the XML files to the OBM REST service.
The DTImport.bat file invokes the DTImport Java application with a defined integration folder (system property integ.home). The
application reads all the Groovy scripts in the scripts folder and invokes them. The example DTImport.groovy script reads all the
dt[n].xml files and uses the OBM REST service to create downtime in OBM. You can alter the contents of this file to create your own
custom integrations.
To alter the logic of the utility, edit the Groovy script and run the batch file again. You don't need to build and compile the script.
To change the integration directory, edit integ.home in the batch file.
You can replace the DTImport.groovy script with any other script in the Scripts folder.
Only add Groovy scripts with a main method to the Scripts folder.
Only add well formatted XML files to the downtimeFiles folder.
Use any scheduler (such as Windows Task Scheduler) to run the script.
1. Verify that the Java Runtime environment is installed on the client machine.
2. Extract the DTImport.zip file to the server on which you want to run the integration. This can be the OBM server, the external
source, or any other server.
3. Edit the DTImport.bat file to update the OBM URL and credentials.
4. Edit the XML files in the downtimeFiles folder to update the downtime parameters you want to translate to match your system
definitions.
5. To enter an existing recipient ID:
1. Enter the URL of the JMX console ( https://localhost:29000 ) in a web browser.
2. Enter your user name and password.
3. Retrieve the recipient ID by executing Test Notification Service > showRecipients().
6. To enter existing CI IDs:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 95
AI Operations Management - Containerized 24.4
1. Access the RTSM JMX Console on the data processing server: https://localhost:8443/jmx-console .
2. Enter your user name and password.
3. Retrieve the CIIDs by executing Model Services > retrieveObjectsOfType. For example, if the CI is a Business
application, enter business_application.
7. Run the batch file.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 96
AI Operations Management - Containerized 24.4
any downtime
name== Shows all downtimes that have the specified name.
name
ciId== any CI ID Shows all downtimes that apply to CIs with the specified CI ID.
ciLabel== any CI label Shows all downtimes that apply to CIs with the specified CI label.
any global CI Only applies if CIs have global CI IDs. Shows all downtimes that apply to CIs
ciGlobalId==
ID with the specified global CI ID.
Shows all downtimes that have expired (true) or are either currently active
expired== true | false
or will expire in future (false).
Shows all downtimes that are currently active (true), or are either expired or
active== true | false
will be active in future (false).
Examples
Example 1: Show downtimes that apply to a CI with id 4b7822966d6f93b59e691689a1e355cb
topaz/bsmservices/customers/1/downtimes?filter=ciId==4b7822966d6f93b59e691689a1e355cb
Example 2: Show downtimes that apply to a CI with id 4b7822966d6f93b59e691689a1e355cb and which are currently active
topaz/bsmservices/customers/1/downtimes?filter=ciId==4b7822966d6f93b59e691689a1e355cb&filter=active==true
Example 3: Show all downtimes that will be active in the future
topaz/bsmservices/customers/1/downtimes?filter=expired==false&filter=active==false
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 97
AI Operations Management - Containerized 24.4
Logging
All actions taken by the web service are logged in the following log file:
<OBM_HOME>/log/webapps/downtime.log
Debugging
To enable debugging for the downtime web service, do the following:
1. Go to:
<OBM_HOME>/conf/core/Tools/log4j/webapps/downtime.properties
2. In the downtime.properties file, set the loglevel to the desired value. The debug loglevel ( loglevel=DEBUG ) is useful for finding
problems.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 98
AI Operations Management - Containerized 24.4
An external event process may integrate directly with OBM event processing, through the implementation of an OPR-compliant Event
Synchronization Web Service, as opposed to implementing a Groovy script. The external application would need to implement a web
service endpoint to receive OPR events and event changes, and, if synchronization is supported by the external application, a REST
web service client to submit events and synchronize back event changes to the Event Synchronization Web Service.
1. Configure a Connected Server of type External Event Processing in the Connected Servers manager. The name of the server is the
name that must be used when authenticating at the Event Synchronization Web Service. You also specify a password for this user
during the configuration of the connected server.
2. Forward an event to the target connected server. This can be done by using the Event Browser context menu to manually forward
an event, or by configuring a forwarding rule and then triggering that rule.
3. Until an event is forwarded to the target connected server, the server cannot synchronize back any changes. In contrast to the
Event Web Service, which allows the authenticated OBM user to view and update any event that the OBM user has access to, the
connected server is only allowed to synchronize back changes for events that have been first forwarded to it. For more information
on Event Web Service, see Event Web Service reference.
4. The connected server synchronizes back changes to the event.
Related topics
Event Web Service Interface reference
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 99
AI Operations Management - Containerized 24.4
Note: You must configure a connected server before using this web service. For details, see the topic Prerequisite. Configure a
Connected Server in Event Synchronization Web Service Interface. The <base configured URL of the connected server> is the path to the
server you specified during the initial connected server setup.
Forward Event
When forwarding events from the OPR client to a third-party application, the following data is relevant:
HTTP Method
POST
Base URL: http://<base configured URL of the connected server>/event
Expected Payload: The expected response payload is an OprEvent object.
When forwarding event changes from the OPR client to a third-party application, the following data is relevant:
HTTP Method
POST
Base URL: http://<base configured URL of the connected server>/event_change/<external_event_ID>
Expected Payload: The expected response payload is an OprEventChange object.
Forward Events
When forwarding events in bulk from the OPR client to a third-party application, the following data is relevant:
HTTP Method
POST
Base URL: http://<base configured URL of the connected server>/event
Expected Payload: The payload is an OprEventList object.
Payload returned: Upon success the target service must return a list of the events sent to it with the ID set to the external
Event ID. The sequence_number must match the sequence_number of the event sent in the POST. For those events which do
not have a matching event returned, they are retried in a subsequent request. If an event is to be rejected, an HTTP error
must be returned for the entire payload. If an HTTP error 500-599 is returned, each event is individually retried as a non-bulk
request. For an HTTP error 400-499, all events in the request are marked as failed and no retry is done.
When forwarding event changes in bulk from the OPR client to a third-party application, the following data is relevant:
HTTP Method
POST
Base URL: http://<base configured URL of the connected server>/event_change/
Expected Payload: The expected response payload is an OprEventChangeList object. Each OprEventChange item in the list must
have the event_ref property set. The global_id is expected to be set to the ID on the target system, for example, when OBM
calls this web service on the target system, the target_id is set to the OBM event ID and the target_global_id is set to the
target object ID.
Payload returned: Upon success the target service must return a list of the event changes sent to it with the same sequence_n
umber . The sequence_number must match the sequence_number of the event change sent in the POST. For those changes
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 100
AI Operations Management - Containerized 24.4
which do not have a matching change returned, they are retried in a subsequent request. If an event change is to be
rejected, an HTTP error must be returned for the entire payload. If an HTTP error 500-599 is returned, each event change is
individually retried as a non-bulk request. For an HTTP error 400-499, all event changes in the request are marked as failed
and no retry is done.
When there is a need to get the external event from the third-party application (for example, when the External Info tab is
selected from the Event Browser), the following data is relevant:
HTTP Method
GET
Base URL: http://<base configured URL of the connected server>/event/<external_event_ID>
Expected Payload: The payload is the external event in the form of an OprEvent .
You can send a ping request to a third-party application. When sending a ping request to a third-party application, the following
data is relevant:
HTTP Method
Expected Payload
None
Related topics
Event Synchronization Web Service Interface
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 101
AI Operations Management - Containerized 24.4
If a client wants to submit a new event or a change to an event, but not invoke the Groovy script, the sub-paths event_list or event_chan
ge_list must be used. These paths will require native OPR objects, for example, OprEvent or OprEventChangeList . The sub-paths event_list
and event_change_list also enable clients to submit one or more events or event changes.
Event Updates
Event Get
Payload returned:
With a Groovy script configured for the connected server, the Groovy script toExternalEvent() method defines the
payload.
Without a Groovy script configured for the connected server, the payload is an OprEvent object.
Event Update
Payload received:
With a Groovy script configured for the connected server, the Groovy script defines the payload.
Without a Groovy script configured for the connected server, the payload must be an OprEvent object.
Payload received:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 102
AI Operations Management - Containerized 24.4
With a Groovy script configured for the connected server, the Groovy script defines the payload.
Without a Groovy script configured for the connected server, the payload must be an OprEventChange object.
See also the topic Event change creation: Logfile Adapter examples.
You can also send a ping request from a third-party application. When sending a ping request from a third-party application, the
following data is relevant:
Event Get
Payload returned:
Event Update
Event Submit
You can also submit an event from a third-party application. When submitting an event from a third-party application, the
following data is relevant:
Payload received:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 103
AI Operations Management - Containerized 24.4
In the case of event changes to the sub-path event_change_list , the following data is relevant:
Payload received:
See also the topic Event change creation for event_change_list examples.
Related topics
Event update to event_list example
Event submit examples
Event change creation for event_change_list examples
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 104
AI Operations Management - Containerized 24.4
priority Yes
severity Yes
solution Yes
state Yes
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 105
AI Operations Management - Containerized 24.4
You can submit event changes with an event update. The HTTP method in this case is PUT, and the expected payload for the Logfile
Adapter is an OprEvent . Each Groovy script adapter defines its own expected payload, so the expected payload would be different for
other Groovy script adapters.
The Event Synchronization Web Service supports sending multiple properties in a single payload. The following examples each show
just one changed property, with the exception of the last sample, which shows two changed properties. For more information, see the
topic Change Multiple Properties in One Call.
You can send test payloads to the Event Synchronization Web Service using the REST web service command-line utility RestWsUtil ,
supplied with the product. When using the utility, make sure that the event you are trying to update was first forwarded to the target
connected server you are using to authenticate with the Event Synchronization Web Service.
For details about the RestWsUtil command-line utility, see the topic opr-rest-ws-util Command-Line Interface.
An example call for an event update is shown below. The following sample call for an event update is for a connected server named log
ger with password set to Password1 , and attempts to update an event with the ID 0695624b-93fa-40b1-8b0fc9b4ea07a4ec . The sample call
looks like this:
The samples that follow show possible XML payloads for the call. The payloads are contained in the update.xml file referenced in the
call to the RestWsUtil command-line utility.
<OMi_HOME>/opr/examples/event-ws
This can be compiled and packaged into a war file for deployment into a J2EE container. See the README.txt in this directory for
instructions on how to build this webapp and deploy it for testing.
<OMi_HOME>/opr/examples/synchronization-ws
This can be used as a starting point for developers who want to develop their own Event Synchronization web service. See the
README.txt in this directory for instructions on how to build this webapp. The "TODO" sections must be completed by the developer.
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<description>This is a new description</description>
</event>
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<description/>
</event>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 106
AI Operations Management - Containerized 24.4
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new title</title>
</event>
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title/>
</event>
The title and description can be set in a single call. The order of the attributes is unimportant and attributes not specified do not affect
the current values.
Here is a sample payload to set the event title and description in a single update call:
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new title</title>
<description>This is a new description</description>
</event>
Related topics
opr-rest-ws-util Command-Line Interface
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 107
AI Operations Management - Containerized 24.4
The Event Synchronization Web Service supports sending multiple properties in a single payload. The following examples each show
just one changed property, with the exception of the last sample, which shows two changed properties. For more information, see the
topic Change Multiple Properties in One Call.
The examples use an event ID of 531d2673-683f-429f-a742-b8680ee01a76 . Change this event ID to the ID of the specific event for which
you wish to create a change object. The correct HTTP method for the creation of an event change is the POST method.
You can also use the event change list web service to get examples of event change objects. You can access the event change list web
service using this URL:
https://<server.example.com>/opr-web/rest/9.10/event_change_list
The following sample call for an event change creation is for a connected server named logger with password set to Password1 , and
attempts to create an event change for an event with ID 531d2673-683f-429f-a742-b8680ee01a76 . For an event change, the event ID
must be passed in the payload and is not part of the URL. The sample call looks like this:
The samples that follow show possible XML payloads for the call. The payloads are contained in the create.xml file referenced in the call
to the RestWsUtil command-line utility.
Annotations
The Event Synchronization Web Service supports only insert and update operations for annotations. The delete operation is not
supported.
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<annotation_property_change>
<property_name>annotation</property_name>
<current_value xsi:type="xs:string">This is a new Annotation.</current_value>
<change_operation>insert</change_operation>
</annotation_property_change>
</changed_properties>
</event_change>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 108
AI Operations Management - Containerized 24.4
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<annotation_property_change>
<property_name>annotation</property_name>
<annotation_id>1c108839-9584-45f4-93ab-798bf49797c7</annotation_id>
<current_value xsi:type="xs:string">This is an updated Annotation.</current_value>
<change_operation>update</change_operation>
</annotation_property_change>
</changed_properties>
</event_change>
Cause
The Event Synchronization Web Service supports only the set or unset operations for the cause of an event. Insert, update, or delete
operations are not supported. You set or unset the cause on the symptom event.
Here is a sample payload showing how to set the cause of an event to be the event with the ID of 9915e504-f5a2-471a-ab98-6184a7382d3
2:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>cause</property_name>
<current_value xsi:type="xs:string">9915e504-f5a2-471a-ab98-6184a7382d32</current_value>
</string_property_change>
</changed_properties>
</event_change>
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>cause</property_name>
<current_value xsi:type="xs:string"/>
</string_property_change>
</changed_properties>
</event_change>
Custom Attributes
The Event Synchronization Web Service supports only insert and update operations for custom attributes. The delete operation is not
supported.
Here is a sample payload showing how to insert a custom attribute, custom_attribute , with the value Some CA value :
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 109
AI Operations Management - Containerized 24.4
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<custom_attribute_property_change>
<property_name>custom_attribute</property_name>
<key>TestCA</key>
<current_value xsi:type="xs:string">Some CA value</current_value>
<change_operation>insert</change_operation>
</custom_attribute_property_change>
</changed_properties>
</event_change>
Here is a sample payload showing how to update a custom attribute, custom_attribute , with the value Some updated CA value :
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<custom_attribute_property_change>
<property_name>custom_attribute</property_name>
<key>TestCA</key>
<current_value xsi:type="xs:string">Some updated CA value</current_value>
<change_operation>update</change_operation>
</custom_attribute_property_change>
</changed_properties>
</event_change>
Description
The Event Synchronization Web Service supports only the set or unset operations for the description of an event. Insert, update, or
delete operations are not supported.
Here is a sample payload showing how to set the description in an event change creation to Some description of the event:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>description</property_name>
<current_value xsi:type="xs:string">Some description of the event.
</current_value>
</string_property_change>
</changed_properties>
</event_change>
Here is a sample payload showing how the description in an event change creation is unset:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 110
AI Operations Management - Containerized 24.4
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>description</property_name>
<current_value xsi:type="xs:string"/>
</string_property_change>
</changed_properties>
</event_change>
State
The only operation that is possible on the state of an event is to give the state a new value. Insert, update, or delete operations are not
applicable for event state changes.
The possible values for the state of an event are: open , in_progress , resolved , closed .
Here is a sample payload showing how the state in an event change creation is set to the value in_progress :
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<state_change>
<property_name>state</property_name>
<current_value xsi:type="xs:string">in_progress</current_value>
</state_change>
</changed_properties>
</event_change>
Priority
The only operation that is possible on the priority of an event is to give the priority a new value. Insert, update, or delete operations are
not applicable for priority changes.
You can set the priority to one of the following values: none , lowest , low , medium , high , highest .
Here is a sample payload showing how the priority in an event change creation is set to low :
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<priority_property_change>
<property_name>priority</property_name>
<current_value xsi:type="xs:string">low</current_value>
</priority_property_change>
</changed_properties>
</event_change>
Severity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 111
AI Operations Management - Containerized 24.4
The only operation that is possible on the severity of an event is to give the severity a new value. Insert, update, or delete operations
are not applicable for severity changes.
You can set the severity to one of the following values: critical , major , minor , warning , normal .
Here is a sample payload showing how the severity in an event change creation is set to normal :
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<severity_property_change>
<property_name>severity</property_name>
<current_value xsi:type="xs:string">normal</current_value>
</severity_property_change>
</changed_properties>
</event_change>
Solution
The Event Synchronization Web Service supports only the set or unset operations for the solution of an event. Insert, update, or delete
operations are not applicable for solution changes.
Here is a sample payload showing how the solution in an event change creation is set to Some solution to the event :
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>solution</property_name>
<current_value xsi:type="xs:string">Some solution to the event.</current_value>
</string_property_change>
</changed_properties>
</event_change>
Here is a sample payload showing how the solution in an event change creation is unset:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>solution</property_name>
<current_value xsi:type="xs:string"/>
</string_property_change>
</changed_properties>
</event_change>
Title
The Event Synchronization Web Service supports only the set or unset operations for the title of an event. Insert, update, or delete
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 112
AI Operations Management - Containerized 24.4
Here is a sample payload showing how the title in an event change creation is set to Some title for the event:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>title</property_name>
<current_value xsi:type="xs:string">Some title for the event.</current_value>
</string_property_change>
</changed_properties>
</event_change>
Here is a sample payload showing how the title in an event change creation is unset:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>title</property_name>
<current_value xsi:type="xs:string"/>
</string_property_change>
</changed_properties>
</event_change>
Here is a sample payload to set the event title and description in a single update call:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>title</property_name>
<current_value xsi:type="xs:string">Some title for the event.</current_value>
</string_property_change>
<string_property_change>
<property_name>description</property_name>
<current_value xsi:type="xs:string">Some description for the event.</current_value>
</string_property_change>
</changed_properties>
</event_change>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 113
AI Operations Management - Containerized 24.4
The title and description can be set in a single call as follows. The order of the attributes is unimportant and attributes not specified
don't affect the current values.
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new title</title>
<description>This is a new description</description>
</event>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 114
AI Operations Management - Containerized 24.4
If the submitter does not add an OprForwardingInfo entry for itself in the event, one will be automatically added with ForwardingType set
to notify. This allows the caller to subsequently read the event from the Event Synchronization Web Service.
The following samples show the XML payload. The correct HTTP method to set is the POST method.
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new event</title>
<description>This is a description</description>
</event>
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new event</title>
<description>This is a description</description>
<forwarding_info_list>
<forwarding_info>
<dns_name>extclt.example.com</dns_name>
<external_id>IM10219</external_id>
<external_url>http://extclt.example.com:8081/webtier-9.20/index.do?ctx=docEngine&file=probsummary&query=number%3D%22IM10219%
22</external_url>
<forwarding_type>synchronize</forwarding_type>
<state>originated</state>
</forwarding_info>
</forwarding_info_list>
</event>
<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new event</title>
<description>This is a description</description>
<forwarding_info_list>
<forwarding_info>
<dns_name>extclt.example.com</dns_name>
<external_id>IM10219</external_id>
<external_url>http://extclt.example.com:8081/webtier-9.20/index.do?ctx=docEngine&file=probsummary&query=number%3D%22IM10219%
22</external_url>
<forwarding_type>synchronize_and_transfer_control</forwarding_type>
<state>originated</state>
</forwarding_info>
</forwarding_info_list>
</event>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 115
AI Operations Management - Containerized 24.4
<event_list xmlns="http://www.hp.com/2009/software/opr/data_model">
<event><title>e0</title><severity>critical</severity></event>
<event><title>e1</title><severity>normal</severity></event>
<event><title>e2</title><severity>major</severity></event>
<event><title>e3</title><severity>minor</severity></event>
<event><title>e4</title><severity>warning</severity></event>
</event_list>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 116
AI Operations Management - Containerized 24.4
The following samples show the XML payload. The correct HTTP method to set is the POST method.
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>title</property_name>
<current_value xsi:type="xs:string">Some title for the event.</current_value>
</string_property_change>
</changed_properties>
</event_change>
Here is a sample payload showing submittal of a title change for one event, and a state change for another event:
<event_change_list xmlns="http://www.hp.com/2009/software/opr/data_model">
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id>
</event_ref>
<changed_properties>
<string_property_change>
<property_name>title</property_name>
<current_value xsi:type="xs:string">Some title for the event.</current_value>
</string_property_change>
</changed_properties>
</event_change>
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<event_ref>
<target_id>ad726f4f-ba51-409f-b429-b445b791ac9d</target_id>
</event_ref>
<changed_properties>
<state_change>
<property_name>state</property_name>
<current_value xsi:type="xs:string">in_progress</current_value>
</state_change>
</changed_properties>
</event_change>
</event_change_list>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 117
AI Operations Management - Containerized 24.4
Logging
All actions taken by the web service are logged in the following log files:
<OMi_HOME>/log/wde/opr-gateway.log
<OMi_HOME>/log/wde/opr-event-sync-adapter.log
<OMi_HOME>/log/wde/opr-event-ws.log
Debugging
To enable debugging for the event synchronization web service, set the loglevel to DEBUG in each of the following locations:
<OMi_HOME>/conf/core/Tools/log4j/wde/opr-gateway.properties
<OMi_HOME>/conf/core/Tools/log4j/wde/opr-event-sync-adapter.properties
<OMi_HOME>/conf/core/Tools/log4j/wde/opr-event-ws.properties
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 118
AI Operations Management - Containerized 24.4
For detailed information about the Event Web Service, see the topic Automate operator functions and event change detection.
For general information about using REST-based event web service interfaces such as the Event Web Service Interface with OBM, see
the topic Event Web Service Interface reference.
Related topics
Automate operator functions and event change detection
Event Web Service Interface reference
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 119
AI Operations Management - Containerized 24.4
Note: Only direct assignments, not indirect assignments, are listed by the Monitoring Automation web service.
The following sections provide details on how to use the Monitoring Automation Web Service:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 120
AI Operations Management - Containerized 24.4
Logging
All actions taken by the web service are logged in the following log files:
<OBM_HOME>/log/webapps/opr-webapp.log
<OBM_HOME>/log/webapps/opr-configserver.log
Debugging
To enable debugging:
<OBM_HOME>/conf/core/Tools/log4j/webapps/opr-webapp.properties
In the opr-webapp.properties file, set the loglevel to the desired value. The debug log level ( loglevel=DEBUG , cs_loglevel=DEBUG ) is useful
for finding problems.
id and <target_id>
The XML tags id and <target_id> represent the object ID and the ID of a referenced object, respectively.
The XML tags self and <target_href> represent the object URL and the URL of a referenced object, respectively.
The XML tags type and <target_type> represent a reference for the object and a reference for a referenced object, respectively.
<link>
The XML tag <link> specifies additional navigation possibilities such as requesting verbose output, requesting a list of deployment jobs
for the assignment being created, and so on.
Example: If the response to a GET request is a list of management template versions, each management template version in the list
corresponds to a <management_template_version_ref_version /> node. The management template node looks similar to the following
output:
<management_template_version_ref version="9.20"
type="urn:x-hp:2009:software:data_model:opr:type:reference:
management_template_version">
<target_id>d6f9cf24-244a-bce7-1e37-c5446c81e773</target_id>
<target_type>urn:x-hp:2009:software:data_model:opr:type:
management_template_version</target_type>
<target_href>
https://server.example.com/opr-config-server/rest/ws/9.20/
management_template_version_list/d6f9cf24-244a-bce7-1e37-c5446c81e773
</target_href>
<display_label>MTCIAttResolution</display_label>
<major_version>1</major_version>
<minor_version>0</minor_version>
</management_template_version_ref>
The type , <target_id> , <target_type>, <target_href> tags are highlighted in bold type.
Looping through the objects in the response, you can use the references to create new requests for the individual objects, for example,
to retrieve all assignments of a certain management template version.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 121
AI Operations Management - Containerized 24.4
Example: This is an example of the XML structure used for retrieving all automatic assignments:
GET - https://<server>:<port>/opr-config-server/rest/ws/10.12/auto_assignment_list
<auto_assignment_list>
<management_template_version_auto_assignment>
<id>
<auto_assigned_view>
<name>
<is_enabled>
<link>
<management_template_version_ref>
<target_id>
<target_type>
<target_href>
<management_template_version_auto_assignment>
<id>
<auto_assigned_view>
<name>
<is_enabled>
<link>
<management_template_version_ref>
<target_id>
<target_type>
<target_href>
<aspect_template_version_auto_assignment>
<id>
<auto_assigned_view>
<name>
<is_enabled>
<link>
<management_template_version_ref>
<target_id>
<target_type>
<target_href>
Example: This is an example of the XML structure used for getting an automatic assignment draft object for a given management
template version:
GET - https://<server>:<port>/opr-config-server/rest/ws/10.12/auto_assignment_list/draft/view/<viewName>/management_template_version/<mt
vId>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 122
AI Operations Management - Containerized 24.4
<management_template_version_auto_assignment>
<auto_assigned_view>
<name>
<is_enabled>
<parameter_value_list>
<parameter_value>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<parameter_value_instance_list>
<parameter_value_instance>
<order>
<value>
<is_default>
<dependent_parameter_value_list>
<parameter_value>
<value>
<is_default>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<parameter_value>
<value>
<is_default>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<link>
<management_template_version_ref>
<target_id>
<target_type>
<target_href>
Example: This is an example of the XML structure used for creating a management template automatic assignment:
Post https://<server>:<port>/opr-config-server/rest/ws/10.12/auto_assignment_list
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 123
AI Operations Management - Containerized 24.4
<management_template_version_auto_assignment>
<auto_assigned_view>
<name>
<is_enabled>
<parameter_value_list>
<parameter_value>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<parameter_value_instance_list>
<parameter_value_instance>
<order>
<value>
<is_default>
<dependent_parameter_value_list>
<parameter_value>
<value>
<is_default>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<parameter_value>
<value>
<is_default>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<link>
<management_template_version_ref>
<target_id>
<target_type>
<target_href>
Output:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 124
AI Operations Management - Containerized 24.4
<management_template_version_auto_assignment>
<auto_assigned_view>
<name>
<is_enabled>
<parameter_value_list>
<parameter_value>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<parameter_value_instance_list>
<parameter_value_instance>
<order>
<value>
<is_default>
<dependent_parameter_value_list>
<parameter_value>
<value>
<is_default>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<parameter_value>
<value>
<is_default>
<parameter_context>
<topo_path>
<aspect_version_id>
<parameter>
<id>
<display_label>
<type>
<base_parameter_id>
<link>
<management_template_version_ref>
<target_id>
<target_type>
<target_href>
Parameters
This section explains what parameters are, and how to set them when assigning management templates, aspects, or policy templates
to CIs.
Considerations
When executing web service requests, the following should be taken into consideration with regard to Monitoring Automation (MA)
parameters:
Certain XML tags are only visible in verbose mode. Examples of these are the following tags:
Expert flag.
The web service returns parameters only in response to web service requests dealing with assignments. To get a list of
parameters contained in a management template, aspect, or policy template, request a draft assignment for the artifact.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 125
AI Operations Management - Containerized 24.4
The response to the GET /auto_assignment_list?filterFor=notLatest request provides a list of all automatic assignment rules that do not
contain the latest version of the associated management template or aspect.
When creating an assignment, parameter specifications require the parameter's ID and its context. We recommend copying the
context from the response to GET assignment_list/<assignmentID> or GET assignment_list/draft/… request, rather than trying to
construct the context programmatically.
The context of a parameter in a management template specifies the configuration object the parameter is defined in (the context
of parameters in aspects and policy templates has no special meaning). Typically the context consists of the topology path, which
describes how the aspects contained in a management template link sub-CIs to CIs, and the version ID of the aspect containing
the parameter, as defined in the management template being assigned.
In verbose mode, the context provided in a draft response includes the label and description of the aspect containing the
parameter to assist users in resolving the parameter reference.
If you omit a parameter from an assignment creation request, its default value is used.
We recommend setting as few parameters as possible when creating assignments. The number of parameters to be set during
assignment can be minimized by creating good default values for the parameters. For more information about management
template, aspect, or policy template parametrization, see the topic Management Templates and Aspects.
When creating an assignment using the web service, the CI to which the assignment is to be made must be known. Therefore, any
conditions affecting parameter values are resolved and no longer conditional in the responses provided by the web service. As an
example, consider a parameter value with a conditional value of 10 for Windows and 20 for Unix. When retrieving assignment
information from the web service, the value is resolved and specified as 10 in a response for a CI on Windows, and as 20 for a CI
on Linux.
In contrast to parameter values changed by using the tuning functionality in the MA user interface, parameter values set using the
web service can be overwritten by assignments created from automatic assignment rules. For this reason, we recommend not
using the assignment web service in conjunction with active auto-assignment rules.
When upgrading an assignment to a different management template, aspect, or policy template version, all parameter values set
by the web service assignments are overwritten by the values as specified in the new management template, aspect, or policy
template version, unless you specify the useExisting=true URL parameter when calling one of the draft-assignment generation
calls. Specifying the useExisting=true URL parameter causes the parameter values from an existing assignment to be reused for a
new assignment when neither the parameter type nor the value range changed between versions.
The parameter XML is also provided with the base_parameter_id XML tag. If the base_parameter_id is identical for a parameter in two
management template, aspect, or policy template versions, then the existing parameter values are used. Existing parameter
values cannot be reused, for example, when the parameter type changed from string to password, or when an enum type
parameter with the choices yes and no is expanded to include the maybe option in a new version. Additionally, when a parameter
is removed in a new policy version, the existing parameter values cannot be reused, even if a parameter with the same name was
added in the new version.
There are two types of parameters, simple and multi-instance parameters, where the latter have an XML tag <is_instance_paramete
r> set to true . Simple parameters have a value, whereas instance parameters have an instance list. Each instance in the list
consists of an instance value and a list of dependent parameters.
Example: Consider a multi-instance parameter fileSystem with the dependent parameters usageThreshold (in %) and messageSever
ity (a number of severity indicators such as warning or critical ). fileSystem is used to monitor two instances: C: and D: . For C: the
threshold for creating a message with a severity critical is 90% , while for D: the threshold for severity warning is 95% .
Note the following when using multi-instance parameters in web service requests:
Unless multiple instance definitions are specified, a multi-instance parameter is created for only one instance.
When specifying multiple instances in the definition of a multi-instance parameter, you can give each instance a sequence
number to ensure policy template conditions are processed in the correct order.
Dependent parameters can be overwritten by another instance associated with the multi-instance parameter they depend on
if that instance has a higher priority, as defined by the value of XML tag <ui_order> . Typically, the instance with the highest
priority has a ui_order value of 0 .
A response to a web service request for information related to an existing assignment can contain the following flags:
is_tuned : Specified if the parameter value was changed using the Monitoring Automation tuning user interface.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 126
AI Operations Management - Containerized 24.4
mandatory : Specified if the management template, aspect, or policy template defines the parameter as mandatory.
readonly : Specified if the management template, aspect, or policy template defines the parameter as read-only.
expert : Specified if the management template, aspect, or policy template defines the parameter as an expert parameter.
Parameter defaults can be specified as a literal using the attribute value , or symbolically using the attribute model_property with
the value set to the name of the CI attribute to provide the value.
When symbolic notation is used the parameter default value is calculated from the CI or sub-CI the assignment refers to.
We recommend never changing model_property , in order to avoid ambiguities with regard to the property's CI type and
resolvability.
value
model_property
The values of mandatory parameters must be provided when requesting assignment creation.
Input validation is done at assignment creation time. If the validation fails (for example, if a mandatory parameter is not specified)
the web service returns a descriptive error.
The following security considerations apply to passwords passed in management template parameter values:
Passwords are passed to the web service as plain text. For security, it is recommended to use a TLS connection for the
communication between web service client and web service server.
Though passed as plain text, passwords are automatically encrypted when stored in the database.
When retrieving password parameters by executing a GET request the client does not receive the actual value, but the
placeholder string ***** .
This also applies to default passwords returned in a response representing a draft for a POST request. Password parameters are
posted with the value ***** , however, instruct Monitoring Automation to use the value stored in the database, removing the need
to replace the placeholders with the actual password before posting the response.
The XML encoding used for assignment-related HTTP requests and responses uses the same format. This enables a GET response to be
reused for a POST request when creating an assignment, as follows:
Using this method makes your automation algorithm independent of those XML elements not involved in the modification, which
greatly increases the robustness of your code compared to manually creating the input.
To verify that the assignment was created, execute a GET request for the new assignment or the deployment jobs it should have
created, or inspect the assignment using the OBM MA user interface.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 127
AI Operations Management - Containerized 24.4
The following file contains the XML schema used for encoding object information:
<OBM_HOME>/opr/api/schema/OprDataModel.xsd
<OBM_HOME>/lib/opr-external-api.jar
If you are programming in Java, you can use these classes directly instead of generating classes from the schema. See the Javadoc API
Documentation for details about the classes provided.
See also the example source code for a java web service client in the following files:
<OBM_Home>/opr/examples/assignment-ws-client
<OBM_Home>/opr/examples/mgmt-templates-ws-client
In minimal mode, input, and output data contain a minimal set of XML tags needed to define an object. The minimal set is a true
subset of the set of XML tags used in verbose mode.
Default is minimal mode.
To use verbose mode, add the suffix ?view=verbose to the URL when calling the web service.
When using the minimal mode, the XML response contains the XML tag <link rel="verbose"> , the value of which is a URL that
provides the verbose version of the response file when called.
Related topics
Management Templates and Aspects
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 128
AI Operations Management - Containerized 24.4
Request syntax
The Monitoring Automation Web Service interface is accessed by using a URL with the following syntax:
https://<serviceURL>/<request>
The service document where all Monitoring Automation public web services is located here:
<server>:<port>/opr-config-server/rest/
<Server>:<port>/opr-config-server/rest/ws/<version>
where <Server> is the name of the OBM server and <version> is the web service interface version (for example: 9.20 or 10.11 ).
<request> The service request. For a complete list and syntax of possible service requests, see the table below.
All requests require authentication, and POST and DELETE requests require a header specifying a secure modify token. For more
information, see the table below.
Header syntax
The Monitoring Automation Web Service interface uses the following headers:
Header
Header Value
Name
The string Basic , followed by a space and the encoded user name and password to be used for authentication.
Authori JAVA code example using the org.apache.commons.codec.binary.Base64 codec with a RESTEasy client:
zation
import org.apache.commons.codec.binary.Base64; byte[] encodedUserPassword = Base64.encodeBase64 (("myUserName" + ":" +"myP
W").getBytes()); response = client.target(URL). header("Authorization", "Basic " + encodedUserPassword). get();
Request reference
The Monitoring Automation Web Service interface supports the following requests:
All web services related to management of automatic assignments are 10.12 services and are available at <Server>:<port>/opr-config-se
rver/rest/ws/10.12/ .
Request
Request MA Web Service
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 129
AI Operations Management - Containerized 24.4
Request
/auto_assignment_list[/<autoassignment
Request MA Web Service
Type
ID>]
Create a management template or aspect automatic assignment as specified in the posted
XML data.
POST
/<autoassignmentID> must be omitted.
/auto_assignment_list/management_tem
GET List all automatic assignments of the management template with ID <MTID> .
plate/<MTID>
/auto_assignment_list/management_tem
GET List all automatic assignments of the management template with version ID <MTVersionID> .
plate_version/<MTVersionID>
/auto_assignment_list/aspect/<aspectID
GET List all automatic assignments of the aspect with ID <aspectID> .
>
/auto_assignment_list/aspect_version/<a
GET List all automatic assignments of the aspect with version ID <aspectVersionID> .
spectVersionID>
/auto_assignment_list/view/<viewName
GET List all automatic assignments for a view.
>
/auto_assignment_list/draft/view/<viewN If aspect/<aspectID> is used, the latest version of the specified aspect is assigned.
ame>/{aspect/<aspectID> | aspect_vers GET If aspect_version/<aspectVersionID> is used, the specified aspect version is assigned.
ion/<aspectVersionID>} You can make any required modifications to the response, and then POST it by using an /auto_
assignment_list request to create the automatic assignment.
/assignment_list[/<assignmentID>] Create a management template, aspect, or policy template assignment as specified in the
posted XML data.
POST
/<assignmentID> must be omitted.
Delete the management template, aspect, or policy template assignment with ID <assignmentI
D> .
DELETE
/<assignmentID> must be specified.
List all management templates, aspects, or policy templates assigned to the CI with ID <CIID> .
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 130
AI Operations Management - Containerized 24.4
Request
Request MA Web Service
Type
You can make any required modifications to the response, and then POST it using an /assignm
ent_list request to create the assignment.
/assignment_list/management_template/
GET List all assignments of the management template with ID <MTVersionID> .
<MTID>
/assignment_list/management_template
GET List all assignments of the management template with version ID <MTVersionID> .
_version/<MTVersionID>
/assignment_list/draft/ci/<CIID>/aspect/ If aspect/<aspectID> is used, the latest version of the specified aspect is assigned.
{<aspectID> | aspect_version/<aspectV GET If aspect_version/<aspectVersionID> is used, the specified aspect version is assigned.
ersionID>} You can make any required modifications to the response, and then POST it using an /assignm
ent_list request to create the assignment.
/assignment_list/aspect_version/<aspect
GET List all assignments of the aspect with version ID <aspectVersionID> .
VersionID>
You can make any required modifications to the response, and then POST it using an /assignm
ent_list request to create the assignment.
/assignment_list/template/<templateID
GET List all assignments of the template with ID <templateID> .
>
/assignment_list/template_version/<tem
GET List all assignments of the template with version ID <templateVersionID> .
plateVersionID>
/management_template_list[/{<MTID> | <MTID> is specified: List all versions of the management template with ID <MTID> .
GET
/ci_type/<CIType>}] /ci_type/<CIType> is specified: List all management templates assignable to CIs which have
the CI type <CIType> .
/management_template_list/ci/<CIID>] GET List all management templates assignable to the CI with ID <CIID> .
/management_template_list/view/<view
GET List all management templates assignable for a view.
Name>]
<MTVersionID> is omitted: List all versions of all management templates in the database.
/management_template_version_list[/<
GET <MTVersionID> is specified: Retrieve the management template with the version ID <MTVer
MTVersionID>]
sionID>
/aspect_list[/{<aspectID> | /ci_type/<CI <aspectID> is specified: List all versions of the aspect with ID <aspectID> .
GET
Type>}]
/ci_type/<CIType> is specified: List all aspects assignable to CIs of the CI type <CIType> .
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 131
AI Operations Management - Containerized 24.4
Request
Request MA Web Service
Type
<templateVersionID> is omitted: List all versions of all policy templates in the database.
/template_version_list[/<templateVersio
GET <templateVersionID> is specified: Retrieve the policy template with the version ID <templat
nID>]
eVersionID> .
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 132
AI Operations Management - Containerized 24.4
1.1.2.6.3. Examples
This section describes a number of use cases for the Monitoring Automation Web Service Interface.
Each use case describes the workflow to be followed. Many of these use cases are covered by the code samples located in the following
directories:
<OMi_HOME>/opr/examples/assignment-ws-client
<OMi_HOME>/opr/examples/mgmt-template-ws-client
Assumptions
The examples are based on the following assumptions:
The CI is part of the topology monitored by OBM and can be reached over the network.
Authentication and the secure modify token are properly specified if needed.
The OBM account used for authentication has sufficient permissions to carry out the requested operations.
a. Issue the following web service request to list all management templates assignable to CIs of the CI type myType :
GET /management_template_list/ci_type/<myType>
GET /management_template_list/ci/<CIID>
b. The response contains a list of management template versions. To get the latest management template version, denoted as latest
MTV
c. Issue the following web service request to simulate the assignment of the management template version:
GET /assignment_list/draft/ci/<myCI>/management_template_version/<latestMTV>
d. In the response, update any parameter values to be changed. Post the response using the following request to create the
assignment:
POST assignment_list
a. Issue the following web service request to list all assignments to the CI with the ID myCI :
GET /assignment_list/ci/<myCI>
b. The response contains a list of assignments. For each returned assignment, denoted as myAssg , issue the following request to
delete it:
DELETE /assignment_list/<myAssg>
Note: When a CI is removed, Monitoring Automation automatically deletes any assignments to the CI, and these steps do not
need to be performed.
Issue the following web service request to list all assignments to the CI with the ID myCI :
GET /assignment_list/ci/<myCI>
The response contains a list of assignments. For each returned assignment, denoted as myAssg:
a. Issue the following web service request to get assignment with the ID myAssg :
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 133
AI Operations Management - Containerized 24.4
GET /assignment_list/<myAssg>
c. Post the modified draft response using the following request to create the assignment:
POST assignment_list
To enable the assignments, repeat the workflow but set the is_enabled flag to true .
a. Issue the following web service request to retrieve the assignment with the ID myAssg :
GET /assignment_list/<myAssg>
b. The response contains a parameter value block. Search for the desired parameter, denoted as myParm , in the parameter value
block by searching for the node parameter_value > parameter > display_label with value myParm . This node defines the parameter
called myParm in the user interface.
d. Post the response using the following request to update the assignment:
POST assignment_list
a. Issue the following web service request to retrieve the automatic assignment with the ID myAutoAssignment :
GET /auto_assignment_list/<myAutoAssignment>
b. The response contains a parameter value block. Search for the desired parameter, denoted as myParm , in the parameter value
block by searching for the node parameter_value > parameter > display_label with value myParm . This node defines the parameter
called myParm in the user interface.
d. Post the response using the following request to update the automatic assignment:
POST /auto_assignment_list
a. Issue the following web service request to get a list of all automatic assignment rules that do not contain the latest version of the
assigned item and therefore require an update:
GET /auto_assignment_list?filterFor=notLatest
b. For each automatic assignment to be updated, determine the versionId and assignedViewName values and proceed with the
following steps:
GET /management_template_version_list/<versionId>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 134
AI Operations Management - Containerized 24.4
To update the automatic assignment rule to contain the latest version of the management template, issue the following
request:
The latest version of the management template is automatically set when using the managementTemplateId .
GET /auto_assignment_list/draft/view/<assignedViewName>/management_template/<managementTemplateId>
To use existing values from the previous management template version, issue the following service request:
GET /auto_assignment_list/draft/view/<assignedViewName>/management_template/<managementTemplateId>?useExisting=tru
e
The response contains a parameter value list with default values. The values can be edited if required.
3. Post the modified draft response by using the following request to update the automatic assignment:
POST auto_assignment_list
a. Issue the following web service request to get a list of all automatic assignment rules that do not contain the latest version of the
assigned item and therefore require an update:
GET /auto_assignment_list?filterFor=notLatest
b. For each automatic assignment to be updated, determine the versionId and assignedViewName values and proceed with the
following steps:
GET /aspect_version_list/<versionId>
To get the automatic assignment rule to contain the latest version of the management template, issue the following
request:
The latest version of the management template is automatically set when using the aspectId .
GET /auto_assignment_list/draft/view/<assignedViewName>/aspect/<aspectId>
To use existing values from the previous management template version, issue the following service request:
GET /auto_assignment_list/draft/view/<assignedViewName>/aspect/<aspectId>?useExisting=true
The response contains a parameter value list with default values. The values can be edited if required.
3. Post the modified draft response by using the following request to update the automatic assignment:
POST auto_assignment_list
Scenario 8a: Update Assignments to a New Management Template Version without reusing existing parameter values
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 135
AI Operations Management - Containerized 24.4
Recommended workflow:
a. Issue the following web service request to list all assignments of the management template version with the ID myMTV :
GET /assignment_list/management_template_version/<myMTV>
b. The response contains a list of assignments. For each returned assignment, denoted as myAssg :
a. Based on the response, determine the ID of the CI to which the management template is assigned.
b. Determine the value of each parameter contained in the assignment. If the new management template version uses the
same default values as myMTV , it is sufficient to determine the values of only those parameters that were changed, as
indicated by their flag is_default being set to false .
c. Issue the following web service request to assign the new management template version to the CI (the version ID of the new
management template is newMTV ):
GET /assignment_list/draft/ci/<myCI>/management_template_version/<newMTV>
d. Plug the parameter values retrieved from the assignment of myMTV into the draft response for newMTV .
e. Post the modified draft response using the following request to create the assignment:
POST assignment_list
Note: MA automatically ensures that only one version of a management template is assigned to a particular CI at any time by
deleting any existing assignments of older versions of a management template before assigning it.
Scenario 8b: Update assignments to a aspect version, reusing existing parameter values
Recommended workflow (the same procedure also applies to management templates and policy templates):
a. Issue the following web service request to list all assignments of the aspect version with the ID myAspectV :
GET /assignment_list/aspect_version/<myAspectV>
b. The response contains a list of assignments. For each returned assignment, denoted as myAssg :
a. Based on the response, determine the ID of the CI to which the aspect is assigned.
b. Issue the following web service request to assign the new aspect version to the CI. Specify the useExisting flag to take over
parameter values:
c. Look over the draft response. You can now fill out parameters for which no value was set, or change the values that were set
by default, if desired.
d. Post the modified draft response by using the following request to create the assignment:
POST assignment_list
a. Issue the following web service request to simulate the assignment of the management template version:
GET /assignment_list/draft/ci/<myCI>/management_template_version/<latestMTV>
b. The response contains a parameter value block. For each parameter, determine the value of the flag required .
c. If the required flag is specified and has the value true , the parameter is mandatory and must be specified when creating an
assignment based on the draft.
a. Issue the following request to check for any deployment jobs started as a result of creating the assignment with the ID myAssg :
/deployment_job_list/assignment/<myAssg>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 136
AI Operations Management - Containerized 24.4
If the response does not contain any deployment jobs, the assignment was successfully deployed.
If the response contains deployment jobs having the state failed , deployment failed. Correct any problems indicated in the
job description, and create the assignment again.
If the response contains deployment jobs having the state running , deployment is not finished. Wait for a reasonable period
to allow the deployment to finish, and repeat the workflow until all jobs having the state running have completed.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 137
AI Operations Management - Containerized 24.4
Access
To access the Status web service, use the following base URL and syntax:
https://<baseURL>/<request>
<baseURL> <server>:<port>/topaz/api/urest/v2/ci_status
Request reference
The Status web service interface supports the following requests:
Request
Request Status Web Service Action
Type
Returns CI status and a list of KPIs for the CI specified by the <ci id> . This request only works for
?filter=ciId EQ <ci id> GET
one CI at a time.
Returns CI status and a list of KPIs for the CI specified by the <ci name> . This request only works
?filter=ciName EQ <ci name> GET
for one CI at a time.
?filter=globalCiId EQ <global ci Returns CI status and a list of KPIs for the CI specified by the <global ci id> . This request only works
GET
id> for one CI at a time.
?filter=view EQ <view name> GET Returns CI status and a list of KPIs for all CIs contained in a view specified by the<view name> .
Supported operators are EQ and IN . You can further filter the results based on status. Syntax: filter=status EQ <status>
If URL reaches the maximum length, you can send a filter with a POST request.
For example,
{
"items" : [ {
"attribute" : "view",
"operator" : "EQ",
"value" : "<view name>"
},
{
"attribute" : "status",
"operator" : "IN",
"values" : [ "MINOR", “MAJOR” ]
} ]
}
CI status views
The following additional view parameters enable you to specify a predefined set of attributes that you can include in the response:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 138
AI Operations Management - Containerized 24.4
Group CI status
You can group CI statuses using the URL /topaz/api/urest/v2/ci_status/group . You must specify the grouping criteria in conjunction with the
filter criteria using the parameter groupBy .
The following grouping criteria are valid in the groupBy parameter. You can specify multiple criteria for hierarchical grouping:
view : Group the resulting data by selected views, which must be specified within the filter criteria. view can only be specified as
first grouping criteria.
ciType : Group the resulting data by CI types
status : Group the resulting data by CI status
The Group CI status request allows the additional parameter view=countOnly . When this is given, only the number of CI statuses per
group will be returned.
Examples:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 139
AI Operations Management - Containerized 24.4
Request a list of preconfigured tools that can be applied to a specific CI or in the context of an event.
Execute a tool on a set of nodes.
Cancel a tool execution.
Retrieve the results of a tool execution.
For more information on tools, see the topic Tools. For information on the opr-tool command-line interface, see the topic opr-tool
Command-Line Interface.
https://<serviceURL>/<req
uest>
<server>:<port>/opr-web/rest/<version>
<serviceURL>
where <server> is the name of the OBM server and <version> is the web service interface version (for example: 10.
11 ).
The service request. For a complete list and syntax of possible service requests, see the topicTool Execution Web
<request>
Service request reference.
DELETE https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/{contextId}/{resultId}
Error Handling
Error handling for the Tool Execution web service is as follows:
Individual return codes per requested host (HTTP code always 200):
Return code -404: requested host is not in the RTSM or the CI does not meet the requirements
Return code -500: communication problem with the requested host
Return code 0: execution succeeded
Other return codes (for example, 1): error code from the command to be executed
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 140
AI Operations Management - Containerized 24.4
Related topics
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 141
AI Operations Management - Containerized 24.4
Request
Request MA Web Service Action
Type
/tool_execution POST Retrieve the list of tools applicable to the specified CI(s) or event(s).
For a specified tool and CI(s) or event(s), retrieve the parameters to be filled out by the user, and create
/tool_execution/preparation POST
an execution context in the back end (valid for 10 minutes).
/tool_execution/execution_previ Preview what would be executed, based on the parameters that the user has filled in. rowspan='3'|/tool
POST
ew/<contextId> _execution/execution/<contextId>
/tool_execution/execution_previ
POST Execute the tool.
ew/<contextId>
/tool_execution/execution_previ
DELETE Cancel the tool execution for all affected nodes.
ew/<contextId>
/tool_execution/execution_previ
GET Retrieve the tool execution status for all affected CIs.
ew/<contextId>
/tool_execution/execution/<con
DELETE Cancel the tool execution for a single CI.
textId>/<resultID>
/tool_execution/execution/<con
GET Retrieve the tool execution status of a single CI.
textId>/<resultID>
XML structures
For more information on XML structures, see also the OBM public web service schema definitions in <OMi_HOME>/opr/api/schema/OprData
Model.xsd .
The following XML structure examples include comments to help you to tailor them to your specific uses.
Get a contextID:
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/preparation
Input:
Output:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 142
AI Operations Management - Containerized 24.4
Execute a tool:
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>
Input:
Output:
GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 143
AI Operations Management - Containerized 24.4
GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>/<resultID>
For a given tool and CI(s) or event(s), retrieve the parameters to be filled out by the user, and create an execution
context in the backend (valid for 10 minutes):
GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/preparation
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 144
AI Operations Management - Containerized 24.4
Output:
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution
Input:
Output:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 145
AI Operations Management - Containerized 24.4
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution
Input:
Output:
Preview what would be executed based on the parameters the user has filled in:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 146
AI Operations Management - Containerized 24.4
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution_preview/<contextID>
Output:
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextID>
Output:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 147
AI Operations Management - Containerized 24.4
POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextID>/<resultID>
Output:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 148
AI Operations Management - Containerized 24.4
The User Management Web Services enable integrators to access the following user management functionality from an external
application:
The easiest way to work with services that allow addition or modification of objects is to retrieve an XML example with the GET request,
then modify it to your needs and POST to create or PUT to update the object. When using a JAVA client, the classes provided in the opr
-external-api.jar can be used to marshal or unmarshal the XML content directly.
For general information about using the User Management web service interface, see the topic Reference information for all web
services.
For more information on user, groups, and roles, see the topic Users, Groups, and Roles.
https://<serviceURL>/<req
uest>
<server>:<port>/opr-web/admin/rest/<version>
<serviceURL>
where <server> is the name of the OBM server and <version> is the web service interface version (for example: 10.0
1 ).
The service request. For a complete list and syntax of possible service requests, see the topicUser Management Web
<request>
Services request reference.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 149
AI Operations Management - Containerized 24.4
Related topics
Reference information for all web services
Users, Groups, and Roles
User Management Web Services request reference
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 150
AI Operations Management - Containerized 24.4
User service
Request Request Type Web Service Action
/time_zone_list GET Lists all time zones that can be used when setting up new users.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 151
AI Operations Management - Containerized 24.4
/ldap_group_list GET Lists all groups available for the LDAP mapping as specified during the LDAP setup.
Note
Note: To list all LDAP groups, you need to add query filter as URL paramater. Optionally you can also pass format (xml/json) as URL
parameter.
Request
Request Web Service Action
Type
Note:
When adding or modifying a role via the Web Service, permissions can be set on a view by adding/removing the
following permission tags to the role:
/role_list[/<
POST <permission>
roleID>]
<resource_key>rtsm-view.{VIEW_NAME}</resource_key>
<operation_key>{KEY}</operation_key>
</permission>
In the resource key, the VIEW_NAME must be specified to select which view receives the permission. The operation_k
ey specifies the permitted operation. Possible values are change, view, or delete .
/role_list[/< Note:
PUT
roleID>] /<roleID> must be specified.
/role_list/user_object/<userID>
/role_list[/< List all roles which are assigned to the user with the specified ID.
GET
roleID>] /role_list/user_group/{userGroupID}
/auth_resource_list GET Lists all available authorizable resources that can be set in a role.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 152
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 153
AI Operations Management - Containerized 24.4
1.1.2.9.2. Examples
This section describes the recommended workflow for creating a role and assigning permissions to the role. In addition, the example
creates user groups based on LDAP groups:
1. Optional. Set up event categories to fine tune permissions on events not assigned to users:
Example:
POST - https://<server>:<port>/opr-web/admin/rest/10.01/event_category_list
<event_category xmlns="http://www.hp.com/2009/software/opr/data_model">
<category>MyEvtentCategory</category>
</event_category>
Example:
GET - https://<server>:<port>/opr-web/admin/rest/10.01/auth_resource_list
3. For each permission you want to assign to a role, select the resource key and the operation key from the output. For example, to
assign permissions to the User Group Assignments manager, the Content Pack manager, and the RTSM view All My Windows
Servers, identify the following keys:
Example:
<auth_resource_list …>
<auth_resource>
<key>omi-event-to-group</key>
…
<auth_operation_list>
<auth_operation>
<key>full-control</key>
<auth_resource>
<key>omi-content-mgr</key>
…
<auth_operation_list>
<auth_operation>
<key>full-control</key>
<auth_resource>
<key>rtsm-view</key>
…
<key>view</key>
…
<auth_resource>
<key>rtsm-view.All My Windows Servers</key>
…
If the <auth_resource> is part of <child_auth_resource_list> , it might not directly specify all operations. Instead, search at the parent
<auth_resource> item.
4. Create a role and configure the permissions identified in the previous step:
Example:
POST - https://<server>:<port>/opr-web/admin/rest/10.01/role_list
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 154
AI Operations Management - Containerized 24.4
<role xmlns="http://www.hp.com/2009/software/opr/data_model">
<name>Role with RTSM views REST API</name>
<permission>
<resource_key>rtsm-view.All My Windows Servers</resource_key>
<operation_key>view</operation_key>
</permission>
<permission>
<resource_key>omi-event-to-group</resource_key>
<operation_key>full-control</operation_key>
</permission>
<permission>
<resource_key>omi-content-mgr</resource_key>
<operation_key>full-control</operation_key>
</permission>
<permission>
<resource_key>omi-event.unassigned-event.MyEventCategory</resource_key>
<operation_key>assign-to</operation_key>
</permission>
<permission>
<resource_key>omi-event.assigned-event</resource_key>
<operation_key>launch-automatic-action</operation_key>
</permission>
<permission>
<resource_key>omi-tool.Database_Operational_Tools</resource_key>
<operation_key>execute</operation_key>
</permission>
<permission>
<resource_key>omi-tool.MyToolCategory</resource_key>
<operation_key>execute</operation_key>
</permission>
</role>
Tip: Get the role ID from the output for later use, for example:
<id>61a2d926-b9ab-42dd-99da-8ebe2a09c82c</id
5. Create a user group and assign the previously created role to the group:
1. Prerequisite. LDAP mapping settings must be configured with "Automatically create LDAP users" and "Add new users to
groups".
Example:
POST - https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list
<user_group xmlns="http://www.hp.com/2009/software/opr/data_model">
<name>Group Name</name>
<description>Group with LDAP mapping and Role for ALL LDAP users</description>
<event_assignment>true</event_assignment>
<ldap_auto_assignment>true</ldap_auto_assignment>
<user_group_to_role_list>
<user_group_to_role>
<role>
<id>61a2d926-b9ab-42dd-99da-8ebe2a09c82c</id>
</role>
</user_group_to_role>
</user_group_to_role_list>
</user_group>
Example: Grant permissions to users that are members of specific LDAP groups
1. Prerequisite. LDAP mapping settings must be configured with "Synchronize LDAP groups with OBM groups".
Example:
GET - https://<server>:<port>/opr-web/admin/rest/10.01/ldap_group_list
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 155
AI Operations Management - Containerized 24.4
Identify the LDAP groups in the output to which you want to assign to the role.
Example:
POST - https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list
<user_group xmlns="http://www.hp.com/2009/software/opr/data_model">
<name>Group Name</name>
<description>Group with LDAP mapping and Role for LDAP users</description>
<event_assignment>true</event_assignment>
<ldap_auto_assignment>false</ldap_auto_assignment>
<user_group_to_role_list>
<user_group_to_role>
<role>
<id>61a2d926-b9ab-42dd-99da-8ebe2a09c82c</id>
</role>
</user_group_to_role>
</user_group_to_role_list>
<ldap_group_list>
<ldap_group>
<name>EMEA Operators</name>
<domain>emea</domain>
<ldap_server>YourLDAPServer</ldap_server>
</ldap_group>
<ldap_group>
<name>EMEA Administors</name>
<domain>emea</domain>
<ldap_server>YourLDAPServer</ldap_server>
</ldap_group>
</ldap_group_list>
</user_group>
Retrieve the user's information and search for the related groups in the user_group_list :
GET- https://<server>:<port>/opr-web/admin/rest/10.01/user_object_list/{userID}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 156
AI Operations Management - Containerized 24.4
GET- https://<server>:<port>/opr-web/admin/rest/10.01/role_list/user_object/{ID}
GET- https://<server>:<port>/opr-web/admin/rest/10.01/role_list/user_group/{ID}
To remove a user from a group, first get the group, then remove the user from the users list of the output, and then send the
request to modify the group without the specified user.
1. GET- https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list/{groupID}
<user_group>
<id>00000000-0000-0000-8689-17929130e34a</id>
<version>1</version>
<name>Administrators</name>
<description>OBM Administrators</description>
<event_assignment>false</event_assignment>
<ldap_auto_assignment>false</ldap_auto_assignment>
<user_object_list>
<user_object>
<id>00000000-0000-0000-95ac-ae0c2214712b</id>
</user_object>
<user_object>
<id>00000000-0000-0000-b315-65efb9991798</id>
</user_object>
<user_object>
<id>00000000-0000-0000-8593-821aed2d2d52</id>
</user_object>
</user_object_list>
<user_group_to_role_list>
<user_group_to_role>
<role>
<id>ca252aa1-11e7-4645-bcee-6757ea6ec2c5</id>
<version>1</version>
<name>Administrator Role</name>
<description>All permissions</description>
</role>
</user_group_to_role>
</user_group_to_role_list>
</user_group>
<user_object>
<id>00000000-0000-0000-95ac-ae0c2214712b</id>
</user_object>
3. Send the request to modify the group without the specified user(s).
PUT- https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list/{groupID}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 157
AI Operations Management - Containerized 24.4
<user_group>
<id>00000000-0000-0000-8689-17929130e34a</id>
<user_object_list>
<user_object>
<id>00000000-0000-0000-b315-65efb9991798</id>
</user_object>
<user_object>
<id>00000000-0000-0000-8593-821aed2d2d52</id>
</user_object>
</user_object_list>
<user_group_to_role_list>
<user_group_to_role>
<role>
<id>ca252aa1-11e7-4645-bcee-6757ea6ec2c5</id>
</role>
</user_group_to_role>
</user_group_to_role_list>
</user_group>
Note: If the PUT request does not include the full list of roles assigned to the user, then the group loses the role assignment
information as well.
DELETE - https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list{groupID}
To delete a set of groups, use the multiMode parameter to specify the group ids in a comma separated list of the id parameter:
https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list/?multiMode=true&id=00000000-0000-0000-83d4-05bbbce8ebf,00000000-00
00-0000-8e69-6e14d4d995a9
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 158
AI Operations Management - Containerized 24.4
Logging
All actions taken by the web service are logged in the following log file:
<OBM_HOME>/log/webapps/opr-webapp.log
Debugging
To enable debugging for the user management web service, do the following:
1. Go to:
<OBM_HOME>/conf/core/Tools/log4j/webapps/opr-webapp.properties
2. In the opr-webapp.properties file, set the loglevel to the desired value. The debug loglevel ( loglevel=DEBUG ) is useful for finding
problems.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 159
AI Operations Management - Containerized 24.4
There are several different areas where customization is possible. How to develop and deploy scripts for each area is discussed in
detail in the topic Development and deployment of scripts .
Reference information applicable to any script is provided in the topic Reference information.
Guidance on best practices when developing scripts is provided in the topic Best practices.
The trigger causing the script to be executed. For example, scripts can be configured to run in conjunction with the occurrence of
an event. Triggers are detailed in the topic Development and deployment of scripts , in the sections relevant to the various types
of customization under the Process Flow heading.
The place in the process flow when the script is executed. For example, event-based scripts can be configured to be executed
before the event is processed, or after. Available locations are detailed in the topic Development and deployment of scripts , in the
sections relevant to the various types of customization under the Process Flow heading.
Programming Language
OBM supports Groovy scripts. Groovy is a dynamic object-oriented programming language for the Java platform. When used as a
scripting language for the Java Platform, Groovy is dynamically compiled to Java Virtual Machine (JVM) bytecode making it
compatible with external Java code and libraries. Groovy is similar to Java, and most Java code is syntactically valid in Groovy. You
can find additional details about the Groovy syntax on the internet. A good start is to search for Groovy (programming language) on
Wikipedia, and use the list of references mentioned in the article.
For more information about obtaining the Groovy console, as well as OMi-specific information on installation, deployment and
debugging using the console, see the topic Groovy console.
Script Format
Scripts need to follow a specific format so that the OBM procedure calling the script is able to execute it correctly in the various
process locations where scripts can be added. Template scripts and examples are provided with the installation. Details about the
format to be used for the various types of customization are detailed in the topic Development and deployment of scripts , in the
sections relevant to the various types of customization under the Format heading.
Information Functions
Scripts are often used to add information about the managed configuration items (CIs) to the standard information set. The
information to be added must be obtained from various services and processes. Use the functions from the appropriate
Application Programming Interface (API). For example, when enriching event information you can use the functions from the RTSM
Java API to retrieve information from a CI. The available OBM and external APIs are listed in the topic Available APIs. Examples of
functions are detailed in the topic Development and deployment of scripts , in the sections relevant to the various types of
customization under the Example heading.
Best practices and things you should avoid are detailed in the topic Best practices. Any specific best practices that should be
followed are detailed in the topic Development and deployment of scripts , in the sections relevant to the various types of
customization under the Best Practices Specific to ... heading.
Script Management
Scripts are placed on the server running the OBM instance and configured for the appropriate process using the OMi console. How
to configure a script depends on where it is used. The steps you need to take to include and activate your scripts are detailed in
the topic Development and deployment of scripts , in the sections relevant to the various types of customization under the Script
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 160
AI Operations Management - Containerized 24.4
Management heading.
Related topics
Development and deployment of scripts
Reference information
Best practices
Official Groovy website
Groovy console
Available APIs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 161
AI Operations Management - Containerized 24.4
Improving performance
Customization scripts are executed as part of the processing flow, causing customization to slow down process execution. As long as
the increase in total processing time is small this is not a problem, but if the total processing time increases to a significant portion of
the interval between subsequent process runs, all OBM processes, including event and topology synchronization, could be negatively
affected or even disrupted. Therefore, it is important to make the absolute time it takes to execute your custom script as small as
possible.
Typically, connecting to and loading from the external resource are the most time-consuming steps.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 162
AI Operations Management - Containerized 24.4
Use the Groovy Console during script validation and testing (see the topic Groovy console).
When debugging the script, include plenty of logging statements allowing you to track the behavior of the code. We recommend
encapsulating the logging of debug information in a debug() method, making it easy to remove or deactivate logging in the
production environment (see the section Improving performance). Exceptions are calls to the init() and destroy() methods. We
recommend logging these using an info() method so you can track successful loading and unloading of your script, in both
debugging and production environments.
Use comments and verbose variable names to facilitate future script maintenance.
If an exception gives rise to a run-time error, the process could be disrupted. Catch exceptions by using try/catch blocks, and
provide an elegant exit in the exception handler.
When connecting in the init() method, check the validity of the database handle before accessing the resource. If the resource was
disconnected for reasons outside the control of the script, handling this exception properly allows you to recover the connection
by reconnecting.
Use ? when referencing object properties to avoid a NullPointerException when the object evaluates to null . When referencing a
property using ? the whole expression containing the reference evaluates to null , rather than throwing an exception.
Example:The following code snippet will still work if the assignedUser object evaluates to null.:
if (event.assignedUser?.userName) {...}
Avoid using def statements wherever possible to enhance the transparency of the script and facilitate future script maintenance.
We recommend declaring the actual object type instead of using a def statement, making it easier to find the properties and
methods of the instanced object. Another advantage of a transparent script is that it is easier to debug. Note, however, that are
cases in which using the def statement is justified. As an example, consider the backward compatibility of a script containing a
function having an argument of a class type that was not available in a previous version. If the argument is declared as type def
the script will still load in the previous version, even though the class is not defined in that version. In this case, adding a comment
specifying the actual object type of the argument in question.
Use the internal script error feature to preempt process disruptions caused by scripts experiencing run-time problems. If a script
class has a public method named getInternalScriptError() and the method returns a value of 10 or higher, the script is skipped by
the platform service executing the script. To use this feature, insert the following code:
int internalScriptError = 0;
def int getInternalScriptError() { return internalScriptError; }
def setInternalScriptError() { internalScriptError++; }
This code causes the member variable internalScriptError , which holds the script error level, to be initialized to 0 , and enables the
programmer to increase the error level by calling the setInternalScriptError() method whenever an error occurs. If, for example, the
setInternalScriptError() method is called whenever an attempt to connect to the database fails, the script is skipped after 10 tries,
and no longer uses process time.
Line numbering and a text search function are useful for matching log file references to code lines. Neither of these is available in
the script form included in the OBM Console, so an external editor is useful during script development.
For most scripts a simple tool such as Notepad++, vi or GNU emacs is sufficient.
Notepad++ is a freeware improvement on Notepad featuring line numbering and Java syntax highlighting, as well as an
optional auto indent plug-in.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 163
AI Operations Management - Containerized 24.4
vi is a visual text editor developed for UNIX, and is installed on UNIX systems. Several free and open source software
implementations of vi exist.
GNU Emacs is an extensible, customizable text editor featuring syntax highlighting, full Unicode support, and many optional
extensions.
For more involved scripts requiring syntax checking use the Groovy console. For details about installing and using the Groovy
console, see the topic Groovy console.
For large event forwarding scripts such as the Service Manager adapter script it could be useful to turn to more comprehensive
script editors, for example Eclipse or IntelliJ.
Using copy-and-paste could result in invalid code because of extra line breaks or because of line breaks being treated differently
by the Groovy engine. The Groovy engine does not require a semicolon to end a statement, and will sometimes treat a line break
as the end of a statement. Unintentional line breaks could therefore lead to unintentional code behavior.
If you do copy and paste code, inspect it line by line and rejoin statements split across two lines, which the Groovy engine may
unintentionally interpret as two separate statements.
Related Topics
Groovy console
Notepad++ Download
Wikipedia: vi
Gnu Emacs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 164
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 165
AI Operations Management - Containerized 24.4
The containerized and classic OBM versions have the script log interface, which you can access from any script editor area, event
browser, or launch pane. If the Script Message Streaming UI is open, new script messages will show up there as soon as they're
generated. The application displays the messages that are added to the scripts.log file. The content is updated every five seconds.
Upon reestablishing the connection, the polling will resume. If the connection was interrupted for more than five minutes, the following
warning message will appear:
The session was recreated . There may be a gap in the log file.
You can't view the log messages that're generated during the disruption. To view the complete script log file in containerized versions,
click button in any of the OBM script editors UI. You can download the log file. But this option isn’t available in classic OBM. For
more information about script log files in classic OBM, see View scripts log messages.
1. Go to any OBM script editor UI, event browser window, or launch pane.
2. Click the More Options icon to select the Open script message streaming option.
A new window opens and you can view the script log messages that are generated.
Related topics
External Instructions
Custom Actions
Connected Servers
Event Browser
Launch pane
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 166
AI Operations Management - Containerized 24.4
EPI scripts are not used to forward events; for information about scripts to forward events, see the topic Event forwarding scripts.
Process flow
Scripts are executed in the omi-scripting-host pod
The logs are provided as Kubernetes container logs for the omi-scripting-host pod. You can view these logs using the following
command:
kubectl -n <namespace> logs -l 'app=omi-scripting-host' -c omi-scripting-host --tail=-1
You can also download log files from the Event Processing user interface. For more information, see Event Processing Interface.
EPI scripts are triggered automatically every time the scripting host process is executed. You can configure the location in the event
pipeline process flow where the script is executed when you configure the script in the OBM Console. You can choose several locations,
as visualized in the figure below:
1. Before CI/ETI Resolution : The script is executed when the event enters the event pipeline, before CI/ETI resolution.
2. After CI/ETI Resolution : The script is executed immediately after CI/ETI resolution
3. Before Storing Events : The script is executed after all event processing has taken place, but before the event is stored in
the database.
4. After Storing Events : The script is executed after the event has been stored in the database. All scripts configured in this location
are executed in read-only mode.
Script management
Scripts are stored in the database and can be accessed from the OBM Console.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 167
AI Operations Management - Containerized 24.4
Administration > Event Processing > Automation > Event Processing Customizations
This pane lists all scripts that have been configured for the selected location.
2. Details
This pane shows the properties of the actual script, including an editor field with the script code.
By default, some sample scripts and placeholders are present in the database. We recommend using the sample classes provided
as a starting point when writing a new script to ensure that all required methods are available.
2. After your script is complete, activate it by either selecting the checkbox Activate after save or hover the mouse over the
selected script and click . The script is now executed every time the event pipeline is processed.
Format
When writing an EPI script, you must apply the following rules:
1. You can choose your own name for the class. The name of the class(es) you configure is added to the Event Processing
Scripts pane in the OBM administration console.
2. If your script class includes public init() and destroy() methods, these methods are called when the script class is instantiated and
destroyed, respectively. You can use these methods to implement customized initialization and clean-up actions that should be
called only once (see also the topic Best practices).
3. The script class must have a public method named process(eventList) . This method is called by the platform when the script is
executed. The argument eventList receives an array of Event objects you can step through using a for statement (see the example
in this section).
4. If a script class has a public method named getInternalScriptError() and the method returns a value of 10 or higher, the script is
skipped by the platform service executing the script. To use this feature, insert the following code:
int internalScriptError = 0;
def int getInternalScriptError() { return internalScriptError; }
def setInternalScriptError() { internalScriptError++; }
This code causes the member variable internalScriptError , which holds the script error level, to be initialized to 0 , and enables the
programmer to increase the error level by calling the setInternalScriptError() method whenever an error occurs.
5. You may include any other methods, properties, and members as needed.
Be aware of the number of scripts loaded at any one time. Loading a script introduces overhead until the scripts is unloaded, so
loading too many scripts at any one time could lead to performance problems.
Use background threads and cache information where possible (see also the topic Best practices).
If you need data from the RTSM (or any other external files or databases), open the connection to the RTSM in the init() method
and close the connect in the destroy() method (see also the topic Best practices).
Minimize the processing time required to execute the script's process() method. Especially EPI scripts should be written for
absolute speed. See also the topic Best practices.
EPI scripts will have a negative impact on the overall event processing if they experience problems with external resources such
as DNS availability, network availability, and slow file access, especially if the process() method uses those resources.
Access the RTSM using its JAVA API (see also the topic Best practices).
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 168
AI Operations Management - Containerized 24.4
You can configure the order in which scripts are executed when you configure the script in the OBM Console. Scripts can be moved
up or down in the sequence using the up and down icons in the Scripts Panel toolbar. By default, scripts are marked read/write;
use the read-only icon to mark a script read-only. Whether scripts are read-write or read-only has the following impact on when
they are executed relative to other scripts:
Scripts that need to modify events need read/write access to the database. They are marked read/write and are executed in
the order they are configured to avoid potential conflicts.
Scripts in read-only mode may be executed in parallel (asynchronously) with read/write scripts.
This means that read-only scripts have less impact on event throughput than read-write scripts. Therefore, mark scripts read-only
wherever possible. To mark a script read/write, use the read/write icon.
Note: Scripts located at the After Storing Events process step are always executed in read-only mode, because events stored in the
database can no longer be modified by an EPI script.
Scripts using an event filter may have slightly more impact on overall event throughput. Balance the use of filters against the
number of events you would have to load without filtering.
You can configure the timeout value for each script in the OBM Console.
Scripts running in read/write mode (synchronously) abort when the timeout time has elapsed, and any changes the script
made to events are rolled back.
Scripts running in read-only mode (asynchronously) simply abort when the timeout time elapses.
The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in the Inf
rastructure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The script must repeatedly
check for Thread.interrupted() , and also during potentially long running statements such as loops.
We recommend configuring a timeout for EPI scripts to minimize the potential impact of any single script experiencing problems
on the overall pipeline, thereby minimizing the risk of process disruptions.
Configuring a timeout is especially important for scripts using external resources. The best timeout value must be ascertained by
testing the script under conditions where access to external resources the script depends on are problematic. When testing
scripts, look at the following log file to see how long each script is taking to execute for each event it receives:
Do not store too much data in memory (see also JVM statistics).
Release resources when they are no longer needed, and watch for memory leaks during debugging.
Check the validity of resource handles and reconnect is necessary (see also the topic Best practices).
Example
The following sample script applies to the hypothetical situation where critical events are escalated and managed in an OBM-external
escalation database. The script retrieves the owner of escalated events from the escalation database and adds it to the OBM event
information.
In the example, external.api.scripting.dataBase and Database externalDB are examples used to demonstrate access to an OBM-external
database. The database classes are not provided by OBM; to implement the example, you must first create the classes yourselves.
import com.hp.opr.api.scripting.Event;
import external.api.scripting.dataBase;
class actionOnStatus
/* A script must always be declared as a class.
* The name of the script class is the name to be used as the name of
* the Event Processing Script in the OBM Adminstration console. */
{
int internalScriptError = 0;
// Note: The EPI server does not execute scripts
// if their getInternalScriptError method returns
// a value of 10 or higher.
def int getInternalScriptError()
{ return internalScriptError; }
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 169
AI Operations Management - Containerized 24.4
def setInternalScriptError()
// Use this method to increment the internalScriptError.
{ internalScriptError++; }
Database externalDB;
// Handle to an external database
// containing the data used to
// enrich events, in this case
// information about an escalation
// process.
def connectionString = "MyCloud,MyUsername,MyPwd";
def init()
{
// Actions to be taken when the Groovy script is compiled,
// which happens once, when the EPI is activated.
externalDB = connectDB(connectionString);
if(!externalDB)
{
throwDatabaseException(
"Could not connect to external dastabase"
+ " with connection string "
+ connectionString + "."
);
setInternalScriptError();
}
}
def destroy()
{
// Actions to be done before destroying the script cache.
externalDB.disconnect()
}
/* The process() method is called every time the EPI server processes
* the event pipeline.
*
* In this example the process() method retrieves the escalation owner
* of the related CI for all critical events in the pipeline from an
* external database, and uses the information to set the event's OmUser
* property. */
def process(eventList)
// The eventList argument passes an array containing
// the events in the event pipeline.
{
try
{
for( Event in eventList )
{
String stringOmUser = "";
String stringQuery = "";
int eventSeverity = Event.getSeverity();
if( eventSeverity == CRITICAL)
{
def RecordSet rsEventInfo;
stringQuery = "SELECT escalationOwner AS eo "
+ "FROM servers WHERE hostname = "
+ """" + Event.getRelatedCiHint() + """ "
+ "SORT BY contactPriority ASC";
rsEventInfo = externalDB.Open(StringQuery);
if( rsEventInfo.RecordCount > 0 )
{
stringOmUser =
"Primary escalation owner: "
+ rsEventInfo.Fields("eo");
} else {
stringOmUser =
"No escalation owner for CI: "
+ Event.getRelatedCiHint();
}
setOmUser(stringomUser);
}
// Anything else that needs to be done when this
// event is processed goes here.
}
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 170
AI Operations Management - Containerized 24.4
catch( DatabaseException e )
{
setInternalScriptError();
// Anything else that needs to be done when this
// exception is thrown goes here.
}
finally
{
// Actions to be done after all events are processed.
// In this example, nothing is needed here.
}
}
Related topics
Event forwarding scripts
Best practices
Event processing interface
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 171
AI Operations Management - Containerized 24.4
Triggers
Custom actions are launched manually by an operator for a particular event. To launch a custom action:
1. In OBM, select a perspective containing Event Browser and Actions windows, for example the default Event Perspective or Health
Perspective.
2. Select the event you want to apply the action to. All actions available for the selected event are listed in the Actions window.
3. Click the action to be executed.
Process flow
Scripts are executed in the omi-scripting-host pod.
The logs are provided as Kubernetes container logs for the omi-scripting-host pod. You can view these logs using the following
command:
kubectl -n <namespace> logs -l 'app=omi-scripting-host' -c omi-scripting-host --tail=-1
You can also download log files from the Custom Actions user interface. For more information, see Custom Actions .
Script management
To configure a Custom Action script and make it available from the Event Browser:
2. Details‚
This pane shows General information such as Status, Origin, ID, and whether the script is read-only along with the properties
of the actual script and the script code.
Note
The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in theInf
rastructure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The
script must repeatedly check for Thread.interrupted() , and also during potentially long running statements such as loops.
2. You cannot edit the code in the script window directly, but you must use the toolbar in the Custom Action Scripts pane to access
the script, as follows:
To edit an existing script, click Edit. On the right pane, you will see the details of the selected script and code that you
can edit and save.
To configure a new script, click New. The script wizard is shown, allowing you to enter the script and some information
about it, such as a name and description. The wizard provides a skeleton for the script class, which you can use as a starting
point.
Examples
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 172
AI Operations Management - Containerized 24.4
import java.util.List;
import com.hp.opr.api.scripting.Event;
class IsunoretAction
{
def process(event) // Process the event passed
// by the event browser.
{
// Example: Service ID of the event is
// manually set tpo a predefined value."
event.setOmServiceId("Isunoret");
}
}
Related topic
Custom Actions
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 173
AI Operations Management - Containerized 24.4
You can also use the script in conjunction with RTSM JAVA API. For more information about accessing the RTSM via the JAVA API, see EPI
script for event enrichment.
A Groovy script dealing with certificate requests is provided with the installation, which can be used as the basis for a custom scripts.
Process Flow
The certificate script class is instantiated the first time a certificate is requested. The process() method is called every time a certificate
is requested.
The logs are provided as Kubernetes container logs for the omi-scripting-host pod. You can view these logs using the following
command:
kubectl -n <namespace> logs -l 'app=omi-scripting-host' -c omi-scripting-host --tail=-1
You can also download log files from the Certificate Scripts user interface. For more information, see Certificate Scripts.
Script Management
Scripts are stored in the database and can be accessed from the OBM console.
The Certificate Requests tab lists all certificate requests that have been received during the time range selected in the drop-
down list.
2. Click the Autogrant Script tab. The default Autogrant Script is shown, which grants or denies certificates based on the value of
the request's nodeName attribute. The default script is not activated by default.
To customize the script, click Edit Item, or double-click the script window, and make the required changes.
Only one script can be configured as a certificate script. The script is activated as soon as it is configured. If no certificate scripts is
Note
The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in theInfrastruct
ure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The script must
repeatedly check for Thread.interrupted() , and also during potentially long running statements such as loops.
Example
The following example grants or denies certificate request based on the requester's subnet.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 174
AI Operations Management - Containerized 24.4
import java.net.InetAddress;
import java.util.Date;
import java.util.List;
import com.hp.opr.api.scripting.CertificateRequest;
class AutoGrantTest
{
def init()
{
}
def destroy()
{
}
Boolean boolInSubnet( String IPAddress )
{
// Check if the passed IP address
// is in the allowed subnet.
String stringAllowedSubnet = "128.0";
ByteOne = IPAddress.indexOf('.');
ByteTwo = IPAddress.indexOf('.', ByteOne + 1 );
String stringSubnet;
stringSubnet = IPAddress.substring( 0, ByteTwo );
return( stringSubnet.equals( stringAllowedSubnet ) );
}
def process(List<CertificateRequest> requests)
{
// Retrieve the first request object.
def request = requests.get(0);
if ( boolInSubnet( request.getIpAddress() ) )
{
request.deny();
}
else
{
request.grant();
}
}
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 175
AI Operations Management - Containerized 24.4
Script Management
To configure a business rule and use it for KPI calculation:
2. The screen contains a list of business rules, some of which are predefined as indicated by the Type column. You can add new
rules by clicking New or customize a rule by selecting it and clicking Edit . For detailed information about creating
business rules, see the topic How to Create or Edit a Business Rule.
3. After creating a rule, you can include it in a KPI. To create or customize a KPI, click the Repositories tab and select the KPIs link
to show a list of KPIs. Create a new KPI by clicking New or customize a KPI by selecting it and clicking Edit . The new or
customized rules are now included in the Unselected Rules or Selected Rules lists in the KPI Editor dialog.
Note
The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in theInfrastruct
ure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The script must
repeatedly check for Thread.interrupted() , and also during potentially long running statements such as loops.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 176
AI Operations Management - Containerized 24.4
Scripts can be used to trigger custom actions as part of the topology synchronization process, such as:
Manipulate service hierarchies beyond transformation and enrichment limitations posed by model.
Perform post-synchronization actions.
Modify topology data without the need to alter the topology model in OM.
Process flow
Scripts are triggered automatically as part of the hpbsm_wde process.
<OMi_HOME>/log/wde/opr-svcdiscserver.log
If execution of an automatically triggered script negatively affects the synchronization process, both the topology and event
synchronization processes are at risk of being disrupted. Adhere to the best practices described in the topic Best practices as closely as
possible to minimize this risk.
The name of a script file determines where in the topology synchronization process it is executed. Three locations in the process trigger
script files, provided the naming of the script files adheres to the following convention:
1. If present, the script named preEnrichment.groovy is executed before the mapping of OM nodes and services.
2. If present, the script named preUpload.groovy is executed after OM nodes and services are mapped, but before they are uploaded
to the uCMDB.
3. If present, the script named postUpload.groovy is executed after the nodes and services are uploaded to the uCMDB.
Script management
Topology Synchronization scripts are an integral part of the Topology Synchronization package, and are stored in the database when
the package is installed. The topology synchronization process executes the scripts residing in the database without referring to the
scripts in the file system, so if you make changes or additions to the scripts in the file system you must upload the Topology
Synchronization package again.
To remove a script:
1. Use the sdtool command to remove the script from the database.
Note: Scripts installed with the standard installation are present in the file system. Do not delete these scripts, because they
are used by the system.
2. Use the sdtool command to upload the synchronization package to the database.
Note
The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in theInfrastruct
ure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The script must
repeatedly check for Thread.interrupted() , and also during potentially long running statements such as loops.
In a multi-server environment particular care must be taken to keep the scripts in sync. After uploading a synchronization package
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 177
AI Operations Management - Containerized 24.4
including new or modified scripts to the database, the synchronization process on all server is changed according to the scripts
residing in the file system of the server used to upload the package. The scripts residing in the file system of all other servers,
however, no longer match the scripts in the database, so if one of these servers is used to upload scripts, the synchronization may
revert to an earlier, undesired state. To keep this from happening, we recommend using the same server for managing topology
synchronization scripts.
Pre-upload and post-upload scripts included in the same sync package share their scope with respect to variables. Therefore,
values assigned to variables in the preUpload.groovy script can be used in the postUpload.groovy script in the same package. Scripts
across different sync packages do not share the same scope, so the same variable names may be used in scripts as long as they
are not part of the same synchronization package.
Scripts always have access to the scriptInterface and syncData objects. The API functions provided by these objects encapsulate
the internal objects. Always reference these objects rather than accessing the internal objects directly. For example, use
Use only Java interfaces, not classes. Additionally, a set of special factory functions can be used. See also the topic Available APIs.
Example
Suppose that the captions of services that contain the string disk are to be highlighted by adding the prefix >>> and the suffix <<< ,
and the number of changes made is to be reported via email to the Administrator.
Adding the prefixes and suffixes can be done after the OM nodes are mapped. The following preUpload.groovy script changes the
captions and stores the number of changes in the variable iChanges :
iChanges = 0;
// Get all the resolved services using the getConfigurations()
// method of the syncData object and store them in the array services.
arrayServices = syncData.getConfigurationItems();
// Check all elements of the array services for the
// substring "disk", and if found add pre- and suffix and
// increment the counter.
arrayServices.findAll{ it.getCaption().indexOf( "disk" ) >= 0 }.each
{
stringCaption = svc.getCaption();
svc.setCaption( ">>> " + stringCaption + " <<<" );
iChanges++;
}
The email is sent after the upload is completed, as part of the postUpload.groovy script (Note that the sendmail command in the last
example is not available on a standard Windows platform). Because this script is included in the same synchronization package as the
preUpload.groovy script, the variable iChanges is still in scope.
Related topics
Best practices
Available APIs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 178
AI Operations Management - Containerized 24.4
Event forwarding scripts tend to be more complicated than other scripts, because they need to be able to handle the following types of
operations:
Event scripts aren't used to enrich events; for information about scripts to enrich events, see the topic Event Processing Interface
scripts.
OprEvent class
Unlike other scripts, Event Forwarding scripts use the concrete class OprEvent .
The OprEvent class strictly limits code used to modify event information to customization of the receiveChange() method, which is called
when the target server notifies an event change.
The following code is a valid declaration for an implementation of an event forwarding script:
package com.hp.opr.api.ws.adapter;
import com.hp.opr.api.ws.model.event.OprEvent;
public abstract interface ExternalProcessAdapter
{
void init(final InitArgs args);
void destroy();
The OprEvent class is imported, and the script class (which is called ExternalProcessAdapter here, but may have any name) has the
standard init() and destroy() methods. The following methods implement event forwarding:
The ping() method tries to contact the connected server and returns true if successful.
The customizable receiveChange() method receives the external changes, and enables OBM to synchronize changes made by the
external server. The receiveChange() method is called by the Event Synchronization web service to respond to the following HTTP
requests:
/opr-gateway/rest/synchronization/event/<event ID>
/opr-gateway/rest/synchronization/event_change/<event ID>
The HTTP header Content Type must be set to one of the following values:
application/xml
application/json
application/soap+xml
text/xml
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 179
AI Operations Management - Containerized 24.4
text/plain
Note: If the connected server doesn't support synchronization the receiveChange() method should set the HTTP response code in
the argument to 403 (Forbidden), and return false .
The receiveChange() method should return true if it executed successfully and the values passed in the argument have been
updated.
The getExternalEvent() method retrieves event details in response to user requests made using the Event Browser for the events
that have transferred control to a process on the external server. The values corresponding to the event details are received in
and passed by the method's argument GetExternalEventArgs .
The forwardEvents() method forwards the event passed in the method's ForwardEventArgs argument to the external process.
The forwardChanges() method forwards the event changes that have occurred since the last successful call to this method for the
event passed in the method's ForwardChangeArgs argument. The first time the method is called for a particular event all changes
since the event was forwarded are included.
The toExternalEvent() method converts the event to an external object, and is called by the Event Synchronization web service to
respond to the following HTTP request:
/opr-gateway/rest/synchronization/event/<event id>
Process flow
Event forwarding scripts are triggered when a change arrives from the target server as part of the Event Forwarding process.
The logs are provided as Kubernetes container logs for the omi-scripting-host pod. You can view these logs using the following
command:
kubectl -n <namespace> logs -l 'app=omi-scripting-host' -c omi-scripting-host --tail=-1
You can also download the log files from the Event Forwarding user interface. For more information, see Connected Servers.
Script management
Scripts are stored in the database, and can be accessed from the OMi Console.
Along with the Administration Menu, the screen contains two panes:
This pane lists the configured event forwarding rules. Active scripts are shown in black, non active scripts in gray.
2. Details
2. You can't edit the code in the script window directly, but you must use the toolbar in the Event Forwarding Rules pane to access
the script, as follows:
To edit an existing rule, click Edit to open Edit Event Forwarding Rule pane. After making the necessary edit, click
Save.
To configure a new rule, click New to open New Event Forwarding Rule pane. Enter all the details for the new rule and
click Create.
To activate a rule, click the check box Activate rule after creation.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 180
AI Operations Management - Containerized 24.4
Note: The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in the I
nfrastructure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The script must repeatedly check for
Thread.interrupted() , and also during potentially long running statements such as loops.
Example
A sample LogfileAdapter script is provided with the system.
Related topic
Connected Servers
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 181
AI Operations Management - Containerized 24.4
Process flow
Scripts are executed in the omi-scripting-host pod.
The logs are provided as Kubernetes container logs for the omi-scripting-host pod. You can view these logs using the following
command:
kubectl -n <namespace> logs -l 'app=omi-scripting-host' -c omi-scripting-host --tail=-1
You can also download the log files from the External Instruction user interface. For more information, see External Instructions.
When the script execution is triggered by OBM, the event is passed into the script in a read-only state. The script can access all
properties of the event including the specified instruction parameters, such as the instruction interface name (property 'event.instructionI
nterfaceName' ) and the parameter string (property 'event.instructionParameterString' ). As a parameter, you can enter any option that you
want to pass to the external program generating the instruction text, for example a policy variable or a policy parameter configured in
the policy template.
The Instruction Available flag indicates whether the instructions are available for the event (the icon in the I column for the
selected event is displayed). This property is set to true at the time the event is created and stored in the database if the
corresponding message from the agent (received on the OBM server and converted to the event) contains one of the following:
The UUID of the instruction text that was specified in the policy
The name of an instruction text interface to be used for the instruction text retrieval
Additionally, before the events are loaded into the Event Browser, OBM evaluates all active external instruction text interface
definitions and checks whether their event filters match the event. If at least one event filter matches, the Instruction Available
event flag is also set to true.
In situations where you disable or delete the matching external instruction text interface definition and restart the OBM server, the
Instruction Available flag of related events is no longer set to true.
The mapping to an instruction text interface can be achieved in one of the following ways:
By creating one event filter that matches everything and defining one mapping from this event filter to a single Groovy script.
Depending on the instruction interface name of the event that is passed to the script, it is possible to retrieve the instruction text
from different sources.
Tip: To avoid generating a high number of events having the Instruction Available property set to true but containing no actual
instructions, define the event filter so that it only matches the events for which the instruction text is available.
To facilitate the event filtering, you can use the Instruction Interface Name and Instruction Parameter String Advanced
Filter elements. This way, you limit the set of events displayed in the Event Browser to those with the specified instruction
interface and parameter string. For more information about event filters, see the topic Event Filters.
By creating multiple event filters and mappings to Groovy scripts. The first event filter that matches will call the mapped Groovy
script. If you choose this alternative, define event filters so that they do not match the same set of events.
Note: OBM always chooses the first event-matching filter. As it is not possible to define the order in which event filters are
evaluated, you must only define disjunct event filters, that is, the event filters that match different sets of events.
Script management
Scripts are stored in the database and can be accessed from the OBM console.
1. Scripts
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 182
AI Operations Management - Containerized 24.4
This pane lists the configured scripts. Active scripts are shown in black,inactive scripts in gray.
2. Details
This pane shows general and advanced properties of the selected script, including the scripts themselves.
Edit an existing script. Click Edit Item to open the script wizard, and then click the Script tab to access the script for
editing.
Configure a new script. Click New Item to open the script wizard. Enter the script and some information about it, such as
a name and description. The wizard provides a skeleton for the script class, which you can use as a starting point.
Note
The default timeout of 3 seconds applies if you don't give any timeout in the script and don't configure a general timeout in theInfrastruct
ure Settings under Operations Management - EPI Server Settings, EPI Server Timeout . The script must
repeatedly check for Thread.interrupted() , and also during potentially long running statements such as loops.
Script output
The event, including the related instructions, can be viewed in the OBM Event Browser. The instructions are displayed on the
Instructions tab in the Event Details pane.
The Groovy script returns the output in the plain text or the HTML format. If the instruction text contains URLs, they are automatically
converted into hyperlinks. The URLs starting with http:// , https:// , ftp:// , fttps:// , telnet:// , and mailto: URI scheme names are supported.
Note that you can add URLs of external websites, support sites, documentation repositories, troubleshooting information, and so on.
You can also type the address of any website that begins with www.
In the Event Browser, when you click the hyperlink, a new window opens with the page that was returned by the script.
Examples
OBM delivers a predefined content pack containing a sample instruction retrieval script and a filter for external instruction interfaces. A
sample policy is included as well. You can use this initial script as a basis for developing customized scripts to better suit your business
needs. For more information on content packs, see the topic Content Packs.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 183
AI Operations Management - Containerized 24.4
import com.hp.opr.api.scripting.Event
class GroovyScriptSkeleton
{
// called before the method "getInstructions" is called
def init()
{}
// called after the method "getInstructions" is called
def destroy()
{}
// This method gets as parameter the event for which instruction text should be retrieved and
// returns the instruction text that is displayed in the event browser.
def getInstruction(Event event)
{
if ("iti" == event.instructionInterfaceName)
{
// the command to execute; it gets the parameter string (as send by the agent) as argument
// so, if the agent sends the name of the agent system, this command will ping the agent system
// and the output of the ping command is returned as instruction text
def command = "ping -n 1 " + event.instructionParameterString
def proc = command.execute() // execute the command
proc.waitForOrKill(3000) // wait for 5sec before time-out
if (proc.exitValue() == 0)
return "ping of node '" + event.instructionParameterString + "': " + proc.in.text
else
{
if (event.instructionInterfaceName == null)
return "No instructions are available for event with ID '" + event.id + "'."
else
return "Cannot get instructions for interface '" + event.instructionInterfaceName + "'."
}
}
}
// This method gets as parameter the list of events for which instruction text should be retrieved.
// The instruction text for all events is returned as map with the ID of the event as key and the instruction text for this event as value.
def getInstructions(List<Event> events)
{
events.collectEntries { event ->
[ event.id, getInstruction(event) ]
}
}
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 184
AI Operations Management - Containerized 24.4
import com.hp.opr.api.scripting.Event
class GroovyScriptSkeleton
{
def init()
{}
def destroy()
{}
def getInstruction(Event event)
{
if ("iti" == event.instructionInterfaceName)
{
// add your code to retrieve the instruction text from an external source
return """<l><body><h1>My First Heading</h1><p>My first paragraph.</p><a href="http://www.google.com">This is a link</a>
</body></html>"""
}
else
{
return "Cannot get instruction text for interface '" + event.instructionInterfaceName + "'."
}
}
def getInstructions(List<Event> events)
{
events.collectEntries { event ->
[ event.id, getInstruction(event) ]
}
}
}
Although the package com.hp.opr.api.scripting.Event generally allows changes on events (for example AddCustomAttribute("foo","bar") , the
events cannot be updated at this point, so no changes are possible.
Related topics
Event Filters
Content Packs
External Instruction
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 185
AI Operations Management - Containerized 24.4
The topic Groovy console describes how to install the Groovy console, and how to prepare it for developing scripts for OBM. It also
includes tips on debugging scripts.
The topic Available APIs lists internal and external APIs that may be useful when developing Groovy scripts for OBM.
The topic opr-script Command-Line Interface describes how to enable or disable a Groovy script.
Related topics
Groovy console
Available APIs
opr-script Command-Line Interface
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 186
AI Operations Management - Containerized 24.4
Installation
To prepare your environment for developing Groovy scripts:
1. Install Java.
Groovy requires Java version 1.4 or higher. If not already installed, get the latest Java distribution.
Run the installer and set the environment variable JAVA_HOME . On Windows, follow these steps:
1. Open the Control Panel, and go to section System and Security > System.
3. Click the Environment Variables button. The Environment Variables dialog opens.
4. Click New... underneath the User variables box and add a variable JAVA_HOME and assign the path where Java is installed
as its value.
5. Select the variable %Path% in the System variables box, click Edit... and add the variable %JAVA_HOME% to the path.
2. To install the Groovy console, obtain the installer for your operating system from the download page at the official Groovy
website.
By default, the installer adds the environment variable GROOVY_HOME holding the installation path to your system and adds the
path to the binaries to your path. In the rest of this section, %GROOVY_HOME% is used to denote the installation path.
The installer has had some issues with spaces in the installation path. We recommend installing the console in a directory without
spaces in the path.
3. When running the Groovy console on a server other than the OBM Data Processing Server or Gateway Server you must copy all
required platform libraries (jar files) from the OBM server to a predefined location on the groovy system. To make the libraries
available to the Groovy console:
2. Make sure a line with the following format is active (if necessary, add or uncomment it):
load !{user.home}/.groovy/lib/*.jar
4. Copy the libraries to the directory corresponding to user.home , where user.home denotes the directory where the library files
reside.
If in doubt, copy the libraries to the following directory, which is always loaded:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 187
AI Operations Management - Containerized 24.4
%GROOVY_INSTALL%\lib
<install>/lib/commons-*.jar
This library Includes general functions such as the logging function log4j .
JSON Library
<install>/lib/json.jar
<install>/lib/opr-external-api.jar
<install>/lib/opr-common.jar
<install>/lib/ucmdb-api.jar
10.10 2.4.5
10.0x 2.2.1
The Groovy console is an interpreter. Certain errors, such as references to classes without import , are not reported until the line of
code is actually executed.
Make sure you have an import statement for each class used in the script.
Use extensive logging while debugging. Logging can be a very powerful tool to assist in debugging but be careful not to log
unnecessary information. Too many log entries can make it hard to find entries for a specific issue, as well as cause the logs to roll
over too quickly.
Make sure to deactivate the logging code before moving the script to the production environment. Log information that is not to
be deactivated in the production environment should be used sparingly. See also the topic Best Practices.
Your script can be enabled to log to Apache by using the Apache LogFactory class, which is defined in the Apache Common
Libraries. To include the log factory in your script class, declare a member variable of type Log and initialize it to the name of the
log method for the relevant OBM package, for example:
Make sure you declare the member variable as static so it is initialized only once.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 188
AI Operations Management - Containerized 24.4
The package name com.hp.opr.epi should be used if you are using one of the OMi scripts. This will automatically add your log
entries to the EPI scripting log file (see the topic Event Processing Interface scripts).
To access a custom package you must supply the properties file for your package. The properties files can be found in a sub-
directory in the directory conf/core/Tools/log4j . The name of the sub-directory corresponds with the name of the process
triggering your script, as detailed under the heading Trigger for each script type described in section Development and
deployment of scripts.
To adjust the logging level for a script, edit the logging level entry in the appropriate properties file )see previous bullet
point).
To create an Apache log entry, use the following syntax (provided you used the same name for the Log member):
s_log.error("<Error text>")
For example:
Specify the appropriate error level as the method name ( error() in the example). To track the behavior of your script, we
recommend to include a log entry at error level info() so you can verify that script loads successfully.
Related topics
Oracle Java Technology
Apache groovy
Best practices
Event Processing Interface scripts
Development and deployment of scripts
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 189
AI Operations Management - Containerized 24.4
External APIs
Functions Used in EPI Scripts
API for Topology Synchronization Scripts
API for Service Health Rules
External APIs
API
Providing debugging support by logging at runtime without the need to modify the application binary: Use the Apache Log4j logging
API (see also the topic Groovy console).
Communication with RESTful Web services: Use the Wink JSR Client API.
Leveraging the HTTP protocol to retrieve information in an environment using distributed communication: Use the Apache
HTTP Components API.
Communication with Web services supporting Simple Object Access Protocol (SOAP) : Use the Apache Axis2 API.
For detailed information about developing EPI scripts, see the topic Event Processing Interface.
<OMi_HOME>/opr/api/doc/opr-external-api-javadoc.zip
<OMi_HOME>/opr/api/doc/opr-ts-interfaces-javadoc.zip
Exposed Interfaces:
ICi
ICiRelation
ICiMessage
IScriptingInterface
INavigator
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 190
AI Operations Management - Containerized 24.4
INode
ISyncData
Exposed Classes:
CiMessageCategory
CiMessageSeverity
For detailed information about developing topology synchronization scripts, see the topic Integrate topology data.
Related topics
Oracle: JDBC Basics
Groovy console
Apache Log4j logging API
Wink JSR Client API
Apache HTTP Components API
Apache Axis2 API
Event Processing Interface
Integrate topology data
Monitor Event Type and Health Indicators
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 191
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 192
AI Operations Management - Containerized 24.4
This section describes how to use the Rules API to create new business rules. Business rules are used to calculate Key Performance
Indicators (KPIs). A KPI must have an associated business rule that defines how the KPI is calculated.
We recommend to create rules with the Rules API. The Rules API enables you to create rules using the Groovy scripting language with
Groovy runtime environment. Users of the Rules API should be familiar with Groovy and Java, and with OBM administration and
applications. For more information about developing and deploying Groovy scripts, see the topic Groovy scripts.
The Rules API classes are documented in Javadoc format in the OMi Rules API Reference. These files are located in the following folder:
<OMi_HOME_GW>\AppServer\webapps\site.war\amdocs\eng\doc_lib\itom
Group and Sibling Rule. This rule calculates KPIs based on data received from other KPIs, rather than from original sample data.
For details, see the topic API Group and Sibling Rule.
Sample Rule. This rule calculates KPIs based on original data taken from sample fields; the number of samples included in the
calculation is limited by a maximum number of samples rule parameter. For details, see the topic API Sample Rule.
Duration-Based Sample Rule. This rule calculates KPIs based on original data taken from sample fields; a duration parameter
defines which samples are included in the calculation. For details, see the topic API Duration-Based Sample Rule.
These ways are described in the topic Create rules with the Rules API.
You can write to log files from the Rules API code, as described in the topic Write to log files from the Rules API code.
Related Topics
Groovy scripts
API Group and Sibling Rule
API Sample Rule
API Duration-Based Sample Rule
Create rules with the Rules API
Work with tooltip entries
Write to log files from the Rules API code
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 193
AI Operations Management - Containerized 24.4
If you are creating a sibling rule, make sure that the KPI is calculated after its sibling KPIs, as defined by the KPI's Calculation Order
field. For details, see the topic KPI Definitions .
In this interface, the only method is calculateKPI. The method signature is:
public void calculateKPI(CI ci, KPI kpi)
The calculateKPI method includes the parameters ci and kpi, which represent the current CI, and the KPI whose value the API
rule calculates.
** The ci parameter type is CI, and is used as an accessor to KPIs of child CIs or sibling KPIs, or HIs on the CI.
The kpi parameter type is KPI, and is used to set calculation results.
In the following illustration, the Calculated KPI is calculated based on the sibling or child KPIs, and it is represented by the kpi
parameter.
The CI to which the Calculated KPI is assigned, is represented by the ci parameter, and it is an accessor to the other KPIs or HIs.
The Rules API classes are documented in Javadoc format in the OMi Rules API Reference. These files are located in the following folder:
<OMi_HOME_GW>/AppServer/webapps/site.war/amdocs/eng/API_docs/Rules_API/index#$filename|
For detailed examples of Group and Sibling rules, see the topic Examples - API Group and Sibling Rule.
API rules can be defined within the CI Customizations page or Rule Repository, or using a text file template, as described in the topic
Create rules with the Rules API.
The parameters ci and kpi of the calculateKPI method are available for use in this script.
For detailed instructions, see the topics Define an API rule in the CI Customizations page or Define an API rule in the rule repository.
For an example of this, see the topics Example - Specific Child CI Group Rule in Examples - API Group and Sibling Rule.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 194
AI Operations Management - Containerized 24.4
Related Topics
KPI Definitions
Examples - API Group and Sibling Rule
Create rules with the Rules API
Define an API rule in the CI Customizations page
Define an API rule in the rule repository
Example - Specific Child CI Group Rule
Examples - API Group and Sibling Rule
Create a text file-based API rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 195
AI Operations Management - Containerized 24.4
In this interface, the only method is calculateKPI. The method signature is:
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples)
The calculateKPI method includes the parameters ci, kpi, and samples. These represent the current CI, the KPI whose value
the rule calculates, and the samples to be used in the rule calculation based on the Maximum number of samples parameter.
(If this parameter value is 1, list one sample in this field.)
** The kpi parameter type is KPI, and is used to set calculation results.
The samples parameter is a List of Sample objects, which hold sample field values.
The rule must also set the sampleFields field to define which sample fields are held by the Sample object. These values are the
values used by the rule.
For detailed examples of Sample rules, see the topic Examples - API Sample Rule.
API rules can be defined within the CI Customizations page or the Rule Repository, or using a text file template, as described in the
topic Create rules with the Rules API.
The Rules API classes are documented in Javadoc format in the OMi Rules API Reference. These files are located in the following folder:
<OMi_HOME_GW>/AppServer/webapps/site.war/amdocs/eng/API_docs/Rules_API/index#$filename|
KPI Calculation Script. Enter the calculateKPI method implementation. Do not enter the method signature. The parameters ci,
kpi, and samples of the calculateKPI method are available for use in this script.
Maximum number of samples. By default only the most recent sample is included (default=1). You can use this field to change
this setting.
For detailed instructions, see the topics Define an API rule in the CI Customizations page or Define an API rule in the rule repository.
Within the text file, enter the calculateKPI method body, and define the sampleFields field.
Related Topics
Examples - API Sample Rule
Create rules with the Rules API
Define an API rule in the CI Customizations page
Define an API rule in the rule repository
Create a text file-based API rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 196
AI Operations Management - Containerized 24.4
In this interface, the only method is calculateKPI. The method signature is:
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples)
The calculateKPI method includes the parameters ci, kpi, and samples. These represent the current CI, the KPI whose value
the rule calculates, and the list of samples to be used in the rule calculation.
** The kpi parameter type is KPI, and is used to set calculation results.
The samples parameter is a List of Sample objects, which hold sample field values.
The rule must also set the sampleFields field to define which sample fields are held by the Sample object. These values are the
values used by the rule.
For detailed examples of this rule, see the topic Examples - API Sample Rule.
API rules can be defined by using the CI Customizations page, by using a text file, or within the Rule Repository, as described in the
topic Create rules with the Rules API.
The Rules API classes are documented in Javadoc format in the OMi Rules API Reference. These files are located in the following folder:
<OMi_HOME_GW>/AppServer/webapps/site.war/amdocs/eng/API_docs/Rules_API/index#$filename|
KPI Calculation Script. Enter the method implementation. Do not enter the method signature. The parameters ci, kpi, and
samples of the calculateKPI method are available for use in this script.
No data timeout and duration. (Optional) You can define the timeout period and duration parameters, as described in the topic
List of Rule Parameters.
For detailed instructions, see the topics Define an API rule in the CI Customizations page or Define an API rule in the rule repository.
Within the text file, enter the calculateKPI method body, and define the sampleFields field.
Related Topics
Examples - API Sample Rule
Create rules with the Rules API
List of Rule Parameters
Define an API rule in the CI Customizations page
Define an API rule in the rule repository
Create a text file-based API rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 197
AI Operations Management - Containerized 24.4
You can then edit the rule details in the CI Customizations page at any time to change the rule logic for the KPI.
For details, see the topic Define an API rule in the CI Customizations page.
The API code cannot be seen or changed within Service Health, but only within the text file. If you make changes to the code within the
text file, these changes are applied to all instances where the rule has been assigned, after you reload Service Health rules.
For details, see the topic Create a text file-based API rule .
After the rule is applied to a KPI, you can edit rule details within the CI Customizations page at any time to change the rule logic for a
specific KPI.
For details, see the topic Define an API rule in the rule repository.
Related Topics
Define an API rule in the CI Customizations page
Create a text file-based API rule
Define an API rule in the rule repository
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 198
AI Operations Management - Containerized 24.4
To assign an API rule for a specific KPI assigned to a CI, select Administration > Service Health > CI Customizations . Click
New to assign a new KPI to the CI, or Edit to modify an existing KPI. For details on this process, see the topic KPI and Health
Indicator Customizations per CI.
From the list of applicable business rules, select one of the API rules: API Group and Sibling Rule, API Sample Rule, or API Duration-
Based Sample Rule. For a description of the rule types, see the topic Service Health Rules API.
Depending on the type of rule you are creating, define the rule methods and fields as described in:
Related topics
Service Health Rules API
API Group and Sibling Rule
API Sample Rule
API Duration-Based Sample Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 199
AI Operations Management - Containerized 24.4
Create a text file defining a new rule using one of the templates, and then add the new rule to the Business Rule Repository. The rule
can then be applied like any out-of-the-box rule.
The API code cannot be seen or changed within Service Health, but only within the text file. If you make changes to the code within the
text file, these changes are applied to all instances where the rule has been assigned, after you reload Service Health rules.
Based on the type of rule you want to create, copy and rename one of the template files located in the <Data Processing server
root directory>\BLE\rules\groovy\templates directory.
Within your copy of the template, define the rule methods and fields as described in:
Save the file to the <Data Processing server root directory>\BLE\rules\groovy\rules directory.
You must now add a rule in the Rule Repository that uses the rule logic in the text file.
a. Select Administration > Service Health > Business Rules . Click New. For details on adding rules, see the topic
Business Rules.
b. In the Display name field, type the name of the rule you want to create (mandatory).
c. In the Type section, select Java Class as the implementation method. Enter groovy: <file name> as the class name.
Note that the file name must be identical (case sensitive) to the file name in the <Data Processing server root
directory>\BLE\rules\groovy\rules directory.
In the Name field, type Maximum number of samples. In the Type field, select Integer. In the Default Value field,
type 1. Leave the Unit field empty, and the Configurable field unchecked.
In the Name field, type duration. In the Type field, select Long. In the Default Value field, type 990. Leave the Unit
field empty, and the Configurable field unchecked.
Repeat these steps to add the No Data Timeout rule parameter (Type: Long; Default Value = 990).
The following image shows a Sample rule after the rule parameter has been added:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 200
AI Operations Management - Containerized 24.4
The following image shows a Duration-Based Sample rule after the rule parameters have been added:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 201
AI Operations Management - Containerized 24.4
e. Modify the thresholds. (Skip this step if you are defining a Group and Sibling rule that does not have thresholds, where status
is calculated by the rule code.)
Set the threshold values for each operator by using the + and - buttons.
Add the new rule to the list of applicable rules already attached to the relevant KPI. For details, see the Applicable Rules parameter
.
When a rule is created using this procedure, a corresponding tooltip is with no tooltip parameters. For instructions on adding
tooltip parameters to the new tooltip, see the topic Work with tooltip entries.
If you make changes to the text file at any time after the rule is created, perform the following steps to apply the changes.
b. Within OBM-Platform, select the service called MarbleWorker and invoke the reloadRules method. This method is
applied to all the customers served by this worker.
Related Topics
API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 202
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 203
AI Operations Management - Containerized 24.4
Select Administration > Service Health > CI Status Calculation > Business Rules . In the Business Rule Repository page,
clone one of the following rules: API Group and Sibling Rule, API Sample Rule, or API Duration-Based Sample Rule.
c. Edit the KPI Calculation Script rule parameter. In the Default Value field, enter the rule calculation script. The code that
you enter is the default code for this rule, and appears in the CI Customizations page for all KPIs assigned this rule. (Do not
change any other fields.)
d. If you are creating a Sample rule or Duration-Based Sample rule, edit the Sample Fields rule parameter. The sample fields
that you enter are the default sample fields for this rule, and appear in the CI Customizations page for all KPIs assigned this
rule. (Do not change any other fields.)
For details on these rule parameters, see the following sections (depending on the type of rule you are creating):
The Rules API classes are documented in Javadoc format in the OMi Rules API Reference. These files are located in the
following folder:
<OMi_HOME_GW>/AppServer/webapps/site.war/amdocs/eng/API_docs/Rules_API/index#$filename|
3. === Add the rule to the KPI's applicable rules list ===
Add the new rule to the list of applicable rules already attached to the relevant KPI. For details, see the Applicable Rules parameter
in the topic Setting up KPIs and HIs.
Related Topics
Business Rules
API Group and Sibling Rule
API Sample Rule
API Duration-Based Sample Rule
Service Health Concepts
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 204
AI Operations Management - Containerized 24.4
1. Go to:
In the Rule Repository page, add any required Tooltip entries for the new rule. The following table lists common tooltip entries and
their corresponding value sources and formatting methods:
CI name NODE.PROPS.BamNodeNameKey
Status NODE.DIM.RESULT.Status
Value NODE.DIM.RESULT.Value
2. If you have used the kpi.setTooltip method, you must set a corresponding Tooltip entry in the Rule Repository as described
above. In the value field, type the name of the Tooltip entry exactly as used in the code, and leave the Formatting Method
field empty.
For example, if your code contains the method invocation kpi.setTooltip("total_sales", value), type
NODE.DIM.RESULT.total_sales in the value field.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 205
AI Operations Management - Containerized 24.4
Within your API rules, you can write to log files from rule methods using a logger object. There are five log levels: debug, info, warn,
error and fatal. Each of these uses a specific logger method.
By default, only log method invocations of error and fatal severity are written to the log files. You can modify this within the log
configuration files.
Type the name of your API rule inside the log message to identify each log message with its source rule.
2. The Rules API log files are found in the <OMi_HOME_DPS>/log/marble_supervisor/RulesAPI directory.
Open one of the following files to view the log messages (depending on your rule type):
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 206
AI Operations Management - Containerized 24.4
BLE_ATTRIBUTE
BLE_ONLINE_ATTRIBUTE
To add this attribute to a CI class you must export the class, edit the class definition, and import it back to the server. When you open
the exported class for editing, add the following xml to the required attribute:
To retrieve the CI property value of a CI using the API Group and Sibling Rule, you must restart marble_dashboard_tql:
1. Access the RTSM JMX Console on the data processing server: https://localhost:8443/jmx-console/HtmlAdaptor?action=inspectMBean&nam
e=UCMDB:service=TQL%20Services .
2. Invoke retrieveTqlNames().
3. Search for marble_dashboard_tql, and restart the TQL.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 207
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 208
AI Operations Management - Containerized 24.4
Related Topics
Examples - API Sample Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 209
AI Operations Management - Containerized 24.4
Only samples with a u_iStatus value of 0 (available samples) are used in the calculation. The rule logic is: sum(dResponseTime) /
available samples.
Related Topics
Examples - API Sample Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 210
AI Operations Management - Containerized 24.4
Only samples with a u_iStatus value of 0 (available samples) are used in the calculation.
The rule uses an optional rule parameter: Response time limit. If this rule parameter value has been set in the Service Health Admin,
samples with a dResponseTime value greater then the rule parameter value are not used in the calculation.
A rule parameter with the same name must be set for the rule in the Rule Repository. For details, see the topic Business Rules.
/**
* Go over the given samples. If a sample's u_iStatus is equal to 0,
* the sample is considered available.
*/
samples.each {Sample currentSample ->
if (currentSample.u_iStatus == 0) {
/**
* Check the value of the rule parameter.
* If it is not null (meaning the user has set a value),
* and the sample's dResponseTime is greater than the
* rule parameter value, the value is not valid.
*/
boolean isSampleValid = true;
if (responseTimeLimit != null) {
// Check if ResponseTime exceeds the rule parameter value.
if (currentSample.dResponseTime > responseTimeLimit) {
// The sample is not valid.
isSampleValid = false;
}
}
if (isSampleValid) {
// Increase the count of available samples.
availableSamples++;
// Add the sample's dResponseTime value to totalResponseTime.
totalResponseTime += currentSample.dResponseTime
}
}
}
if (availableSamples > 0) {
// Set KPI value, converted to percentage.
kpi.setValue((totalResponseTime / availableSamples))
}
}
Related Topics
Examples - API Sample Rule
Business Rules
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 211
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 212
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 213
AI Operations Management - Containerized 24.4
Related Topics
Examples - API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 214
AI Operations Management - Containerized 24.4
The following rule finds the worst status from sibling KPIs, based on active statuses only. Active statuses are Critical, Major, Minor,
Warning, and OK.
Related Topics
Examples - API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 215
AI Operations Management - Containerized 24.4
The following rule calculates KPI status based on the Availability KPI of a specific child CI (RTSM ID =
"96c2df2b544683c7f79bb382d1d7b3a9").
If the child CI's Availability KPI value is 100, the calculated KPI's status is set to OK. All other values set the KPI's status to Critical.
Status is set only if the child CI exists, has the Availability KPI, and its Availability KPI has value.
// Check if childKPI is not null. It is null if no child CI with this RTSM ID exists, or if this CI does not have the Availability KPI.
if (childKPI != null) {
Related Topics
Examples - API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 216
AI Operations Management - Containerized 24.4
The following rule calculates KPI status based on the status of sibling Availability and Performance KPIs.
If these KPIs do not exist or do not have active status, no status is set.
If these sibling KPIs exist and are both OK, the calculated KPI status is set to OK. Otherwise, its status is set to Critical. (Active statuses
are Critical, Major, Minor, Warning, and OK.)
Related Topics
Examples - API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 217
AI Operations Management - Containerized 24.4
The following rule calculates the average status of the KPIs of child CIs, which are of the same CI type as the calculated KPI.
Only child CIs of type "unix" are used in the calculation. If there are no child CIs of this type, or no child CI KPIs have value, no value is
set for the KPI.
Related Topics
Examples - API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 218
AI Operations Management - Containerized 24.4
Related Topics
Examples - API Group and Sibling Rule
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 219
AI Operations Management - Containerized 24.4
This rule illustrates Groovy Closure. Refer to the Groovy documentation for more information.
Closure description:
{ KPI childKPI ->
childKPI.type == KpiType.Availability.getID("DASHBOARD") && childKPI.status == Status.MAJOR
}
The Closure defines one parameter named childKPI of type KPI.
Each KPI from the CI`s child CIs will be passed to the Closure by the getChildrenKPIs method.
The Closure body returns a boolean value based on the logical expression result.
Each KPI that the Closure body will return true for, will be part of the returned List
The expression KpiType.Availability.getID("DASHBOARD") returns an int representing the Availability KPI ID from the Service Health KPI Reposito
ry.
*/
Related Topics
Examples - API Group and Sibling Rule
Groovy Closure
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 220
AI Operations Management - Containerized 24.4
Retrieve Indicator Data API. You can use this API to access KPI over time statuses, KPI definitions, and indicator statuses.
Reset Health Indicator State API. In certain event flows, you might have an HI showing that a problem has occurred but no event
has closed the problem, even though the problem was fixed. After dealing with the problem, you can use this API to reset the HI's
state to Normal.
Service Health Database Query API. You can use this API to query the database and return a list of views in XML format.
Related Topics
Retrieve Indicator Data API
Reset Health Indicator State API
Service Health Database Query API
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 221
AI Operations Management - Containerized 24.4
Authentication should be done using the basic access authentication method. For details and examples see the related Wikipedia
article.
API Syntax
https://obm.example.com/topaz/servicehealth/customers/1/kpiOverTime?
ciIds=0b656ce308022a6739e3e726497fda6a&startDate=1296499370000
&endDate=1296501466000
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 222
AI Operations Management - Containerized 24.4
<kpiStatuses>
<kpiStatus>
<ciId>0b656ce308022a6739e3e726497fda6a</entityId>
<ciDisplayLabel>ATM 1610</ciDisplayLabel>
<kpiType>6</kpiType>
<kpiDisplayName>Application Performance</kpiDisplayName>
<timeStamp>1296499370000</timeStamp>
<status>20</status>
<statusDisplayName>OK</statusDisplayName>
<duration>311000</duration>
</kpiStatus>
<kpiStatus>
<ciId>0b656ce308022a6739e3e726497fda6a</entityId>
<ciDisplayLabel>ATM 1610</ciDisplayLabel>
<kpiType>6</kpiType>
<kpiDisplayName>Application Performance</kpiDisplayName>
<timeStamp>1296499681000</timeStamp>
<status>-2</status>
<statusDisplayName>No Data</statusDisplayName>
<duration>1785000</duration>
</kpiStatus>
<kpiStatus>
<ciId>0b656ce308022a6739e3e726497fda6a</entityId>
<ciDisplayLabel>ATM 1610</ciDisplayLabel>
<kpiType>6</kpiType>
<kpiDisplayName>Application Performance</kpiDisplayName>
<timeStamp>1296501466000</timeStamp>
<status>20</status>
<statusDisplayName>OK</statusDisplayName>
<duration>13334000</duration>
</kpiStatus>
<kpiStatus>
<ciId>0b656ce308022a6739e3e726497fda6a</entityId>
<ciDisplayLabel>ATM 1610</ciDisplayLabel>
<kpiType>7</kpiType>
<kpiDisplayName>Application Availability</kpiDisplayName>
<timeStamp>1296428400000</timeStamp>
<status>0</status>
<statusDisplayName>Critical</statusDisplayName>
<duration>69663000</duration>
</kpiStatus>
</kpiStatuses>
Field Description
ciId CI ID
kpiType KPI ID
timeStamp Start time for the KPI status; value representing the date in milliseconds since January 1 1970
status KPI status (see the topic Write to log files from the Rules API code)
Return Codes
The API returns the following return codes:
BAD_REQUEST 400
UNAUTHORIZED 401
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 223
AI Operations Management - Containerized 24.4
INTERNAL_
500
SERVER_ERROR
API Syntax
https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/
repositories/indicators/statuses
https://host.devlab.ad/topaz/servicehealth/customers/1/repositories/
indicators/statuses
<targets>
<target>
<id>20</id>
<name>OK</name>
</target>
<target>
<id>15</id>
<name>Warning</name>
</target>
<target>
<id>10</id>
<name>Minor</name>
</target>
<target>
<id>5</id>
<name>Major</name>
</target>
<target>
<id>0</id>
<name>Critical</name>
</target>
<target>
<id>-1</id>
<name>Info</name>
</target>
<target>
<id>-2</id>
<name>No Data</name>
</target>
<target>
<id>-4</id>
<name>Downtime</name>
</target>
</targets>
Field Description
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 224
AI Operations Management - Containerized 24.4
Return Codes
The API returns the following return codes:
INTERNAL_
500
SERVER_ERROR
Related Topics
Wikipedia: basic access authentication
Write to log files from the Rules API code
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 225
AI Operations Management - Containerized 24.4
The Reset HI State API enables users outside of the OBM user interface to reset event-based HIs to their default state, using the HTTP-
based REST protocol.
You can reset all HIs on a specific CI, or reset a specific HI.
Note: This API can impact the overall performance of your system; consult with Professional Services before using the API.
API Syntax
To reset all HIs related to a CI:
HI name refers to the name of the HI as defined in the indicator repository, and not to the HI's display label.
OK 200
UNAUTHORIZED 401
NOT_FOUND 404
INTERNAL_
500
SERVER_ERROR
Related Topics
Health Indicators Component
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 226
AI Operations Management - Containerized 24.4
You can use the Service Health API to query the database and return a list of views in XML format.
Tip: You can use XSLT to convert the XML output into any other format (commonly text or HTML). For example, using basic XSLT
transformations, you can produce HTML reports that are formatted to fit on mobile devices. These reports can be served via a mobile
portal to display critical Operations Bridge Manager views on users' mobile phones.
Query Syntax
The basic syntax of the query is as follows:
Depending on the command parameter defined, additional parameters may also be included.
Parameter Description
userName Specify a user name defined in OBM. The query does not encrypt the login credentials.
password Specify the password for the user name provided. The query does not encrypt the login credentials.
getViews – Specify to retrieve all views from the Run-time Service Model (RTSM). No other parameters are required.
command
getNodes – Specify to retrieve all child nodes of a specified view (you must also specify the view for which to retrieve child
nodes in the viewName parameter); if using this command parameter you can also set the following parameters:
showTooltip, depth, layout, xsltURL, responseContentType
If the getNodes command parameter is defined, include this parameter in the query and specify the view to retrieve. You
viewName
can set the value to ticker_all_views to retrieve all views and their nodes.
If the getNodes command parameter is defined, you can include this parameter in the query to specify whether to display
showTooltip
Service Health's KPI tooltip data, either true to display data or false to not. The default value is false.
If the getNodes command parameter is defined, you can include this parameter in the query to specify the number of levels
depth
in the view to display. The default value is 1.
If the getNodes command parameter is defined, you can include this parameter in the query to specify the layout for the
layout query results, either hierarchical or flat. In flat mode all nodes are retrieved in a flat list, and in hierarchical mode nodes are
retrieved in the same hierarchy as in the view. The default value is flat.
If the getNodes command parameter is defined, you can include this parameter in the query to specify a URL to an .xslt file
xsltURL
that transforms the .xml-format result of the query.
If the getNodes command parameter is defined, and the xsltURL parameter is included in the query, you can include this
responseContentType
parameter in the query to specify the response MIME type.
Query Examples
Below are examples of queries and the data they return.
The following query returns a flat list of all views in the Run-time Service Model (RTSM):
https://myserver/topaz/bam/BAMOpenApi?customerId=1
&userName=admin&password=admin&command=getViews
The following query returns a hierarchical tree showing KPI status and tooltip information for the Service Measurements view, to a
depth of three child nodes:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 227
AI Operations Management - Containerized 24.4
https://myserver/topaz/bam/BAMOpenApi?customerId=1&userName=
admin&password=admin&command=getNodes&viewName=Service%20
Measurements&showTooltip=true&depth=3&layout=hierarchical
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 228
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 229
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 230
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 231
AI Operations Management - Containerized 24.4
The following sections can help you understand what you need to know and do to successfully manage and execute a discovery
development project.
Assume a working knowledge of Universal CMDB and some basic familiarity with the elements of the system. It is meant to assist
you in the learning process and does not provide a complete guide.
Cover the stages of planning, research, and implementation of new discovery content for Universal CMDB, together with
guidelines and considerations that need to be taken into account.
Provide information on the key APIs of the Data Flow Management Framework. For full documentation on the available APIs, see
Data Flow Management SDK. (Other non-formal APIs exist but even though they are used on out-of-the-box adapters, they may be
subject to change.)
Related topics
Data Flow Management SDK
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 232
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 233
AI Operations Management - Containerized 24.4
Once you are satisfied with the way the adapter looks and works, you are ready to package it. Using either the UCMDB Package
Manager or manual exporting of the components, create a package *.zip file. As a best practice, you should deploy and test this
package on another UCMDB system before releasing it to production, to ensure that all the components are accounted for and
successfully packaged. For details on packaging, see Package Manager.
The following sections expand on each of the phases, showing the most critical steps and best practices:
The Research and Preparation phase encompasses the driving business needs and use cases, and also accounts for securing the
necessary facilities to develop and test the adapter.
1. When planning to modify an existing adapter, the first technical step is to make a backup of that adapter and ensure you can
return it to its pristine state. If you plan to create a new adapter, copy the most similar adapter and save it under an appropriate
name. For details, see Resources pane.
2. Research the method which the adapter should use to collect data:
Develop how the adapter should create CIs based on the data
5. Unzip the package contents into the work space and rename the adapter (XML) and Jython (.py) files.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 234
AI Operations Management - Containerized 24.4
The Adapter Development and Testing phase is a highly iterative process. As the adapter begins to take shape, you begin testing
against the final use cases, make changes, test again, and repeat this process until the adapter complies with the requirements.
Modify XML parts of the adapter: Name (id) in line 1, Created CI Types, and Called Jython script name.
Get the copy running with identical results to the original adapter.
Comment out most of the code, especially the critical result-producing code.
Remove debugging
Comment all functions and add some opening comments in the main section
Create sample TQL and view for the user to test
Create Package
Export adapters, TQL, and so on with the Package Manager. For details, see Package Manager.
Check any dependencies your package has on other packages, for example, if the CIs created by those packages are input CIs to
your adapter.
Use Package Manager to create a package zip. For details, see Package Manager.
Test deployment by removing parts of the new content and redeploying, or deploying on another test system.
Related topics
Resourcespane
Package Manager
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 235
AI Operations Management - Containerized 24.4
Note that these definitions do not distinguish between the methods of collection. Neither does DFM. The process of developing a new
adapter is the same process for developing new integration. You do the same research, make the same choices for new vs. existing
adapters, write the adapters the same way, and so on. Only a few things change:
The final adapter's scheduling. Integration adapters may run more frequently than discovery, but it depends on the use cases.
Input CIs:
Integration Non-CI trigger to run with no input: a file name or source is passed through the adapter parameter.
For integration projects, you should almost always reuse an existing adapter. The direction of the integration (from Universal CMDB to
another product, or from another product to Universal CMDB) may affect your approach to development. You can use other integrations
available in the content pack or on Community Content of ITOM Marketplace.
Use a generic wrapper adapter to run the TQL and write the results to an XML file for the external product to read.
To integrate another product to Universal CMDB, depending on how the other product exposes its data, the integration adapter acts
differently:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 236
AI Operations Management - Containerized 24.4
The content may not always be used for application mapping, although this is a common intermediate step for many use cases.
Regardless of the end use of the content, your plan should answer the following questions:
Who is the consumer? How should the consumer act on the information provided by the CIs (and the relationships between them)?
What is the business context in which the CIs and relationships are to be viewed? Is the consumer of these CIs a person or a
product or both?
Once the perfect combination of CIs and relationships exists in the CMDB, how do I plan on using them to produce business value?
What should the perfect mapping look like?
What term would most meaningfully describe the relationships between each CI?
What types of CIs would be most important to include?
What is the end usage and end user of the map?
What would be the perfect report layout?
Once the business justification is established, the next step is to embody the business value in a document. This means picturing the
perfect map using a drawing tool and understanding the impact and dependencies between CIs, reports, how changes are tracked,
what change is important, monitoring, compliance, and additional business value as required by the use cases.
For example, if it is critical for the application to know when a certain configuration file has changed, the file should be mapped and
linked to the appropriate CI (to which it relates) in the drawn map.
Work with an SME (Subject Matter Expert) of the area, who is the end user of the developed content. This expert should point out the
critical entities (CIs with attributes and relationships) that must exist in the CMDB to provide business value.
One method could be to provide a questionnaire to the application owner (also the SME in this case). The owner should be able to
specify the above goals and blueprint. The owner must at least provide a current architecture of the application.
You should map critical data only and no unnecessary data: you can always enhance the adapter later. The goal should be to set up a
limited discovery that works and provides value. Mapping large quantities of data gives more impressive maps but can be confusing
and time consuming to develop.
Once the model and business value is clear, continue to the next stage. This stage can be revisited as more concrete information is
provided from the next stages.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 237
AI Operations Management - Containerized 24.4
If an existing adapter does some, but not all, of the job, your first approach should be to evaluate the existing adapters and verify if one
of them almost does what is needed; if it does, you can modify the existing adapter.
You should also evaluate if an existing field adapter is available. Field adapters are discovery adapters that are available but are not
out-of-the-box. Contact support to receive the current list of field adapters.
When it is faster to write an adapter than to insert the information manually into the CMDB (generally, from about 50 to 100 CIs
and relationships) or it is not a one-time effort.
When the need justifies the effort.
If out-of-the-box or field adapters are not available.
If the results can be reused.
When the target environment or its data is available (you cannot discover what you cannot see).
Model research
Browse the UCMDB class model (CI Type Manager) and match the entities and relations from your blueprint to existing CITs. It is
highly recommended to adhere to the current model to avoid possible complications during version upgrade. If you need to extend
the model, you should create new CITs since an upgrade may overwrite out-of-the-box CITs.
If some entities, relations, or attributes are lacking from the current model, you should create them. It is preferable to create a
package with these CITs (which will also later hold all the discovery, views, and other artifacts relating to this package) since you
need to be able to deploy these CITs on each installation of Universal CMDB.
Technology research
Once you have verified that the CMDB holds the relevant CIs, the next stage is to decide how to retrieve this data from the relevant
systems.
Retrieving data usually involves using a protocol to access a management part of the application, actual data of the application, or
configuration files or databases that are related to the application. Any data source that can provide information on a system is
valuable. Technology research requires both extensive knowledge of the system in question and sometimes creativity.
For home-grown applications, it may be helpful to provide a questionnaire form to the application owner. In this form the owner should
list all the areas in the application that can provide the information needed for the blueprint and business values. This information
should include (but does not have to be limited to) management databases, configuration files, log files, management interfaces,
administration programs, Web services, messages or events sent, and so on.
For off-the-shelf products, you should focus on documentation, forums, or support of the product. Look for administration guides, plug-
ins and integrations guides, management guides, and so on. If data is still missing from the management interfaces, read about the
configuration files of the application, registry entries, log files, NT event logs, and any artifacts of the application that control its correct
operation.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 238
AI Operations Management - Containerized 24.4
with the effort or risk of getting it. Sometimes you may decide to reduce the blueprint if the value or cost does not warrant the invested
effort.
Reuse: If Universal CMDB already includes a specific connection protocol support it is a good reason to use it. It means the DFM
Framework is able to supply a ready made client and configuration for the connection. Otherwise, you may need to invest in
infrastructure development. You can view the currently supported Universal CMDB connection protocols in the Data Flow
Management > Data Flow Probe Setup > Domains and Probes pane.
You can add new protocols by adding new CIs to the model. For details, contact support.
Note
Security: Access to information usually requires credentials (user name, password), which are entered in the CMDB and are kept
secure throughout the product. If possible, and if adding security does not conflict with other principles you have set, choose the least
sensitive credential or protocol that still answers access needs. For example, if the information is available both through JMX (standard
administration interface, limited) and Telnet, it is preferable to use JMX since it inherently provides limited access and (usually) no
access to the underlying platform.
Comfort: Some management interfaces may include more advanced features. For example, it might be easier to issue queries (SQL,
WMI) than to navigate information trees or build regular expressions for parsing.
Developer Audience: The people who will eventually develop adapters may have an inclination towards a certain technology. This
can also be considered if two technologies provide almost the same information at an equal cost in other factors.
Summary
The outcome of this stage is a document describing the access methods and the relevant information that can be extracted from each
method. The document should also contain a mapping from each source to each relevant blueprint data.
Each access method should be marked according to the above instructions. Finally, you should now have a plan of which sources to
discover and what information to extract from each source into the blueprint model (which should by now have been mapped to the
corresponding UCMDB model).
Related topics
Adapter development and writing overview
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 239
AI Operations Management - Containerized 24.4
Note
Federation and Population flows may be configured for the same integration, for maximum
flexibility.
Should the integration copy data into the CMDB? Should the data be tracked by history? Is the source unreliable?
Should the integration federate data on the fly for views and TQL queries? Is the accuracy of changes to data critical? Is the
amount of data too large to copy to the CMDB, but the requested amount of data is usually small?
If you answer yes to this question, then decrease the ID length for all concerning CIs, so that their IDs do not exceed the
maximum length of 60 characters.
For details about the different types of integrations, see Integration Studio.
1. Jython Adapter:
Written in Jython
2. Generic DB Adapter:
An abstract adapter based on the Java Adapter that uses the Federation SDK Framework.
Supports both Federation and Population (with a Java plug-in implemented for changes support).
Relatively easy to define, as it is based mainly on XML and property configuration files.
Main configuration is based on an orm.xml file that maps between UCMDB classes and database columns.
An abstract adapter based on the Java Adapter (the Federation SDK Framework) and the Jython Adapter.
Relatively easy to define, as you need only to define the mapping between UCMDB classes and XML, and a Jython script that
pushes the data to the target.
A root-element-based adapter
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 240
AI Operations Management - Containerized 24.4
For details, see Achieving Data Push using the Generic Adapter.
Flow/Adapter Jython Adapter Generic DB Adapter Generic Push Adapter Enhanced Generic Push Adapter
Federation No Yes No No
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 241
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 242
AI Operations Management - Containerized 24.4
Note that the minimum notion of an adapter is two files: an XML document and a Jython script. The Discovery Framework, including
input CIs, credentials, and user-supplied libraries, is exposed to the adapter at run time. Both discovery adapter components are
administered through Data Flow Management. They are stored operationally in the CMDB itself; although the external package
remains, it is not referred to for operation. The Package Manager enables preservation of the new discovery and integration content
capability.
Input CIs to the adapter are provided by a TQL, and are exposed to the adapter script in system-supplied variables. Adapter parameters
are also supplied as destination data, so you can configure the adapter's operation according to an adapter's specific function.
The DFM application is used to create and test new adapters. You use the Universal Discovery, Adapter Management, and Data Flow
Probe Setup pages during adapter writing.
Adapters are stored and transported as packages. The Package Manager application and the JMX console are used to create packages
from newly created adapters, and to deploy adapters on new systems.
Related topics
Run discovery from UCMDB Web UI using custom jobs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 243
AI Operations Management - Containerized 24.4
The following are guidelines and best practices for dividing the adapter process:
Discovery should be done in stages. Each stage should be represented by an adapter that should map an area or tier of the
system. Adapters should rely on the previous stage or tier to be discovered, to continue discovery of the system. For example,
Adapter A is triggered by an application server TQL result and maps the application server tier. As part of this mapping, a JDBC
connection component is mapped. Adapter B registers a JDBC connection component as a trigger TQL and uses the results of
adapter A to access the database tier (for example, through the JDBC URL attribute) and maps the database tier.
The two-phase connect paradigm: Most systems require credentials to access their data. This means that a user/password
combination needs to be tried against these systems. The DFM administrator supplies credentials information in a secure way to
the system and can give several, prioritized login credentials. This is referred to as the Protocol Dictionary. If the system is not
accessible (for whatever reason) there is no point in performing further discovery. If the connection is successful, there needs to
be a way to indicate which credential set was successfully used, for future discovery access.
These two phases lead to a separation of the two adapters in the following cases:
Connection Adapter: This is an adapter that accepts an initial trigger and looks for the existence of a remote agent on that
trigger. It does so by trying all entries in the Protocol Dictionary which match this agent's type. If successful, this adapter
provides as its result a remote agent CI (SNMP, WMI, and so on), which also points to the correct entry in the Protocol
Dictionary for future connections. This agent CI is then part of a trigger for the content adapter.
Content Adapter: This adapter's precondition is the successful connection of the previous adapter (preconditions specified by
the TQLs). These types of adapters no longer need to look through all of the Protocol Dictionary since they have a way to
obtain the correct credentials from the remote agent CI and use them to log in to the discovered system.
Different scheduling considerations can also influence discovery division. For example, a system may only be queried during off
hours, so even though it would make sense to join the adapter to the same adapter discovering another system, the different
schedules mean that you need to create two adapters.
Discovery of different management interfaces or technologies to discover the same system should be placed in separate adapters.
This is so that you can activate the access method appropriate for each system or organization. For example, some organizations
have WMI access to machines but do not have SNMP agents installed on them.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 244
AI Operations Management - Containerized 24.4
1. Create an adapter.
You configure an adapter file that holds the context, parameters, and result types by selecting the scripts that are to be part of
the adapter. For details, see Step 1: Create an adapter.
You configure a job with scheduling information and a trigger query. For details, see Step 2: Assign a job to the adapter.
You can edit the Jython or Java code that is contained in the adapter files and that refers to the DFM Framework. For details, see
Step 3: Create Jython code.
To write new adapters, you create each of the above components, each one of which is automatically bound to the component in the
previous step. For example, once you create a job and select the relevant adapter, the adapter file binds to the job.
Adapter code
The actual implementation of connecting to the remote system, querying its data, and mapping it as CMDB data is performed by the
Jython code. For example, the code contains the logic for connecting to a database and extracting data from it. In this case, the code
expects to receive a JDBC URL, a user name, a password, a port, and so on. These parameters are specific for each instance of the
database that answers the TQL query. You define these variables in the adapter (in the Trigger CI data) and when the job runs, these
specific details are passed to the code for execution.
The adapter can refer to this code by a Java class name or a Jython script name. In this section we discuss writing DFM code as Jython
scripts.
An adapter can contain a list of scripts to be used when running discovery. When creating a new adapter, you usually create a new
script and assign it to the adapter. A new script includes basic templates, but you can use one of the other scripts as a template by
right-clicking it and selecting Save as:
For details on writing new Jython scripts, see Step 3: Create Jython Code. You add scripts through the Resources pane:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 245
AI Operations Management - Containerized 24.4
The list of scripts are run one after the other, in the order in which they are defined in the adapter:
Note
A script must be specified even though it is being used solely as a library by another script. In this case, the library script must be defined
before the script using it. In this example, the processdbutils.py script is a library used by the last host_processes.py script. Libraries
are distinguished from regular runnable scripts by the lack of the DiscoveryMain() function.
Related topics
Step 1: Create an adapter
Step 2: Assign a job to the adapter
Step 3: Create Jython code
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 246
AI Operations Management - Containerized 24.4
Each adapter specifies input and output: Both input and output are Trigger CIs that are specifically defined in the adapter. The adapter
extracts data from the input Trigger CI and passes this data as parameters to the code. Data from related CIs is sometimes passed to
the code too. For details, see Related CIs Window. An adapter's code is generic, apart from these specific input Trigger CI parameters
that are passed to the code.
In this example, variables replace the IpAddress CI data with actual values that exist on real IpAddress CI instances in your system.
The Triggered CI data for the IpAddress CI includes a fileName variable. This variable enables the replacement of the
CONFIGURATION_DOCUMENT node in the Input TQL with the actual values of the configuration file located on a host:
The Trigger CI data is uploaded to the Probe with all variables replaced by actual values. The adapter script includes a command to use
the Data Flow Management framework to retrieve the actual values of the defined variables:
Framework.getTriggerCIData ('ip_address')
The fileName and path variables use the data_name and document_path attributes from the CONFIGURATION_DOCUMENT node
(defined in the Input Query Editor – see previous example).
The Protocol , credentialsId , and ip_address variables use the root_class , credentials_id , and application_ip attributes:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 247
AI Operations Management - Containerized 24.4
The Trigger CIT defines which CIT is used as the input for the adapter. For example, for an adapter that is going to discover IPs, the
input CIT is Network.
The Input query is a regular, editable query that defines the query against the CMDB. The Input Query defines additional
constraints on the CIT (for example, if the task requires a hostID or application_ip attribute), and can define more CI data, if needed
by the adapter.
If the adapter requires additional information from the CIs that are related to the Trigger CI, you can add additional nodes to the
input TQL. For details, see Add Query nodes and relationships to a TQL Query .
The Trigger CI data contains all the required information on the Trigger CI as well as information from the other nodes in the
Input TQL, if they are defined. DFM uses variables to retrieve data from the CIs. When the task is downloaded to the Probe, the
Trigger CI data variables are replaced with actual values that exist on the attributes for real CI instances.
If the value of the destination data is a list, you can define the number of items from the list to be sent to the probe. To define it,
add a colon after the default value followed by the number of items. If there is no default value for the destination data, enter two
colons.
For example, if the following destination data is entered: name=portId, value= ${PHYSICALPORT.root_id:NA:1} or name=portId, value= $
{PHYSICALPORT.root_id::1} , only the first port from the port list is sent to the probe.
You can also view the CITs as a topology map, that is, the components and the way in which they are linked together (click the View
Discovered CITs as Map button):
The discovered CIs are returned by the DFM code (that is, the Jython script) in the format of UCMDB's ObjectStateHolderVector . For
details, see Results generation by the Jython script.
In this example, you define which CITs are to be part of the IP CI output.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 248
AI Operations Management - Containerized 24.4
4. The CITs that are to be part of the adapter output are listed. Add CITs to, or remove from, the list. For details, see Adapter
Definition Tab.
This example illustrates overriding an adapter parameter so that one adapter can be used to discover both Microsoft SQL Server and
Oracle databases.
3. In the Adapter Definition tab, locate the Adapter Parameters pane. The protocolType parameter has a value of all:
4. Right-click the SQL_NET_Dis_Connection_MsSql adapter and choose Go to Discovery Job > MSSQL Connection by SQL .
Note: The Oracle Connection by SQL job includes the same parameter but the value is overwritten with an Oracle value.
For details on adding, deleting, or editing parameters in the Adapter Parameters pane, see Adapter Definition Tab.
DFM begins looking for Microsoft SQL Server instances according to this parameter.
The automatic probe selection is done according to the CI’s related node. After obtaining the CI’s related node, the dispatching
mechanism chooses one of the node’s IPs and chooses the probe according to the probe’s network scope definitions.
In the following cases, you need to specify the probe manually and not use the automatic dispatching mechanism:
For example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 249
AI Operations Management - Containerized 24.4
For the IP address CI type: Take the probe that is defined for this IP.
For the running software CI type: Use the attributes application_ip and application_ip_domain and choose the probe that
is defined for the IP in the relevant domain.
For other CI types: Take the node’s IP according to the CI’s related node (if it exists).
You already know which probe should be run for the adapter and you do not need the automatic dispatching mechanism to select
the probe (for example if the trigger CI is the probe gateway).
The automatic probe selection might fail. This can happen in the following situations: a) A trigger CI does not have a related node
(such as the network CIT); b) A trigger CI’s node has multiple IPs, each belonging to a different probe.
The Probe's IP address. Once you select your probe inLocal Client > Data Flow Management > Data Flow Probe Setup >
IP
Domains and Probes > <domain> > Data Flow Probes, check the Probe IPs value in the right pane for the IP address of the
address
probe.
Domain
The domain from which the Probe should be selected.
name
Related topics
Related CIs window
Data Flow Management concepts
Add Query nodes and relationships to a TQL Query
Results generation by the Jython script
Adapter Definition tab
Configure Remote Process Execution
Data Flow Management SDK
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 250
AI Operations Management - Containerized 24.4
The jobs appear in the Discovery Modules tree, and this is the entity that the user activates, as shown in the picture below (click to
enlarge).
A Trigger TQL can add constraints to an Input TQL. For example, if an input TQL's results are IPs connected to SNMP, a trigger TQL's
results can be IPs connected to SNMP within the range 195.0.0.0-195.0.0.10.
Note
A trigger TQL must refer to the same objects that the input TQL refers to. For example, if an input TQL queries for IPs running SNMP, you
cannot define a trigger TQL (for the same job) to query for IPs connected to a host, because some of the IPs may not be connected to an SNMP
object, as required by the input TQL.
For each scheduled occurrence for each job, the Probe runs the code against all Trigger CIs accumulated for that job. For details, see
Discovery Scheduler dialog box.
Related topics
Discovery Scheduler dialog box
Override adapter parameters
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 251
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 252
AI Operations Management - Containerized 24.4
For example, you can run the job in a separate remote process if the job uses .jar libraries that are a different version than the Probe's
libraries or that are incompatible with the Probe's libraries.
You can also run the job in a separate remote process if the job potentially consumes a lot of memory (brings a lot of data) and you
want to isolate the Probe from potential OutOMemory problems.
To configure a job to run as a remote process, define the following parameters in its adapter's configuration file:
Parameter Description
runInSeparateProcess When set to true, the discovery job runs in a separate process.
(Optional) Enables customization of the classpath of the remote process, overriding the default Probe classpath. This is useful
if there might be version incompatibility between the Probe's jars and custom jars required for the customer-defined
discovery.
If the remoteJVMClasspath parameter is not defined, or is left empty, the default Probe classpath is used.
If you develop a new discovery job and you want to ensure that the Probe jar library version does not collide with the job's jar
libraries, you must use at least the minimal classpath required to execute basic discovery. The minimal classpath is defined in
the DataFlowProbe.properties file in the basic_discovery_minimal_classpath parameter.
custom1.jar;%classpath%;custom2.jar -
In this case, custom1.jar is placed before default Probe classpath, and custom2.jar is appended to the Probe
classpath.
custom1.jar;%minimal_classpath%;custom2.jar
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 253
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 254
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 255
AI Operations Management - Containerized 24.4
For details on how to work in Jython, you can refer to these websites:
http://www.jython.org
http://www.python.org
The following section describes the actual writing of Jython code inside the DFM Framework. This section specifically addresses those
contact points between the Jython script and the Framework that it calls, and also describes the Jython libraries and utilities that should
be used whenever possible.
Note
Related topics
For full documentation on the available APIs, see
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 256
AI Operations Management - Containerized 24.4
These resources should be bundled in the package under the External Resources folder. Any resource put in this folder is
automatically sent to any Probe that connects to your Universal CMDB server.
In addition, when discovery is launched, any JAR file resource is loaded into the Jython's classpath, making all the classes within it
available for import and use.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 257
AI Operations Management - Containerized 24.4
The Probe starts running the DFM code using the information specified in the task.
The Jython code flow starts running from a main entry in the script, runs code to discover CIs, and provides results of a vector of
discovered CIs.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 258
AI Operations Management - Containerized 24.4
For example, the following single line of code in an out-of-the-box script calls a method that calculates a Web server name in an
application-specific way:
The more complex logic that decides how to calculate this name is contained in an external script:
Save the external script in the External Resources folder. For details, see Resources pane. If you add this script to a package, you can
use this script for other jobs, too. For details on working with Package Manager, see Package Manager.
During upgrade, the change you make to the single line of code is overwritten by the new version of the out-of-the-box script, so you
will need to replace the line. However, the external script is not overwritten.
Related topics
Resources pane
Package Manager
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 259
AI Operations Management - Containerized 24.4
Imports
Main Function - DiscoveryMain
Functions definitions (optional)
# imports section
from appilog.common.system.types import ObjectStateHolder
from appilog.common.system.types.vectors import ObjectStateHolderVector
# Function definition
def foo:
# do something
# Main Function
def DiscoveryMain(Framework):
OSHVResult = ObjectStateHolderVector()
## Write implementation to return new result CIs here...
return OSHVResult
Imports
Jython classes are spread across hierarchical namespaces. In version 7.0 or later, unlike in previous versions, there are no implicit
imports, and so every class you use must be imported explicitly. (This change was made for performance reasons and to enable an
easier understanding of the Jython script by not hiding necessary details.)
import logger
The DiscoveryMain function is the main entry into the script; it is the first function that runs. The main function may call other functions
that are defined in the scripts:
def DiscoveryMain(Framework):
The Framework argument must be specified in the main function definition. This argument is used by the main function to retrieve
information that is required to run the scripts (such as information on the Trigger CI and parameters) and can also be used to report on
errors that occur during the script run.
You can create a Jython script without any main method. Such scripts are used as library scripts that are called from other scripts.
Functions definition
Each script can contain additional functions that are called from the main code. Each such function can call another function, which
either exists in the current script or in another script (use the import statement). Note that to use another script, you must add it to the
Scripts section of the package:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 260
AI Operations Management - Containerized 24.4
In the following example, the main code calls the doQueryOSUsers(..) method which calls an internal method doOSUserOSH(..) :
def doOSUserOSH(name):
sw_obj = ObjectStateHolder('winosuser')
sw_obj.setAttribute('data_name', name)
# return the object
return sw_obj
def doQueryOSUsers(client, OSHVResult):
_hostObj = modeling.createHostOSH(client.getIpAddress())
data_name_mib = '1.3.6.1.4.1.77.1.2.25.1.1,1.3.6.1.4.1.77.1.2.25.1.2,string'
resultSet = client.executeQuery(data_name_mib)
while resultSet.next():
UserName = resultSet.getString(2)
########## send object ##############
OSUserOSH = doOSUserOSH(UserName)
OSUserOSH.setContainer(_hostObj)
OSHVResult.add(OSUserOSH)
def DiscoveryMain(Framework):
OSHVResult = ObjectStateHolderVector()
try:
client = Framework.createClient(Framework.getTriggerCIData(BaseClient.CREDENTIALS_ID))
except:
Framework.reportError('Connection failed')
else:
doQueryOSUsers(client, OSHVResult)
client.close()
return OSHVResult
If this script is a global library that is relevant to many adapters, you can add it to the list of scripts in the jythonGlobalLibs.xml
configuration file, instead of adding it to each adapter (Adapter Management > Resources pane > AutoDiscoveryContent >
Configuration Files).
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 261
AI Operations Management - Containerized 24.4
The script result is actually a group of CIs and links that are to be inserted or updated in the CMDB. The script returns this group of CIs
and links in the format of ObjectStateHolderVector .
The ObjectStateHolder class is a way to represent an object or link defined in the CMDB. The ObjectStateHolder object contains the CIT
name and a list of attributes and their values. The ObjectStateHolderVector is a vector of ObjectStateHolder instances.
The ObjectStateHolder class describes the DFM result graph. Each CI and link (relationship) is placed inside an instance of the ObjectSta
teHolder class as in the following Jython code sample:
appServerOSH = ObjectStateHolder('siebelappserver' )
appServerOSH.setStringAttribute('data_name', sblsvrName)
appServerOSH.setStringAttribute ('application_ip', ip)
appServerOSH.setContainer(appServerHostOSH)
Note: Each CI being reported by the Jython script must include values for all the key attributes of the CI's CI Type.
linkOSH = ObjectStateHolder('route')
linkOSH.setAttribute('link_end1', gatewayOSH)
linkOSH.setAttribute('link_end2', appServerOSH)
Line 1 creates the link (that is also of the ObjectStateHolder class. The only difference is that route is a link CI Type).
Lines 2 and 3 specify the nodes at the end of each link. This is done using the end1 and end2 attributes of the link which must be
specified (because they are the minimal key attributes of each link). The attribute values are ObjectStateHolder instances. For
details on End 1 and End 2, see Link.
Caution: A link is directional. You should verify that End 1 and End 2 nodes correspond to valid CITs at each end. If the nodes are not
valid, the result object fails validation and is not reported correctly. For details, see CI Type Relationships.
After creating objects with attributes, and links with objects at their ends, you must now group them together. You do this by adding
them to an ObjectStateHolderVector instance, as follows:
oshvMyResult = ObjectStateHolderVector()
oshvMyResult.add(appServerOSH)
oshvMyResult.add(linkOSH)
For details on reporting this composite result to the Framework so that it can be sent to the CMDB server, see the sendObjects method.
Once the result graph is assembled in an ObjectStateHolderVector instance, it must be returned to the DFM Framework to be inserted
into the CMDB. This is done by returning the ObjectStateHolderVector instance as the result of the DiscoveryMain() function.
Note: For details on creating OSH for common CITs, see modeling.py.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 262
AI Operations Management - Containerized 24.4
Note
Chunking should be used for Jython integration adapters and not for regular discovery jobs. This is because discovery jobs usually discover
information regarding a specific trigger and do not send large amounts of information. With Jython integrations, large amounts of data are
discovered on the single trigger of the integration.
It is also possible to use chunking for a small number of results. In such a case, there is a relationship between CIs in different chunks
and the developer of the Jython script has two options:
Send the entire CI and all of its identification information again in every chunk that contains a link to it.
Use the UCMDB ID of the CI. To do this, the Jython script has to wait for each chunk to be processed in the UCMDB server in order
to get the UCMDB IDs. To enable this mode (called synchronous result sending), add the SendJythonResultsSynchronously tag to
the adapter. This tag ensures that when you finish sending the chunk, the UCMDB IDs of the CIs in the chunk have already been
received by the probe. The adapter developer can use the UCMDB IDs to generate the next chunk. To use the UCMDB IDs, use the
framework API getIdMapping.
In the first chunk, you send nodes. In the second chunk, you send processes. The root container of the process is a node. Instead of
sending the entire objectStateHolder of the node in the process root_container attribute, you can get the UCMDB ID of the node using
the getIdMapping API and use only the node ID in the process root_container attribute to make the chunk smaller.
Related topics
Choose Discovered Class dialog box
CI Type relationships
modeling.py
sendObjects
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 263
AI Operations Management - Containerized 24.4
The correct usage of Framework instance is to pass it as argument to each method that uses it.
Example:
def DiscoveryMain(Framework):
OSHVResult = helperMethod (Framework)
return OSHVResult
def helperMethod (Framework):
....
probe_name = Framework.getDestinationAttribute('probe_name')
...
return result
Framework.getTriggerCIData(String attributeName)
This API provides the intermediate step between the Trigger CI data defined in the adapter and the script.
To retrieve the credential information from the task, use this API:
credId = Framework.getTriggerCIData('credentialsId')
Framework.createClient(credentialsId, props)
You make a connection to a remote machine by creating a client object and running commands on that client. To create a client,
retrieve the ClientFactory class. The getClientFactory() method receives the type of the requested client protocol. The protocol
constants are defined in the ClientsConsts class.
properties = Properties()
codePage = Framework.getCodePage()
properties.put( BaseAgent.ENCODING, codePage)
client = Framework.createClient(credentailsID ,properties)
You can now use the Client instance to connect to the relevant machine or application.
To create a WMI client and run a WMI query using the client:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 264
AI Operations Management - Containerized 24.4
wmiClient = Framework.createClient(credential)
resultSet = wmiClient. executeQuery("SELECT TotalPhysicalMemory
FROM Win32_LogicalMemoryConfiguration")
Note: To make the createClient() API work, add the following parameter to the Trigger CI data parameters: credentialsId =
${SOURCE.credentials_id} in the Triggered CI Data pane. Or you can manually add the credentials ID when calling the function:
wmiClient = clientFactory().createClient(credentials_id).
The following diagram illustrates the hierarchy of the clients, with their commonly-supported APIs:
For details on the clients and their supported APIs, see BaseClient, ShellClient, and QueryClient in Universal Discovery Java API (or Data
Flow Management SDK). These files are located in the following folder:
To retrieve the value of the protocolType parameter from the Jython script, use the following API:
protocolType = Framework.getParameterValue('protocolType')
The following example illustrates the use of the reportError(<Error Msg>) API:
try:
client = Framework.createClient(Framework.getTriggerCIData(BaseClient.CREDENTIALS_ID))
except:
strException = str(sys.exc_info()[1]).strip()
Framework. reportError ('Connection failed: %s' % strException)
You can use either one of the APIs— Framework.reportError(String message) , Framework.reportWarning(String message) —to report on a
problem. The difference between the two APIs is that when reporting an error, the Probe saves a communication log file with the entire
session's parameters to the file system. In this way you are able to track the session and better understand the error.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 265
AI Operations Management - Containerized 24.4
Related topics
For details about the Framework instance, see Data Flow Management API reference.
For details on error messages, see Error messages.
For details about credentials and supported protocols, see
Supported protocols (in Content Help)
getClientFactory()
ClientsConsts
For details about the clients and their supported APIs, see BaseClient, ShellClient, and QueryClient in the DFM Framework.
Related topics
For details about the Framework instance, see Data Flow Management API reference.
For details about error messages, see Error messages.
For details about credentials and supported protocols, see
Supported protocols (in Content Help)
getClientFactory()
ClientsConsts
For details on the clients and their supported APIs, see BaseClient, ShellClient, and QueryClient in the DFM Framework.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 266
AI Operations Management - Containerized 24.4
Note
Access to sensitive data (passwords, private keys, and so on) is blocked for the following protocol types:
The following example shows how to obtain all entries of the SNMP protocol. Note that here the IP is obtained from the Trigger CI data (
# Get the Trigger CI data values).
The connection script requests all possible protocol credentials ( # Go over all the protocol credentials ) and tries them in a loop until one
succeeds ( resultVector ). For details, see the two-phase connect paradigm entry in Separating Adapters .
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 267
AI Operations Management - Containerized 24.4
import logger
import netutils
import sys
import errorcodes
import errorobject
# Java imports
from java.util import Properties
from com.hp.ucmdb.discovery.common import CollectorsConstants
from appilog.common.system.types.vectors import ObjectStateHolderVector
from com.hp.ucmdb.discovery.library.clients import ClientsConsts
from com.hp.ucmdb.discovery.library.scope import DomainScopeManager
TRUE = 1
FALSE = 0
def mainFunction(Framework, isClient, ip_address = None):
_vector = ObjectStateHolderVector()
errStr = ''
ip_domain = Framework.getDestinationAttribute('ip_domain')
# Get the Trigger CI data values
ip_address = Framework.getDestinationAttribute('ip_address')
if (ip_domain == None):
ip_domain = DomainScopeManager.getDomainByIp(ip_address, None)
protocols = netutils.getAvailableProtocols(Framework, ClientsConsts.SNMP_PROTOCOL_NAME, ip_address, ip_domain)
if len(protocols) == 0:
errStr = 'No credentials defined for the triggered ip'
logger.debug(errStr)
errObj = errorobject.createError(errorcodes.NO_CREDENTIALS_FOR_TRIGGERED_IP, [ClientsConsts.SNMP_PROTOCOL_NAME], errStr)
return (_vector, errObj)
# Go over all the protocol credentials for protocol in protocols:
client = None
for protocol in protocols:
try:
try:
logger.debug('try to get snmp agent for: %s:%s' % (ip_address, ip_domain))
if (isClient == TRUE):
properties = Properties()
properties.setProperty(CollectorsConstants.DESTINATION_DATA_IP_ADDRESS, ip_address)
properties.setProperty(CollectorsConstants.DESTINATION_DATA_IP_DOMAIN, ip_domain)
client = Framework.createClient(protocol, properties)
else:
properties = Properties()
properties.setProperty(CollectorsConstants.DESTINATION_DATA_IP_ADDRESS, ip_address)
client = Framework.createClient(protocol, properties)
logger.debug('Running test connection queries')
from com.hp.ucmdb.discovery.library.clients.protocols.snmp import SnmpConnectionTester
SnmpConnectionTester(client).testSnmpConnection()
Framework.saveState(protocol)
logger.debug('got snmp agent for: %s:%s' % (ip_address, ip_domain))
isMultiOid = client.supportMultiOid()
logger.debug('snmp server isMultiOid state=%s' %isMultiOid)
client.close()
client = None
break
except:
if client != None:
client.close()
client = None
logger.debugException('Unexpected SNMP_AGENT Exception:')
lastExceptionStr = str(sys.exc_info()[1]).strip()
finally:
if client != None:
client.close()
client = None
return (_vector, errStr)
Related topics
Separating adapters
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 268
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 269
AI Operations Management - Containerized 24.4
When catching a known exception, in most cases you should print its stack trace to the log and issue a proper message to the UI.
Note
It is very important to import the Java base exception class as shown in the following example due to the presence of the base exception class
in Python with the same name.
If the exception is not fatal and the script can continue, you should omit the call for the reportError() method and enable the script to
continue.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 270
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 271
AI Operations Management - Containerized 24.4
Add a resource bundle according to the job that is to be run. The following table lists the DFM jobs and the resource bundle that is
used by each job:
To define a new language, add the following two lines of code to the shellutils.py script, that currently contains the list of all
supported languages. The script is included in the AutoDiscoveryContent package. To view the script, access the Adapter
Management window. For details, see Adapter Management window.
For details on class language, see http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html. You can use an existing
locale or define a new locale.
Related topics
Work with resource bundles
Adapter Management window
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 272
AI Operations Management - Containerized 24.4
To change the default language, you initialize the DEFAULT_LANGUAGE variable with a different language. For details, see Add support
for a new language.
Related topics
Add support for a new language
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 273
AI Operations Management - Containerized 24.4
1. It is possible to determine the OS language in a locale-independent way, for example, by running the chcp command on Windows
or the locale command on Linux.
2. Relation Language-Encoding is well known and can be defined statically. For example, the Russian language has two of the most
popular encoding: Cp866 and Windows-1251 .
3. One character set for each language is preferable, for example, the preferable character set for Russian language is Cp866 . This
means that most of the commands produce output in this encoding.
4. Encoding in which the next command output is provided is unpredictable, but it is one of the possible encoding for a given
language. For example, when working with a Windows machine with a Russian locale, the system provides the ver command
output in Cp866, but the ipconfig command is provided in Windows-1251.
5. A known command produces known key words in its output. For example, the ipconfig command contains the translated form of
the IP-Address string. So the ipconfig command output contains IP-Address for the English OS, for the Russian OS, IP-
Adresse for the German OS, and so on.
Once it is discovered in which language the command output is produced (# 1), possible character sets are limited to one or two (# 2).
Furthermore, it is known which key words are contained in this output (# 5).
The solution, therefore, is to decode the command output with one of the possible encoding by searching for a key word in the result. If
the key word is found, the current character set is considered the correct one.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 274
AI Operations Management - Containerized 24.4
Jython scripts usually run commands and parse their output. To receive this command output in a properly decoded manner, use the
API for the ShellUtils class. For details, see UCMDB Web Service API overview.
1. Create a client:
2. Create an instance of the ShellUtils class and add the operating system language to it. If the language is not added, the default
language is used (usually English):
shellUtils = shellutils.ShellUtils(client)
During object initialization, DFM automatically detects machine language and sets preferable encoding from the predefined Langu
age object. Preferable encoding is the first instance appearing in the encoding list.
3. Retrieve the appropriate resource bundle from shellclient using the getLanguageBundle method:
4. Retrieve a keyword from the resource bundle, suitable for a particular command:
strWindowsIPAddress = languageBundle.getString('windows_ipconfig_str_ip_address')
5. Invoke the executeCommandAndDecode method and pass the keyword to it on the ShellUtils object:
The ShellUtils object is also needed to link a user to the API reference (where this method is described in detail).
Related topics
ShellUtils object
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 275
AI Operations Management - Containerized 24.4
However, another approach uses a keyword to decode the first command output only, and then decodes further commands with the
character set used to decode the first command. To do this, you use the getCharsetName and useCharset methods of the
ShellUtils object.
Related topics
Define a new job to operate with localized data
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 276
AI Operations Management - Containerized 24.4
When discovering a destination, DFM usually needs to parse text from command output or file content. This parsing is often based on a
regular expression. Different languages require different regular expressions to be used for parsing. For code to be written once for all
languages, all language-specific data must be extracted to resource bundles. There is a resource bundle for each language. (Although it
is possible for a resource bundle to contain data for different languages, in DFM each resource bundle contains data for one language
only.)
The Jython script itself does not include hard coded, language-specific data (for example, language-specific regular expressions). The
script determines the language of the remote system, loads the proper resource bundle, and obtains all language-specific data by a
specific key.
In DFM, resource bundles take a specific name format: <base_name>_<language_identifier>.properties , for example, langNetwork_spa.prope
rties . (The default resource bundle takes the following format: <base_name>.properties , for example, langNetwork.properties .)
The base_name format reflects the intended purpose of this bundle. For example, langMsCluster means the resource bundle contains
language-specific resources used by the MS Cluster jobs.
The language_identifier format is a 3-letter acronym used to identify the language. For example, rus stands for the Russian language
and ger for the German language. This language identifier is included in the declaration of the Language object.
Related topics
Configuration File pane
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 277
AI Operations Management - Containerized 24.4
Fields
Name Description
Resource bundle postfix. This postfix is used in resource bundle file names to identify the language. For example, the
bundlePostfix
langNetwork_ger.properties bundle includes a ger bundle postfix.
Character sets used to encode this language. Each language can have several character sets. For example, the Russian language is
charsets
commonly encoded with the Cp866 and Windows-1251 encoding.
The list of WMI codes used by the Microsoft Windows OS to identify the language. All possible codes are listed at
wmiCodes http://msdn.microsoft.com/en-us/library/aa394239(VS.85).aspx (the OSLanguage section). One of the methods for identifying the OS
language is to query the WMI class OS for the OSLanguage property.
Code page used with a specific language. For example, 866 is used for Russian machines and 437 for English machines. One of the
codepage
methods for identifying the OS language is to retrieve its default codepage (for example, by the chcp command).
Arguments
Name Description
framework The Framework object passed to every executable Jython script in DFM.
useSudo Specifies if sudo should be used (relevant only for UNIX machine clients).
language Enables specifying the language directly instead of automatically detecting a language.
Arguments
Name Description
charsetName The name of the character set, for example, windows-1251 or UTF-8 .
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 278
AI Operations Management - Containerized 24.4
Framework.getEnvironmentInformation().getBundle(...)
Arguments
Name Description
baseName The name of the bundle without the language suffix, for example, langNetwork .
framework The Framework, common object which is passed to every executable Jython script in DFM.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 279
AI Operations Management - Containerized 24.4
1. Access Data Flow Management > Universal Discovery . Right-click the job whose run must be logged and select Go to
Adapter to open the Adapter Management application.
2. Locate the Execution Options pane in the Adapter Configuration tab, as shown below.
3. Change the Create communication log box to Always. For details on setting logging options, see Execution Options pane.
The following example is the XML log file that is created when the Host Connection by Shell job runs and the Create
communication logs box is set to Always or On Failure:
Note
CDATA mechanism is used to store information retrieved from user environment in the communication logs. When scan files get some
characters or XML segments that cannot be parsed by the CDATA mechanism, the information will be saved in binary format for further
troubleshooting purpose. Support will decode the binary data in the communication logs to perform troubleshooting.
Related topics
Execution Options pane
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 280
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 281
AI Operations Management - Containerized 24.4
To use one of the utility scripts, add the following import line to the import section of the script:
The AutoDiscovery Python library contains Jython utility scripts. These library scripts are considered DFM's external library. They are
defined in the jythonGlobalLibs.xml file (located in the Configuration Files folder).
Each script that appears in the jythonGlobalLibs.xml file is loaded by default at Probe startup, so there is no need to use them explicitly
in the adapter definition.
logger.py
The logger.py script contains log utilities and helper functions for error reporting. You can call its debug, info, and error APIs to write
to the log files. For details about how to access log files, see Access log files.
logger.<debug/info/warn/error>
logger.<debugException/infoException/warnException/errorException>
The first set issues the concatenation of all its string arguments at the appropriate log level and the second set issues the
concatenation as well as issuing the stack trace of the most recently-thrown exception, to provide more information, for example:
modeling.py
The modeling.py script contains APIs for creating hosts, IPs, process CIs, and so on. These APIs enable the creation of common objects
and make the code more readable. For example:
ipOSH= modeling.createIpOSH(ip)
host = modeling.createHostOSH(ip_address)
member1 = modeling.createLinkOSH('member', ipOSH, networkOSH)
netutils.py
The netutils.py library is used to retrieve network and TCP information, such as retrieving operating system names, checking if a MAC
address is valid, checking if an IP address is valid, and so on. For example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 282
AI Operations Management - Containerized 24.4
shellutils.py
The shellutils.py library provides an API for executing shell commands and retrieving the end status of an executed command, and
enables running multiple commands based on that end status. The library is initialized with a Shell Client, and uses the client to run
commands and retrieve results. For example:
Related topics
Error severity levels
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 283
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 284
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 285
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 286
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 287
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 288
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 289
AI Operations Management - Containerized 24.4
C:\UCMDB\UCMDBServer\content\adapters\generic-adapter.zip
2. Review the following directories in preparation for the rename and replace phase:
discoveryConfigFiles: Contains the adapter's mappings definitions and points to the correct scripts (in the
mapping/scripts sub-folder)
discoveryPatterns: Contains the adapter's XML definition that is deployed on the UCMDB server
discoveryResources: Contains the UCMDBDataReceiver.jar containing the Java integration classes for the web service.
Note
When you deploy this package, the probe is restarted to include this .jar in the probe’s CLASSPATH. No action is required beyond
deploying the package.
3. Make the following changes within the unzipped adapter directory structure:
b. discoveryConfigFiles\<Your_Push_Adapter_Name>\mappings: create an XML mapping file per TQL that you want to
use in your integration. Note that the push adapter applies the transformations in the mapping file to the results of the
integration TQLs and then sends that data in three parameters (addResult, updateResult, and deleteResult) of an ad hoc
task to the data flow probe.
d. discoveryPatterns\<push adapter name>.xml: Rename this file to the name of the new adapter's definition XML file (for
example, my_push_adapter.xml). Then, update this file as follows:
For the XML element <pattern>: set the id and description attributes accordingly. For example:
is changed to:
For the XML element <parameters>: update the children elements according to the needs of your adapter. By default,
the following children elements are used to define a push adapter. These values are assigned when the integration point
is defined in the Integration Studio after the adapter is configured. Update the parameter list so that the list of
parameters reflects the required connection attributes. Do not remove the probeName attribute.
Web Service Push Adapter: uri - the remainder of the URL to form the service endpoint address of the data
receiver.
probeName: defines on which data flow probe the push job runs
For the XML element <integration>: update the value of the child element <category> to something other than
Generic. By default integration adapters belonging to the Generic category are not shown in the Integration Studio. If
you are integrating with a third-party data store, set this value to "Third Party".
e. tql\<your_integration_TQLs>: Like a regular package, place the TQL XML definition of your integration TQLs in this
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 290
AI Operations Management - Containerized 24.4
directory. All TQLs in this folder are deployed when the adapter package is deployed.
4. After making all the above changes, create a .zip file by selecting the folders and files specified in step 3 above (for example,
my_Push_Adapter.zip).
5. Deploy the newly created .zip file on the UCMDB server via the Package Manager (go to Administration > Package Manager).
6. Create an integration point in Data Flow Management > Integration Studio and define the integration TQLs that the
integration point uses. Set a schedule for automatic data push.
Related topics
Notes to building push adapter package
Create mappings
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 291
AI Operations Management - Containerized 24.4
The mapping specification can be found in the section Mapping file reference. Use the reference to create a mapping file.
Note
The adapter properties file refers to the name of the mapping file. In adapter configuration files, the adapter implements a folder structure
using the name of the adapter. Rename this folder when implementing an adapter to maintain uniqueness as required by the Package
Manager.
Repeat steps 2-5 until the mapped data is suitable for consumption. Select the appropriate Generic adapter package from which to
create the new push adapter.
The mapping files work the same way for all types of push adapters. The Generic XML push adapter writes the mapped results to a file.
The Generic Web Service Push Adapter sends the XML results to a data receiver.
You can retrieve all of the CIs and relationships as they are in the CMDB without mapping, by not creating the mappings.xml file. This returns
all of the CIs and relationships with all of their attributes.
The mapping file structure is created as follows (use an existing file as a template):
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 292
AI Operations Management - Containerized 24.4
2. Map CIs
Map a CI type so that CIs of that type and all inherited types are mapped in the same way:
Map a CI type so that only CIs of that type are processed. CIs of inherited types are not processed unless their type is also
mapped (in one of the two ways):
A CI type which is mapped indirectly (one of its ancestors is mapped using source_ci_type_tree), can also override its parent's
map by having it appear in its own source_ci_type_tree or source_ci_type.
It is recommended to use source_ci_type_tree wherever possible. Otherwise, resulting CIs of a CI type that do not appear in the
mapping files will not be transferred to the Jython script.
3. Map Links
Map a link so that links of that type and all inherited links are mapped in the same way:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 293
AI Operations Management - Containerized 24.4
Map a link so that only links of that type are processed. Links of inherited types are not processed unless their type is also
mapped (in one of the two ways):
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 294
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 295
AI Operations Management - Containerized 24.4
The ExternalIdUtil.restoreExternal command, which receives the ID of the CI in the CMDB as a parameter, restores the external ID
from the ID of the CI in the CMDB. This command can be used, for example, while performing differential synchronization, and a link is
received where one of its ends is not in the bulk (it was already synchronized).
If the DiscoveryMain method in the Jython script on which the Push adapter is based returns an empty ObjectStateHolderVector
instance, the adapter will not support differential synchronization. This means that even when a differential synchronization job is run,
in actuality, a full synchronization is being performed. Therefore, no data can be updated or removed on the remote system, since all
data is added to the CMDB during each synchronization.
Important: If you are implementing differential synchronization on an existing adapter that was created in version 9.00 or 9.01, you
must use the push-adapter.zip file from version 9.02 or later to recreate your adapter package. For details, see Build an adapter
package.
The Jython script returns the DataPushResults object which contains two Java maps - one for object ID mappings (keys and values are
ExternalCiId type objects) and one for link IDs (keys and values are ExternalRelationId type objects).
Use the DataPushResultsFactory factory class to obtain the DataPushResults object from the DiscoveryMain function.
Use the following commands to create Java maps for the DataPushResults object:
ExternalId for objects or links originating in a CMDB (for example, all of the CIs in an add operation are from the CMDB):
ExternalId for objects or links not originating in a CMDB (usually, every update and remove operation contains such objects):
Note
If the Jython script updated existing information and the ID of the object (or link) changes, you must return a mapping between the
previous external ID and the new one.
Use the restoreCmdbCiIDString or restoreCmdbRelationIDString methods from the ExternalIdFactory class to retrieve the
UCMDB ID string from an External ID of an object or link that originated in UCMDB.
Use the restoreExternalCiId and restoreExternalRelationId methods from the ExternalIdUtil class to restore the ExternalId
object from the mamId attribute value of the XML of the update or remove operations.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 296
AI Operations Management - Containerized 24.4
Note
ExternalId objects are actually an array of properties. This means that you can use anExternalId object to store any information you
may need that will identify the data on the remote system.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 297
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 298
AI Operations Management - Containerized 24.4
Custom processing of the web service message response is possible in the interface implementation.
To understand the format of the incoming mapped data, the developer of the data receiver should communicate with the developer of
the mappings file. An .xsd is currently not provided with this version of the web service push adapter, so data must be processed in a
way reflective of the incoming data, which is a combination of the original TQL and the applied mappings.
The web service push adapter functions for pushing data to the client are shown below. The items in green are customized or supplied
by the client to implement the adapter for a specific push target. The items in blue are out-of-the-box components.
An example of an implementation of the generic web service push adapter to an MDR-specific push adapter using an Enterprise Service
Bus (ESB) is shown here:
WSDL
If you use SOAP, a WSDL is supplied to the client developer to create a data receiver capable of communicating with the UCMDB push
adapter via a web service. The UCMDBDataReceiver.wsdl describes the SOAP messages that are used to communicate data from
UCMDB to the data receiver. The design diagram from the WSDL is shown here:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 299
AI Operations Management - Containerized 24.4
The data receiver (which is in practice a server or “service endpoint" in SOAP terminology) should implement three methods: addData,
deleteData, and updateData, corresponding to the data sets that the UCMDB pushes. The HTTP headers contain the correct
SoapAction keyword that indicates the type of data that is being sent. The data receiver is responsible for implementing the business
logic and processing the data.
http://localhost:8080/UCMDBDataReceiver/services/UCMDBDataReceiver?wsdl
As implemented by the Data Receiver, the URL could look similar to the following:
http://testWSPAserver:4444/MyCo.IT.SvcMgt.ws.us:provider/UCMDBDataReceiver?wsdl
The URL of the web service is the same as the WSDL URL without the “?wsdl” at the end.
<wsdl:message name="addDataRequest">
<wsdl:part element="impl:addData" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:message name="deleteDataResponse">
<wsdl:part element="impl:deleteDataResponse" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:message name="updateDataResponse">
<wsdl:part element="impl:updateDataResponse" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:message name="deleteDataRequest">
<wsdl:part element="impl:deleteData" name="parameters">
</wsdl:part>
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 300
AI Operations Management - Containerized 24.4
</wsdl:message>
<wsdl:message name="addDataResponse">
<wsdl:part element="impl:addDataResponse" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:message name="updateDataRequest">
<wsdl:part element="impl:updateData" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:portType name="UCMDBDataReceiver">
<wsdl:operation name="addData">
<wsdlsoap:operation soapAction="addDataRequest"/>
<wsdl:input message="impl:addDataRequest" name="addDataRequest">
</wsdl:input>
<wsdl:output message="impl:addDataResponse" name="addDataResponse">
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteData">
<wsdlsoap:operation soapAction="deleteDataRequest"/>
<wsdl:input message="impl:deleteDataRequest" name="deleteDataRequest">
</wsdl:input>
<wsdl:output message="impl:deleteDataResponse" name="deleteDataResponse">
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="updateData">
<wsdlsoap:operation soapAction="updateDataRequest"/>
<wsdl:input message="impl:updateDataRequest" name="updateDataRequest">
</wsdl:input>
<wsdl:output message="impl:updateDataResponse" name="updateDataResponse">
</wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="UCMDBDataReceiverSoapBinding" type="impl:UCMDBDataReceiver">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addData">
<wsdl:input name="addDataRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addDataResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteData">
<wsdl:input name="deleteDataRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="deleteDataResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="updateData">
<wsdl:input name="updateDataRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="updateDataResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="UCMDBDataReceiverService">
<wsdl:port binding="impl:UCMDBDataReceiverSoapBinding" name="UCMDBDataReceiver">
<wsdlsoap:address location="http://localhost:8080/UCMDBDataReceiver/services/UCMDBDataReceiver"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Response handling
The data receiver should return a string in the addDataResponse, deleteDataResponse, or updateDataResponse structures. The
adapter passes the response data unprocessed to the probe’s probeMgr-adaptersDebug.log. The receiver can return any string
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 301
AI Operations Management - Containerized 24.4
data, and the responses are wrapped in SOAP-compliant XML. In the Jython script you can use the SOAPMessage and related Java
classes to parse the response messages. The following is an example of a response message from the data receiver:
The message shown is an error message <Error publishing config item changes>, but the content can be anything that the data
receiver is designed to respond with. The response is an error message simply because that is the intent, because the designer says it
is an error message and the push adapter expects the response to be some indication of success or failure. The content can be
reconciliation IDs of all the successfully added CIs, or error messages for specific CIs. Customization of the GWSPA could include
parsing the response message and taking actions such as resending certain CIs or performing other logging.
The ? in the xmlAdded element above is the location of the data, which is supplied by the web service push adapter integration.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 302
AI Operations Management - Containerized 24.4
Using mappings
A mapping must be created for each target attribute in the transformed XML output. The mappings specify where and how to obtain
the data. If the data is in another corresponding attribute in UCMDB, then a direct mapping is used.
To pull data from multiple attributes, or attributes from the UCMDB CI’s child or parent CI’s attributes, other complex mappings may be
necessary. The mapping schema below shows all possible mappings.
The mapping file is an XML file which defines which CI/Relationship types in UCMDB are mapped to which CI/Relationship types in the
target data store. The format is explained in detail below. The mapping file controls which CI and relationship types are pushed, as well
as controlling exactly which attributes are pushed.
A mapping entry exists for each attribute to be pushed to the target MDR. Each mapping entry may consist of one or more attributes in
the raw UCMDB push data. Mapping entries allow completely granular control of the final structure and naming of the data to be
pushed to the target MDR.
Direct mappings
Mappings transform one data model to another (in this case, the UCMDB to the push target MDR). Transformations may be simple, in
the case of a 1:1 relationship between the UCMDB attribute and the target, they differ only by name and perhaps type.
Most attribute mappings are direct. For example, the server name “ServerX”, may be represented in UCMDB as a CI of type unix with
an attribute name of primary_server_name, of type string with a length of 50. The target MDR’s data model may specify the same
logical entity with a CI type of linux, with an attribute name of hostname with a type of char[] with a maximum length of 250. Direct
mappings can accomplish all these aforementioned types of translation tasks.
This direct mapping maps the UCMDB attribute dns_domain to the domain_name attribute in the target data model.
Use the char data type regardless of the actual data type, unless it is necessary to use the actual data type.
Complex mappings
More complex mappings enable additional transformations:
Below is an example of a complex mapping, using two source attributes separated by a comma character, to create the target attribute
os:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 303
AI Operations Management - Containerized 24.4
It is possible that the UCMDB contains data that differs in structure from source to source. For example, the relationship between an
IpAddress CI and an Interface CI may be a parent, as may occur with the Network Node Manager integration. Or it may be a
containment link as is commonly created by Universal Discovery. Furthermore, the direction of these links are opposite to each other.
It is currently not possible to reverse the direction of links in the mappings file. Reversal of the _end1 and _end2 variables either
switches the order of the data in the transformed XML or the link is missing in the source data.
1. The enrichment’s TQL part is a subset of a TQL that is used by the push adapter. This TQL in particular selects all the links that are
in the opposite direction of what is desired in the transformed xml.
2. The enrichment part defines a new link of the correct direction and desired type.
3. Enrichment is activated and then creates the correct links.
4. The integration job TQL now refers to the enriched link rather than the original link.
5. The <link> mappings in the push adapter then refer to the enriched link as well and produce a set of links consistent in type and
direction.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 304
AI Operations Management - Containerized 24.4
Defines the mapping contents of the file. Must be the outermost block in
integration
the file except for the beginning line and any comments.
info
Defines information about the data repositories being integrated.
(integration)
1. Name: type
Is required?: Required
Type: String
2. Name: versions
Type: String
3. Name: vendor
Is required?: Required
Type: String
1. Name: type
Is required?: Required
Type: String
2. Name: versions
Type: String
3. Name: vendor
Is required?: Required
Type: String
targetcis
Container element for all CIT mappings.
(integration)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 305
AI Operations Management - Containerized 24.4
1. Name: name
Is required?: Required
Type: String
2. Name: mode
1. Name: name
Is required?: Required
Type: String
2. Name: mode
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 306
AI Operations Management - Containerized 24.4
1. Name: name
Is required?: Required
Type: String
Type: String
targetprimarykey
-OR-
(integration >
targetrelations > link)
-OR-
(integration >
targetrelations >
source_link_type_tree)
pkey
-OR-
-OR-
integration >
targetrelations >
source_link_type_tree >
targetprimarykey)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 307
AI Operations Management - Containerized 24.4
1. Name: name
Is required?: Required
Type: String
2. Name: datatype
target_attribute
Description: Data type of the target
(integration > targetcis
CIT's attribute.
> source_ci_type
Is required?: Required
-OR-
Type: String
integration > targetcis
> 3. Name: length
source_ci_type_tree
Defines the target CIT's attribute. Description: For string/char data types,
-OR- integer size of target attribute.
1. Name. type
Description. The type of mapping
between the source and target values.
map
Is required. Required
(integration > Type. One of the following strings:
targetcis > a. direct – Specifies a 1-to-1 mapping
source_ci_type > from source attribute's value to target
target_attribute attribute's value.
b. compoundstring – Sub-elements are
-OR-
joined into a single string and the target
integration > attribute value is set.
targetcis > c. childattr – Sub-elements are one or
source_ci_type_tree > more child CIT's attributes. Child CITs are
target_attribute) defined as those with composition or
Specifies how to obtain the source CIT's attribute value.
containment relationship.
-OR- d. constant – Static string
2. Name. value
(integration >
Description. Constant string for
targetrelations > link >
type=constant
target_attribute
Is required. Only required when
-OR- type=constant
Type. String
integration >
3. Name. attr
targetrelations >
Description. Source attribute name for
source_link_type_tree >
type=direct
target_attribute)
Is required. Only required when
type=direct
Type. String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 308
AI Operations Management - Containerized 24.4
aggregation
(integration >
targetcis >
source_ci_type >
target_attribute > map
Name: type
-OR- Description. The type of aggregation function
Is required?: Required
integration >
Type. One of the following strings:
targetcis >
source_ci_type_tree > csv – Concatenates all included values
target_attribute > map into a comma-separated list (numeric or
string/character).
-OR-
Specifies how the source CI's child CI attribute values are combined into count – Returns a numeric count of all
(integration > a single value to map to the target CI attribute. Optional. included values.
targetrelations > sum – Returns the sum of all numeric
link > target_attribute included values.
> average – Returns a numeric average of
map all included values.
min – Returns the lowest
-OR-
numeric/character included value.
integration > max – Returns the highest
targetrelations > numeric/character included value.
source_link_type_tree >
target_attribute > map)
source_child_ci_type
-OR-
integration >
targetrelations >
source_link_type_tree >
target_attribute > map)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 309
AI Operations Management - Containerized 24.4
validation
(integration >
targetcis > 1. Name. minlength
source_ci_type > Description. Excludes strings shorter
target_attribute > map than the given value.
Is Required?: Not required
-OR- Type. Integer
2. Name. maxlength
integration >
Description. Excludes strings longer
targetcis >
than the given value.
source_ci_type_tree >
Allows exclusion filtering of the source CI's child CIs based on attribute Is Required?: Not required
target_attribute > map
values. Used with the aggregation sub-element to achieve granularity of Type. Integer
-OR- exactly which children attributes are mapped to the target CIT's attribute 3. Name. minvalue
targetrelations
Container element for all relationship mappings. Optional.
(integration)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 310
AI Operations Management - Containerized 24.4
1. Name: name
Description. Source relationship name.
Is required?:Required
Type. String
2. Name: target_link_type
Description. Target relationship name
Is required?: Required
Type. String
3. Name: nameSpace
Description: The namespace for the link
that will be created on the target.
Is required?: Not required
Type: String
4. Name: mode
Description: The type of update required
for the current link.
Is required?: Required
source_link_type_tree Type: One of the following strings:
Maps a source Relationship type without the types which inherit from it to
(integration > insert – Use this only if the CI does
a target Relationship. Mandatory only if targetrelation is present.
targetrelations) not already exist.
update – Use this only if the CI is
known to exist.
update_else_insert – If the CI
exists, update it; otherwise, create a
new CI.
ignore – Do nothing with this CI
type.
5. Name: source_ci_type_end1
Description: Source relationship's End1
CI type.
Is required?: Required
Type: String
6. Name: source_ci_type_end2
Description: Source relationship's End2
CI type.
Is required?: Required
Type: String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 311
AI Operations Management - Containerized 24.4
1. Name: source_link_type
Description: Source relationship name.
Is Required?: Required
Type: String
2. Name: target_link_type
Description: Target relationship name.
Is required?: Required
Type: String
3. Name: nameSpace
Description: The namespace for the link
that will be created on the target.
Is required?: Not required
Type: String
4. Name: mode
Description: The type of update required
for the current link.
Is required?: Required
link Type: On the following strings:
Maps a source Relationship to a target Relationship. Mandatory only if
(integration > insert – Use this only if the CI does
targetrelation is present.
targetrelations) not already exist.
update – Use this only if the CI is
known to exist.
update_else_insert – If the CI
exists, update it; otherwise, create a
new CI.
ignore – Do nothing with this CI
type.
5. Name: source_ci_type_end1
Description: Source relationship's End1
CI type
Is required?: Required
Type: String
6. Name: source_ci_type_end2
Description: Source relationship's End2
CI type
Is required?: Required
Type: String
1. Name: name
target_ci_type_end1
Description: Name of the target
(integration > relationship’s End1 CI type.
targetrelations > link Is required?: Required
Type: String
-OR- Target relationship’s End1 CI type.
2. Name: superclass
Description: Name of the End1 CI type’s
integration >
super-class.
targetrelations >
Is required?: Not required
source_link_type_tree)
Type: String
1. Name: name
target_ci_type_end2
Description: Name of the target
(integration > relationship’s End2 CI type.
targetrelations > link Is required?: Required
Type: String
-OR- Target relationship’s End2 CI type.
2. Name: superclass
Description: Name of the End2 CI type’s
integration >
super-class.
targetrelations >
Is required?: Not required
source_link_type_tree)
Type: String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 312
AI Operations Management - Containerized 24.4
objects
(root > The root element for the objects to update.
data)
1. Name: name
Description: Name of the CI type
Is required?: Required
Type: String
2. Name: mode
Description: The type of update
required for the current CI type.
Is required?: Required
Type: One of the following strings:
a. insert – Use this only if the CI
does not already exist.
b. update – Use this only if the CI
is known to exist.
c. update_else_insert – If the CI
exists, update it; otherwise, create
a new CI.
Object
d. ignore – Do nothing with this CI
(root > data Describes the update operation for a single object and all of its attributes. type.
> objects) 3. Name: operation
Description: The operation to
perform with this CI.
Is required: Required
Type: One of the following strings:
a. add – The CI should be added
b. update – The CI should be
updated
c. delete – The CI should be
deleted
If no value is set, then the default
value of add is used.
4. Name: mamId
Description: The ID of the object
on the source CMDB.
Is required?: Required
Type: String
1. Name: name
Description: Name of the field.
Is required?: Required
Type: String
2. Name: key
field Description: Specifies whether
(root > data this field is a key for the object.
> objects > Is required?: Required
Object Describes the value of a single field for an object. The field’s text is the new value in the Type: Boolean
field, and if the field contains a link, the value is the ID of one of the ends. Each end ID 3. Name: datatype
-OR-
appears as an object (under <objects>). Description: The type of the field.
root > data Is required?: Required
> links > Type: String
link) 4. Name: length
Description: For string/character
data types, this is the integer size
of the target attribute.
Is required?: Not Required
Type: Integer
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 313
AI Operations Management - Containerized 24.4
Element
Name and Description Attributes
Path
1. Name: targetRelationshipClass
Description: The name of the
relationship (link) in the target
system.
Is required?: Required
Type: String
2. Name: targetParent
Description: The type of first end
of the link (parent).
Is required?: Required
Type: String
3. Name: targetChild
Description: The type of the
second end of the link (child).
Is required?: Required
Type: String
4. Name: mode
Description: The type of update
required for the current CI type.
Is required?: Required
Type: One of the following strings:
a. insert – Use this only if the CI
does not already exist.
links (root >
The root element for the links to update. b. update – Use this only if the CI
data)
is known to exist.
c. update_else_insert – If the CI
exists, update it; otherwise, create
a new CI.
d. ignore – Do nothing with this CI
type.
5. Name: operation
Description: The operation to
perform with this CI.
Is required?: Required
Type: One of the following strings:
a. add – The CI should be added
b. update – The CI should be
updated
c. delete – The CI should be
deleted
If no value is set, then the default
value of add is used.
6. Name: mamId
Description: The ID of the object
on the source CMDB.
Is required?: Required
Type: String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 314
AI Operations Management - Containerized 24.4
1.1.5.1.4.10. Customization
This section explains some of the basic procedures for common types of customization for push adapters.
Add an attribute
1. Ensure that the attribute is included in the TQL result.
2. Add the attribute mapping to the mappings file in the correct CI mapping section.
3. Ensure the data receiver is prepared to receive the additional attribute in the data.
Remove an attribute
To remove an attribute, remove the attribute from the mapping file.You should also remove the attribute from the TQL if it is no longer
used in the result or as a conditional node.
Add a CI Type
1. Add the CI type to the TQL.
2. Ensure the CI type and it’s attribute data appear in the TQL result (use calculate and preview).
3. Add the CI type’s mapping in the mappings file. Copy another CI type’s mappings to quickly create a new CI type.
4. Modify the copied XML’s name and attribute mappings to correspond to the new CI type and its attributes.
Remove a CI Type
1. Remove the CI Type from the TQL
2. Remove the mapping section for that CI type in the mappings file.
Add links
1. Ensure the two end CIs are present in the data.
2. Ensure the link you need to add is in fact a valid link (check in the CI type manager).
3. Add the link elements in the relationships section of the mappings xml.
Remove links
1. Remove the link section of the link you want to remove in the mappings file.
2. If possible, remove the link from the TQL (unless it affects the efficiency or function of the TQL).
Related topics
For the available types of mappings, see Mapping file reference.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 315
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 316
AI Operations Management - Containerized 24.4
1.1.5.1.5.1. Overview
The Generic Adapter works on data structures that represent the TQL query result. Each adapter built over the Generic Adapter
Framework will handle this data structure and push it to its required target.
The data structure is named ResultTreeNode (RTN). The RTN is created according to the mapping file of the adapter and the results
of the TQL query. The queries used for the Generic Adapter Framework must be root based, that is the query must contain one query
node with element name root, or one or more relationship elements beginning with the prefix root. This CI or relationship serves as
the root element of the query. There are two basic steps involved in developing enhanced push adapters:
1. Implementing the PushAdapterConnector interface – this interface receives the data to add, update and delete as a list of RTNs,
and perform the push into the target.
2. Creating the mapping file – the mapping file determines the creating of the RTN structure, by mapping CIs and attributes of the
TQL result.
Related topics
Data Push
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 317
AI Operations Management - Containerized 24.4
In this example, we will simulate a push of a node and an IP address. We will create a TQL query called Node Push, as follows:
In the mapping file we create two target CI types: Computer and IP. Computer has one variable and two attributes. IP has one
attribute.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 318
AI Operations Management - Containerized 24.4
Each root instance is mapped separately using the mapping file. Thus in this example, the PushAdapterConnector receives a list of two
RTN roots.
Note
The previous push adapter had the ability to create a general mapping for a CI type. The new push adapter mapping is per TQL query. While
running a push job that uses a query named x, the adapter looks for the relevant mapping file (the one that has attribute: query-name=x).
You can calculate the values in the mapping file using groovy script language.
Related topics
The groovy traveler
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 319
AI Operations Management - Containerized 24.4
There are additional attributes that can be accessed by the groovy traveler:
<import>
<scriptFile path="mappings.scripts.PushFunctions"/>
</import>
This means that we are declaring an import for all the groovy scripts in the mapping file. In this example, PushFunctions is a groovy
script file that contains some static functions, and we can access them during the mapping (i.e. value=” PushFunctions.foo()”)
source_instance_type
The mapping is done per TQL, the query-name value is the related TQL of the current mapping. The ‘*’ means that this mapping file is
associated with all TQL queries beginning with the prefix: Node Push.
root-element-name should be exactly the same as the name of the root in the TQL.
target_entity
The is-valid attribute is a Boolean value that is calculated during the mapping, and determines if the current target_ci is valid. Invalid
target_entities are not added to the RTN. In this example, we do not want to create a target_entity instance for which the
root_iscandidatefordeletion attribute in UCMDB is true.
The target_entity can have variables that are calculated during the mapping:
The variable vSerialNo gets the value of the serial_number of the current root.
The attribute of the RTN is created by the target_mapping tag. The result of the execution of the groovy script in the value field,is
assigned to the RTN attribute.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 320
AI Operations Management - Containerized 24.4
<target_entity name="Portfolio">
<variable name="vSerialNo" datatype="STRING" value="Root['global_id']"/>
<target_mapping name="CMDBId" datatype="STRING" value="globalId"/>
<target_entity name=Asset">
<target_mapping name="SerialNo" datatype="STRING" value="vSerialNo"/>
</target_entity>
</target_entity>
for-each-source-entity
This tag lists the specific CIs of the root instance. It has the following fields:
source-entities=" " – the list of CIs for which a target CI is created. This list is defined by the groovy traveler in the
Root.IpAddress field.
count-index=" " – a variable that holds the index of the CI in the current iteration of the loop.
var-name=" " – the name of the CI in the current iteration of the loop.
The RTN list that will build according to this mapping file will look like this:
dynamic_mapping
This tag adds the ability to create a mapping of data from the target data store during the creation of the RTN structure.
Example: Assume that the target is a database with a table named Computer that has an id column and a name column that is
correlated to Node.name in UCMDB. Both columns are unique. The database also has a table named IP that has a referenced key to
the parentID in the Computer table. The ‘dynamic_mapping’ can create a map that stores the name and id as <name,id>. Based on
this map, the Adapter can match ids with computers and can push the correct value to the parentID attribute in the IP table. You can
use this map to assign a value to the parentID attribute while creating the RTN.
The mapping is determined by the map_property. The dynamic_mapping is executed once for each chunk.
The name attribute represents the name of the map. The keys-unique attribute indicates if the keys are unique (each key is mapped
to one value, or to a set of values).
The name of the map in this example is IdByName and it has unique keys. In order to access the map in the script, run the following
command:
DynamicMapHolder.getMap(‘IdByName’)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 321
AI Operations Management - Containerized 24.4
The map_property tag creates the property on which the mapping is based.
Example:
In this example the name of the property is SQLQuery and its value is an SQL statement that creates the map. The implementation of
the methods retrieveUniqueMapping and retrieveNonUniqueMapping for the PushConnector interface will determine the actual
content of the returned map.
Global variables
The following global variables are accessible to the groovy script in the mapping file:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 322
AI Operations Management - Containerized 24.4
package mappings.scripts
public class PushFunctions {
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 323
AI Operations Management - Containerized 24.4
PushAdapterConnector interface
The interface contains the following methods.
Return
No return value.
value
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 324
AI Operations Management - Containerized 24.4
Return
No return value.
value
Return
The push result of all the CIs and linkages.
value
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 325
AI Operations Management - Containerized 24.4
Return
No return value.
value
Return
No return value.
value
Return
The mapping dynamically generated.
value
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 326
AI Operations Management - Containerized 24.4
adapterCode. Under this folder, create a folder named PushExampleAdapter, which will contain the .jar file we created from
the PushExampleAdapter.java. It will also contain a folder named mappings, where you can place the mapping file created
earlier, computerIPMapping.xml. It should also contain another folder named scripts that contains the
PushFunctions.groovy file.
discoveryConfigFiles. To contain configuration files such as the error codes used when reporting an error using UpdateResult. In
this example, the folder is empty.
discoveryPatterns. To contain the push_example_adapter.xml.
tql. To contain the TQL query created for the example. This folder is optional, but when the package is deployed, the TQL query is
automatically created.
<adapter-settings>
<adapter-setting name="enable.attributes.links.validation">true</adapter-setting>
</adapter-settings>
To enable adapter level validation of attribute and link, set the adapter setting enable.attributes.links.validation to true.
To disable adapter level validation of attribute and link, set the adapter setting enable.attributes.links.validation to false.
Note
Note: If the setting is not present, its default value istrue, which means that by default the attribute and link validation is
enabled.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 327
AI Operations Management - Containerized 24.4
Defines the mapping contents of the file. Must be the outermost block in
integration
the file except for the beginning line and any comments.
info
Defines information about the data repositories being integrated.
(integration)
1. Name: type
Is required?: Required
Type: String
2. Name: versions
Type: String
3. Name: vendor
Is required?: Required
Type: String
1. Name: type
Is required?: Required
Type: String
2. Name: versions
Type: String
3. Name: vendor
Is required?: Required
Type: String
targetcis
Container element for all CIT mappings.
(integration)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 328
AI Operations Management - Containerized 24.4
1. Name: name
Is required?: Required
Type: String
2. Name: mode
1. Name: name
Is required?: Required
Type: String
2. Name: mode
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 329
AI Operations Management - Containerized 24.4
1. Name: name
Is required?: Required
Type: String
Type: String
targetprimarykey
-OR-
(integration >
targetrelations > link)
-OR-
(integration >
targetrelations >
source_link_type_tree)
pkey
-OR-
-OR-
integration >
targetrelations >
source_link_type_tree >
targetprimarykey)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 330
AI Operations Management - Containerized 24.4
1. Name: name
Is required?: Required
Type: String
2. Name: datatype
target_attribute
Description: Data type of the target
(integration > targetcis
CIT's attribute.
> source_ci_type
Is required?: Required
-OR-
Type: String
integration > targetcis
> 3. Name: length
source_ci_type_tree
Defines the target CIT's attribute. Description: For string/char data types,
-OR- integer size of target attribute.
1. Name. type
Description. The type of mapping
between the source and target values.
map
Is required. Required
(integration > Type. One of the following strings:
targetcis > a. direct – Specifies a 1-to-1 mapping
source_ci_type > from source attribute's value to target
target_attribute attribute's value.
b. compoundstring – Sub-elements are
-OR-
joined into a single string and the target
integration > attribute value is set.
targetcis > c. childattr – Sub-elements are one or
source_ci_type_tree > more child CIT's attributes. Child CITs are
target_attribute) defined as those with composition or
Specifies how to obtain the source CIT's attribute value.
containment relationship.
-OR- d. constant – Static string
2. Name. value
(integration >
Description. Constant string for
targetrelations > link >
type=constant
target_attribute
Is required. Only required when
-OR- type=constant
Type. String
integration >
3. Name. attr
targetrelations >
Description. Source attribute name for
source_link_type_tree >
type=direct
target_attribute)
Is required. Only required when
type=direct
Type. String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 331
AI Operations Management - Containerized 24.4
aggregation
(integration >
targetcis >
source_ci_type >
target_attribute > map
Name: type
-OR- Description. The type of aggregation function
Is required?: Required
integration >
Type. One of the following strings:
targetcis >
source_ci_type_tree > csv – Concatenates all included values
target_attribute > map into a comma-separated list (numeric or
string/character).
-OR-
Specifies how the source CI's child CI attribute values are combined into count – Returns a numeric count of all
(integration > a single value to map to the target CI attribute. Optional. included values.
targetrelations > sum – Returns the sum of all numeric
link > target_attribute included values.
> average – Returns a numeric average of
map all included values.
min – Returns the lowest
-OR-
numeric/character included value.
integration > max – Returns the highest
targetrelations > numeric/character included value.
source_link_type_tree >
target_attribute > map)
source_child_ci_type
-OR-
integration >
targetrelations >
source_link_type_tree >
target_attribute > map)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 332
AI Operations Management - Containerized 24.4
validation
(integration >
targetcis > 1. Name. minlength
source_ci_type > Description. Excludes strings shorter
target_attribute > map than the given value.
Is Required?: Not required
-OR- Type. Integer
2. Name. maxlength
integration >
Description. Excludes strings longer
targetcis >
than the given value.
source_ci_type_tree >
Allows exclusion filtering of the source CI's child CIs based on attribute Is Required?: Not required
target_attribute > map
values. Used with the aggregation sub-element to achieve granularity of Type. Integer
-OR- exactly which children attributes are mapped to the target CIT's attribute 3. Name. minvalue
targetrelations
Container element for all relationship mappings. Optional.
(integration)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 333
AI Operations Management - Containerized 24.4
1. Name: name
Description. Source relationship name.
Is required?:Required
Type. String
2. Name: target_link_type
Description. Target relationship name
Is required?: Required
Type. String
3. Name: nameSpace
Description: The namespace for the link
that will be created on the target.
Is required?: Not required
Type: String
4. Name: mode
Description: The type of update required
for the current link.
Is required?: Required
source_link_type_tree Type: One of the following strings:
Maps a source Relationship type without the types which inherit from it to
(integration > insert – Use this only if the CI does
a target Relationship. Mandatory only if targetrelation is present.
targetrelations) not already exist.
update – Use this only if the CI is
known to exist.
update_else_insert – If the CI
exists, update it; otherwise, create a
new CI.
ignore – Do nothing with this CI
type.
5. Name: source_ci_type_end1
Description: Source relationship's End1
CI type.
Is required?: Required
Type: String
6. Name: source_ci_type_end2
Description: Source relationship's End2
CI type.
Is required?: Required
Type: String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 334
AI Operations Management - Containerized 24.4
1. Name: source_link_type
Description: Source relationship name.
Is Required?: Required
Type: String
2. Name: target_link_type
Description: Target relationship name.
Is required?: Required
Type: String
3. Name: nameSpace
Description: The namespace for the link
that will be created on the target.
Is required?: Not required
Type: String
4. Name: mode
Description: The type of update required
for the current link.
Is required?: Required
link Type: On the following strings:
Maps a source Relationship to a target Relationship. Mandatory only if
(integration > insert – Use this only if the CI does
targetrelation is present.
targetrelations) not already exist.
update – Use this only if the CI is
known to exist.
update_else_insert – If the CI
exists, update it; otherwise, create a
new CI.
ignore – Do nothing with this CI
type.
5. Name: source_ci_type_end1
Description: Source relationship's End1
CI type
Is required?: Required
Type: String
6. Name: source_ci_type_end2
Description: Source relationship's End2
CI type
Is required?: Required
Type: String
1. Name: name
target_ci_type_end1
Description: Name of the target
(integration > relationship’s End1 CI type.
targetrelations > link Is required?: Required
Type: String
-OR- Target relationship’s End1 CI type.
2. Name: superclass
Description: Name of the End1 CI type’s
integration >
super-class.
targetrelations >
Is required?: Not required
source_link_type_tree)
Type: String
1. Name: name
target_ci_type_end2
Description: Name of the target
(integration > relationship’s End2 CI type.
targetrelations > link Is required?: Required
Type: String
-OR- Target relationship’s End2 CI type.
2. Name: superclass
Description: Name of the End2 CI type’s
integration >
super-class.
targetrelations >
Is required?: Not required
source_link_type_tree)
Type: String
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 335
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 336
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 337
AI Operations Management - Containerized 24.4
UCMDB Java API. Explains how third-party or custom tools can use the Java API to extract data and calculations and to write data
to the UCMDB (Universal Configuration Management database).
UCMDB REST API. Allows you to perform topology modification and topology query related operations. You can also query the
UCMDB IDs or global IDs directly.
Data Flow Management Java API. Enables managing probes, jobs, triggers, and credentials for Data Flow Management.
Related topics
Universal CMDB API
Universal CMDB REST API
Data Flow Management Java API
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 338
AI Operations Management - Containerized 24.4
REST APIs can also operate based on global-ids. The request JSON of API methods has a switch to determine whether the request
contains UCMDB IDs or global IDs. If the request contains global IDs, they would be automatically converted to UCMDB IDs internally.
That is to say, as a UCMDB user, you can query the UCMDB IDs or global IDs directly, and the response time is satisfactory.
Permissions
Only users who have the Access to SDK permission can access the REST APIs.
In addition, it's possible to enable granular access to the REST APIs, according to a user's assigned permissions. For CRUD operations
(create, read, update, and delete CIs and relationships), the following REST API permissions are provided under System Access
Actions:
The REST API permissions are available for all out-of-the-box roles in UCMDB.
The REST API permissions check is done after the Access to SDK permission is validated.
If you don't have permission to execute a particular request type, the following error message is displayed: "HTTP 403 Forbidden".
The following REST API calls have been modified from POST request to GET request:
Previous POST calls are still available and they can be used, but you can't see them listed in Swagger UI. For more information, see
Topology REST calls can't be executed from Swagger UI.
To allow backward compatibility with older versions of UCMDB, a new setting restrict.rest.api.access has been created. The default
value is false.
For instance, if you want to create a query, you need the following permissions:
Access to SDK
REST API Create and Update
Permission to create views and queries
4. Click Invoke.
Related topics
Using the REST API
REST API reference and code samples
Examples of UCMDB REST API
Topology REST calls can't be executed from Swagger UI
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 339
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 340
AI Operations Management - Containerized 24.4
1.1.5.2.2.1. Conventions
This section uses the following conventions:
UCMDB refers to the Universal Configuration Management database itself. Universal CMDB refers to the application.
UCMDB elements and method arguments are spelled in the case in which they're specified in the interfaces.
Related topics
For full documentation on the available APIs, refer to the
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 341
AI Operations Management - Containerized 24.4
Methods for retrieving information about configuration items and relationships generally use the Topology Query Language (TQL).
Permissions
The administrator provides login credentials for connecting with the API. The API client needs the user name and password of an
integration user defined in the CMDB. These users do not represent human users of the CMDB, but rather applications that connect to
the CMDB.
In addition, the user must have the Access to SDK general action permission in order to log in.
Caution
The API client can also work with regular users as long as they have API authentication permission. However, this option is not
recommended.
Related topics
Topology Query Language
UCMDB API use cases
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 342
AI Operations Management - Containerized 24.4
The client creates other objects using interface methods. For example, to create a new query definition, the client:
1. Gets the query service from the main CMDB service object.
UcmdbServiceProvider provider =
UcmdbServiceFactory.getServiceProvider(HOST_NAME, PORT);
UcmdbService ucmdbService =
provider.connect(provider.createCredentials(USERNAME,
PASSWORD), provider.createClientContext("Test"));
TopologyQueryService queryService = ucmdbService.getTopologyQueryService();
TopologyQueryFactory factory = queryService.getFactory();
QueryDefinition queryDefinition = factory.createQueryDefinition("Test Query");
queryDefinition.addNode("Node").ofType("host");
Topology topology = queryService.executeQuery(queryDefinition);
System.out.println("There are " + topology.getAllCIs().size() + " hosts in uCMDB");
Perform authorization operations (create users and user groups, assign roles to users and groups, and so
getAuthorizationModelService
on).
getDataStoreMgmtService Query data store information including which CIs and attributes will be federated.
getDDMManagementService Analyze and view the progress, results, and errors of the Data Flow Management system
getHistoryService Information about history of monitored CIs (changes, removals, and so on)
Manage access to queries - save, delete, list existing. Also provides query validation and discovery of
getQueryManagementService
queries dependencies.
Resource tagging ("bundling" services). Allows explicit creation of new tags and removal of tags from all
getResourceBundleManagementService
tagged resources.
getResourceManagementService Deploy resource packages (of TQL queries, views, users, and so on) to the system.
getSnapshotService Provide services for managing snapshots (get, save, compare, and so on)
getSoftwareSignatureService Define software items to be discovered by the Data Flow Management system
getStateService Provide services for managing states (list, add, remove, and so on)
getSystemHealthService Provide system health services (basic system performance indicators, capacity and availability metrics)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 343
AI Operations Management - Containerized 24.4
Note
getTopologyQueryService
To get the discoveryjob CI Type instance, you can use DDMConfigurationService, because it's saved
in Unified Resource Manager (URM). For more details, see KM02529119.
getUcmdbVersion Query UCMDB and content pack versions and build information.
getViewArchiveService View result archiving services. Allows saving the current view result and retrieving previously saved results.
View execution service (execute definition, execute saved) and management service (save, delete, list
getViewService
existing). Also provides view validation and dependencies discovery.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 344
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 345
AI Operations Management - Containerized 24.4
A third-party asset management updates the CMDB with information available only in asset management
A number of third-party systems populate the CMDB to create a central CMDB that can track changes and perform impact analysis
A third-party system creates Configuration Items and Relations according to third-party business logic, to leverage the UCMDB
query capabilities
A third-party system gets the Configuration Items and Relations that represent the SAP system by retrieving the results of the SAP
TQL
A third-party system gets the list of Oracle servers that have been added or changed in the last five hours
A third-party system gets the list of servers whose host name contains the lab substring
A third-party system finds the elements related to a given CI by getting its neighbors
A third-party system enables users to specify the set of data to be retrieved from the CMDB. A user interface can be built over the
class model to show users the possible properties and prompt them for required data. The user can then choose the information to
be retrieved.
A third-party system explores the class model when the user cannot access the UCMDB user interface.
A third-party system outputs a list of the business services that could be impacted by a change on a specified host.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 346
AI Operations Management - Containerized 24.4
Usage
The mapping cache works as is, by default, no special care is required from the users. However, there are 3 new UCMDB settings which
allow you to customize the cache's configuration (by invoking the setGlobalSettingValue JMX method from the
UCMDB:service=Settings Services category):
cache.globalucmdbid.maxsize - Specify the maximum size of the cache, in number of entries; default value 1000.
cache.globalucmdbid.timeout.active - Specify the time, in seconds, after which an entry will be removed from the cache
(regardless of whether it was used or not); default value 1200 (20 minutes).
cache.globalucmdbid.timeout.idle - Specify the time, in seconds, after which an entry will e removed from the cache if not
used in the meantime; default value 300 (5 minutes).
Therefore, cache entries will be evicted after a time as specified in the above settings. If the cache fills, there is a Least Frequently
Used (LFU) eviction policy.
The cache is added in the API-server layer of the SDK, so it only has effect for the SDK methods of conversion from global ID to UCMDB
ID, that is, MultipleCMDBService.
Performance improvement
Compared to version 10.32, performance evaluation for the mapping cache shows an improvement of performance between 15% -
78% (depending on scenarios) over the same operations without the cache.
Conversion from Global_Id to Ucmdb_Id for a bulk of CIs (840) 78% increase in performance
Conversion from Ucmdb_Id to Global_Id for a bulk of CIs (840) 15% increase in performance
There is also an 18% increase in the average number of successfully completed requests.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 347
AI Operations Management - Containerized 24.4
1.1.5.2.2.7. Examples
Operations Bridge Manager:24.4/APIExamples
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 348
AI Operations Management - Containerized 24.4
REST APIs can also operate based on global-ids. The request JSON of API methods has a switch to determine whether the request
contains UCMDB IDs or global IDs. If the request contains global IDs, they would be automatically converted to UCMDB IDs internally.
That is to say, as a UCMDB user, you can query the UCMDB IDs or global IDs directly, and the response time is satisfactory.
Permissions
Only users who have the Access to SDK permission can access the REST APIs.
In addition, it's possible to enable granular access to the REST APIs, according to a user's assigned permissions. For CRUD operations
(create, read, update, and delete CIs and relationships), the following REST API permissions are provided under System Access
Actions:
The REST API permissions are available for all out-of-the-box roles in UCMDB.
The REST API permissions check is done after the Access to SDK permission is validated.
If you don't have permission to execute a particular request type, the following error message is displayed: "HTTP 403 Forbidden".
The following REST API calls have been modified from POST request to GET request:
Previous POST calls are still available and they can be used, but you can't see them listed in Swagger UI. For more information, see
Topology REST calls can't be executed from Swagger UI.
To allow backward compatibility with older versions of UCMDB, a new setting restrict.rest.api.access has been created. The default
value is false.
For instance, if you want to create a query, you need the following permissions:
Access to SDK
REST API Create and Update
Permission to create views and queries
4. Click Invoke.
Related topics
Using the REST API
REST API reference and code samples
Examples of UCMDB REST API
Topology REST calls can't be executed from Swagger UI
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 349
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 350
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 351
AI Operations Management - Containerized 24.4
1.1.5.2.3.1.1. Configuration
Operations Bridge Manager:24.4/RestApiConfiguration
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 352
AI Operations Management - Containerized 24.4
Authorization
The REST API uses JSON Web Token (JWT) for authorization.
You can obtain a token by making a POST REST call to the endpoint: <base_url>/authenticate with the payload that specifies the
credentials and client context. The following example demonstrates the content of such a payload:
The service then returns a token that has to be used for future REST calls. The token should be added in the header of a request in the
following manner:
Note
<base_url><resource_url>
<resource_url>: See the URL section of each call in REST API reference documentation. For details, see REST API reference and
code samples.
Important
When you make REST calls with the following two REST APIs:
/policy/calculate
/policy/export
The input for the endpoint should be either the name of the desired compliance view to be
executed:
{
"name": "complicanceView1"
}
or the baseViewName and the policies to be applied over it:
{
"baseViewName": "TestingBaseViewSimple",
"policyQueries":["policy1","policy2"]
}
If both sections are populated, the " name " has priority.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 353
AI Operations Management - Containerized 24.4
{
"username":"****",
"password":"****",
"repository": "mydomain.company.com",
"clientContext": 1
}
Tips
The logs produced by the REST API are in the following file:
<ucmdb-log-volume>/ucmdb/server/<podname>/rest_api.log
The REST API prints and consumes every date attribute in the ISO8601 format:
yyyy-MM-dd'T'HH:mm:ss.SSSZZ
Don't use the < (less than) and > (greater than) symbols in the request body. Instead, use < in place of the less than symbol
(<) and > in place of the greater than symbol (>).
The UD/UCMDB throttling solution is now in place to avoid UCMDB server outage due to low memory or excessive memory
consumption in various scenarios. For example, when you request for a large amount of CIs by making a REST API call, your REST
API call might be rejected if the UCMDB server is low on memory. If the REST API call get rejected because of UCMDB server is low
on memory, the HTTP status code will be 503. In this case, just wait for a while and try again.
Related topics
For an example about how to obtain a token, see A usage example.
REST API reference and code samples
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 354
AI Operations Management - Containerized 24.4
{
"username": "sysadmin",
"password": "Sysadmin?123",
"clientContext": 1
}
Status: 200
Response body:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzQzNTc3MDYsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.cVYsuum1Cqa
qfZV1K5KJ8nidOOif8Wv9tZsLFFZPbSs"
}
{
"nodes": [
{
"type": "cpu",
"queryIdentifier": "cpu1",
"visible": true,
"includeSubtypes": true,
"layout": ["name"],
"attributeConditions": [{
"attribute": "name",
"operator": "like",
"value": "%Pentium%"
}],
"linkConditions": []
}],
"relations": []
}
Note
The payload specifies the layout attribute to name , so that the CPU name will be
returned.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 355
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 356
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 357
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 358
AI Operations Management - Containerized 24.4
1.1.5.2.3.2.5. Get CI
Operations Bridge Manager:24.4/GetCI
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 359
AI Operations Management - Containerized 24.4
1.1.5.2.3.2.6. Update CI
Operations Bridge Manager:24.4/RestApiUpdateCI
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 360
AI Operations Management - Containerized 24.4
1.1.5.2.3.2.7. Delete CI
Operations Bridge Manager:24.4/RestApiDeleteCI
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 361
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 362
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 363
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 364
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 365
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 366
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 367
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 368
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 369
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 370
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 371
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 372
AI Operations Management - Containerized 24.4
1. Define Data
Define the data you want to retrieve from UCMDB. For example, “I want to retrieve all nodes”. To achieve this, you need to create
a new query which contains the CI types you are interested in.
b. Click New > Query. A new Query modeling pane opens to the CI Types tab.
c. Just drag and drop into the modeling pane the CI types you are interested in.
d. Click Save .
The Save Query dialog pops up. Save the query with a name by providing the name (for example, nodes_query) in the
Query Name field.
e. Return to the Resources tab. You to see all the queries here, most of them are out-of-the-box queries in a newly installed
UCMDB.
f. Double-click the query you just created to open it. In this example, double-click nodes_query.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 373
AI Operations Management - Containerized 24.4
g. In the modeling pane you can count the results of your query by clicking Calculate Query Result Count .
Calculating the TQL query is a good practice since it allows you to know that it has results.
The second request uses response from the first one to authenticate.
{"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvc2l0b3J5IjoiVUNNREIiLCJleHAiOjE1MDA0NTc0NDIsImN1c3RvbWVyIjoxLCJ
1c2VybmFtZSI6InN5c2FkbWluIn0.6SO434meWazmfsOoSd-fXFaTFDx9QomOadalrgPpp8s"}
You can extract the token value from the response above and put it along with the “Bearer” keyword into the
Authorization header of the second request.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 374
AI Operations Management - Containerized 24.4
Note
In the image above you also have the response which contains two CIs without any properties.
a. If you also want to see CIs' properties, go back to the Resources tab and double-click your query: nodes_query
b. Select the CI in the modeling pane, then in the CI properties pane, go to the Element Layout tab and click Edit .
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 375
AI Operations Management - Containerized 24.4
In the CI Types pane you can see your node type and all its subtypes. You can have different subtypes returning different
attributes. In this example, let us stick to the main flow.
d. Select Specific Attributes from the Attributes condition drop-down list, and then add the attributes you want to see in
the result to the Specific Attributes tab.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 376
AI Operations Management - Containerized 24.4
g. Now if you go back to your SoapUI and make the same request again with the same query name, you can also see the
attributes.
Note
Attention at how many attributes you add to your query. Each attribute you add will take processing power. The performance is
inversely proportional with the number of attributes. If you are working with a light amount of data, you will barely see a difference.
But when you have like millions of CIs, it will matter.
TQL queries are composed of nodes and relations, in real world entities have many different kind of relations with other entities, and
you can also query those types of structures.
In addition to the main feature described here, there are more advanced features available with UCMDB.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 377
AI Operations Management - Containerized 24.4
Conventions
RTSM Web Service API Reference
RTSM Impact Analysis Methods
Examples
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 378
AI Operations Management - Containerized 24.4
1.1.5.2.4.1. Conventions
Operations Bridge Manager:24.4/WebAPIConventions
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 379
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 380
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 381
AI Operations Management - Containerized 24.4
1.1.5.2.4.3.1. calculateImpact
Operations Bridge Manager:24.4/WebAPICalculateImpact
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 382
AI Operations Management - Containerized 24.4
1.1.5.2.4.3.2. getImpactPath
Operations Bridge Manager:24.4/WebAPIGetImpactPath
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 383
AI Operations Management - Containerized 24.4
1.1.5.2.4.3.3. getImpactRulesByNamePrefix
Operations Bridge Manager:24.4/WebAPIGetImpactRules
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 384
AI Operations Management - Containerized 24.4
1.1.5.2.4.4. Examples
Operations Bridge Manager:24.4/WebAPIExamples
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 385
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 386
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 387
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 388
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 389
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 390
AI Operations Management - Containerized 24.4
To create custom widgets, you must provide a Visio shape and the corresponding widget code.
Visio shape. A Visio shape acts as the placeholder for your custom widget. The shape is the visual representation of your widget.
Depending on the custom widget you want to create, it can be simple or advanced with interactive elements. Additionally, you can
save the shape as a stencil so that it becomes reusable. For more information, see the Modify the Visio shape section.
Widget code. To code how the custom widget behaves, you will get an API which enables you to create the widget by using DOM
and SVG manipulation. Save the result as JavaScript file. For more information, see the Define the custom widget code section.
After you have uploaded a dashboard containing the Visio shape and saved the JavaScript file on the server, you can view your
customized widget in Operations Cloud. Whenever you open a dashboard that contains the custom widget, the JavaScript file gets
loaded from the server and the custom widget code gets executed.
Related Topics
Modify the Visio shape
Define the custom widget code
Business Value Dashboard Community
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 391
AI Operations Management - Containerized 24.4
To identify a shape as a custom widget, you must define at least two properties for the shape: opr_item_type and opr_dashboard_item .
1. Make sure that Visio is running in Developer mode (Options > Advanced > General > Run in developer mode ).
2. Design your dashboard and add any shape that you will use later as the custom widget.
3. Right click on the shape and select Data > Define Shape Data...
4. In the Define Shape Data dialog box, enter the required properties:
These properties help the user interface identify that this shape is a widget.
Use opr_item_type to internally identify the widget type. When the user interface finds such a shape, it looks for a JavaScript file
according to the value of the opr_item_type property and adds the code to the running dashboard. Don't use opr as a prefix for the
widget type, as this prefix is reserved for internal use.
Example: The following is an example for a pumping circle (the full pumping circle example is available on the ColorYourData GitHu
b website):
opr_item_type:pumping_circle opr_dashboard_item:TRUE
5. Optional. Define the additional shape data property opr_grouping_item . For details, see the Widget shape type section.
6. Save and export the dashboard as Scalable Vector Graphic ( SVG ).
7. Optional. Save the custom widget's shape as stencil. For details, see the Save shape as stencil section.
Real shape: The shape that represents the real widget appearance. You can modify and adjust the appearance of the shape in
your widget code. For example, you can hide the real shape and use your own instead, or you can manipulate the shape by adding
and changing SVG elements and attributes.
Reference shape (grouping item): Group the shape that acts as a reference for other shapes. This type of shape will receive
the channel's data, but will display the other shape in the dashboard. You need this kind of shape, for instance, if you want to
display a shape that has the rules and data of another shape. Usage examples for this shape type are the Status Color Group and
Status Visible Group widgets. To create a Reference shape (grouping item) widget, define one additional shape data property:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 392
AI Operations Management - Containerized 24.4
When you define this property, the shape gets removed from the dashboard and all properties assigned to it will affect the shapes
grouped with this shape.
1. In the Shapes panel in Visio, click More Shapes > New Stencil (either US Units or Metric).
2. A new stencil gets created. If necessary, you can rename this stencil later when saving it to the file.
3. Drag the custom widget shape to the empty area of the stencil list.
Optional. You can rename your custom widget by double clicking the image in the stencil, or by right-click and selecting Rename
Master.
Click the Save Stencil button, or right-click the stencil and select Save. The stencil gets saved in the . vssx format.
To use this stencil when creating a dashboard, you can load the stencil into Visio. Click More Shapes > Open Stencil and select your
. vssx file.
Related Topics
ColorYourData GitHub
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 393
AI Operations Management - Containerized 24.4
Prerequisites
Third-party libraries. The following third-party libraries are available in the global name space and you can use them inside a
custom widget:
d3 d3.js 3.5.x
$ jQuery 3.2.x
_ lodash 3.10.x
Pass the AngularJS $http (version 1.6.x) service to the widget as part of its context. Load the additional libraries needed by a
custom widget using the jsLoadService function described below.
Accessing the API. You can access the API by accessing the bvdPluginManager global object directly. This service object gets
assigned in the window scope ( window.bvdPluginManager ), and is therefore made effectively global.
bvdPluginManager API
As mentioned in the prerequisites, to create a plugin, you have to access the bvdPluginManager API. This API only exposes one method:
registerWidget
Functionality: This method creates and registers a custom widget according to the widget configuration object that you give. This
method only supports one parameter of the JavaScript object type.
Params : This is the widget configuration object - a plain object that contains a set of supported configuration properties as listed
below:
Default
Property Type Description
value
obje ID of the widget. It must be the same as the value of the opr_item_type Visio property and the JavaScript file
id -
ct name of this custom widget.
displayNa strin
- Name as it appears in the Dashboard editor.
me g
func Callback function to initialize the widget with context that's passed back by Operations Cloud. This function is
init -
tion where you do most of your custom widget coding. For details, see the Init Plugin Callback section.
customPro obje
- Array of objects that's used to render the Custom Widget configuration UI.
perty ct
bool The value true indicates that the widget has a data field. For details, see the Custom Widget configuration UI
hasData true
ean section.
isMultisele bool The value true indicates that the user can select multiple data fields in the widget configuration UI (shows multi
false
ctDataField ean select input field) if hasData is true. Otherwise, user can select only one data field.
hasDataCh bool The value true indicates that the widget has a data channel. For details, see theCustom Widget configuration
true
annel ean UI section.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 394
AI Operations Management - Containerized 24.4
{
id: 'pumping_circle',
displayName: 'The Pumping Circle',
init: function(ctx) {
// widget implementation
},
customProperty: [{
id: 'bvd_range',
label: 'Range',
type: 'number',
default: 100
}, {
id: 'opr_coloring_rule',
label: 'Coloring Rule',
type: 'text'
}],
hasData: true,
hasDataChannel: true
}
parentGroup d3.js object The parent SVG group of the shapes generated by Visio.
An empty SVG group element to attach your own elements (DOM located one level inside the parent
svgGroup d3.js object
group).
array of d3.js
placeHolder A list of placeholder shapes generated by Visio.
objects
dataField string The name of the data field containing the values for this widget.
bbox object The computed bounding box of the placeholder (x, y, width, height).
$http object AngularJS $http service: widget uses this to get additional data from outside of Operations Cloud.
addAdminNotificatio
function Inform users of problems with the widget.
n
getChannelPropertie
function Gets additional information for this data channel.
s
dataField property
Functionality: Contains the name of the property of the data channel that's selected by the user in the widget configuration to hold
the value for this widget. If isMultiselectDataField is true, all selected data fields gets listed separated by semicolons.
getStatusColor function
Functionality: Get the calculated status color based on the last received value. For details, see the information about the opr_colori
ng_rule in the Special Properties section.
jsLoadService function
Functionality: Loads external JavaScript files asynchronously. If you use methods from this external JavaScript file in onChang
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 395
AI Operations Management - Containerized 24.4
e or onInit , you must execute onChange or onInit after resolving the promise of jsLoadService .
Params : location/address of the JavaScript file (string)
Example:
ctx.jsLoadService.loadScript(
'http://www.example.net/js/great_library.min.js'
).then(function success() {
// do something (e.g. execute onInit or onChange)
}, function failure() {
// do something
});
Functionality: Register an event when the widget receives a data channel update.
Property Description
ctx.onChange({
channel: 'myChannel',
callback: function(dataUpdateEnvelope) {
if (dataUpdateEnvelope && dataUpdateEnvelope.data) {
// update displayed date with content of dataUpdateEnvelope.data
}
}
});
Name Description
chann
the channel name (optional)
el
callba the init handler (called with the data received from the
ck server)
ctx.onInit({
channel: 'myChannel',
itemCount: 1,
callback: function(envelopeArray) {
if (Array.isArray(envelopeArray) && envelopeArray.length) {
// display initial data inside widget
}
}
});
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 396
AI Operations Management - Containerized 24.4
getProperty function
Functionality: Get the value of the widget's property, defined in the customProperty object of the widget configuration. For
details, see the Custom Widget configuration UI section.
addAdminNotification function
;* Functionality: Inform the current user of problems with the widget. Users with administrative rights will see these notifications
on the masthead next to their user name.
Params
severity
Return
none
getChannelProperties function
Params
none
Return: object which contains the property isRealtime ( boolean ). If isRealtime is false, this data channel doesn't get updated
and contains historical data only. Widgets can skip updating themselves after receiving the initial data.
The Plugin Manager generates the UI based on the customProperty field in the widget configuration. customProperty is an array of objects
that must contain the following set of properties:
type string String of any supported input type: number , text , or channel .
mandatory boolean Optional. Indicate that the property is mandatory for proper functionality of the widget (default is false ).
Example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 397
AI Operations Management - Containerized 24.4
{
...
customProperty: [
{
id: 'bvd_custom_property',
label: 'My Custom Label',
type: 'number',
default: 100,
mandatory: true
},
{
id: 'my_custom_channel',
label: 'My Custom Channel',
type: 'channel'
}
]
...
}
Always use the prefix bvd_ for custom properties. This enables Operations Cloud to distinguish between the SVG properties and the
custom properties. The prefix opr is reserved for the user interface internal use and mustn't be used for others. The only exception is
the ID opr_coloring_rule .
Default properties
The following properties are created for each custom widget and you can't remove them:
ID Description
opr_visibility_rul Created if hasDataChannel value to true in the registerWidget property. This allows the user to control the visibility of this
e widget.
opr_hyperlink Always created. Allows the specification of a URL, that's opened when the user clicks on this widget.
Special properties
opr_coloring_rule string
Functionality: If a custom property with this ID gets added to a widget, Operations Cloud will calculate a status color based on this
string, as described in the Status Color Group section. Custom widgets can get the resulting color string from the getStatusColor
function of the Init Plugin Callback. You can use this color in the onChange and onInit handlers to color the widget or parts of the
widget.
The file name must match the widget configuration ID: <widget_configuration_id>.js .
When you open a dashboard in Operations Cloud that contains this custom widget, the system loads its JS file from this directory. The
custom widget code is then executed, and the new custom widget gets registered in Operations Cloud.
Below is an example of how you can use the bvdPluginManager.registerWidget({}) with your widget configuration file. This example will
create a custom widget called pumping circle.
Example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 398
AI Operations Management - Containerized 24.4
'use strict';
/**
* The pumping circle widget
* This widget shows a circle that changes its radius
* based on the data coming through the channel
*/
bvdPluginManager.registerWidget({
id:'pumping_circle',
displayName:'The Pumping Circle',
init: function(ctx) {
const circleGroup= ctx.svgGroup,
range = ctx.getProperty('bvd_range') ||100
console.log('range = '+ range);
/* hide the placeholder */
ctx.placeHolder.attr('style', 'visibility: hidden;');
const circle = circleGroup
.attr('transform', 'translate('+ ((ctx.bbox.x+ ctx.bbox.width/2)) +','+
(ctx.bbox.y+ ctx.bbox.height/2) +')')
.append('circle')
.attr('r', ctx.bbox.width/4)
.attr('cx', 0)
.attr('cy', 0);
const pumpCircle=function(envelope) {
if (!envelope ||!envelope.data) {
return;
}
const currentColor= circle.attr('fill'),
msg = envelope.data,
radius = msg[ctx.dataField] / range * ctx.bbox.width/2;
circle.transition()
.duration(300)
.attr('r', radius)
.attr('fill', ctx.getStatusColor() || currentColor);
};
/* get initial state of this widget*/
ctx.onInit({
itemCount:1,
callback: function(envelopeArray) {
if (envelopeArray && envelopeArray.length>0) {
pumpCircle(envelopeArray[0]);
}
}
});
/* subscribe to changes */
ctx.onChange({
callback: pumpCircle
});
},
customProperty: [{
id:'bvd_range',
label:'Range',
type:'number',
default:100
}, {
id:'opr_coloring_rule',
label:'Coloring Rule',
type:'text'
}]
});
Related Topics
Bounding Box
AngularJS $http
Status Color Group
Library: d3.js
Library: jQuery
Library: lodash
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 399
AI Operations Management - Containerized 24.4
You can ingest data to OPTIC DL using one of the following methods:
Custom metric ingestion: This method allows you to ingest metrics of your choice (custom metrics) into OPTIC Data Lake. You
can use one of the following ways to ingest the custom metrics collected by the Operations Agent to OPTIC Data Lake.
Agent Metric Collector: In this method, the Operations Agent enables you to log custom data into the Metrics Datastore
along with the default performance metric classes. The Custom Metric Ingestion tools enable you to ingest the custom data
(metrics) from the Metrics Datastore into OPTIC Data Lake. For more information, see Custom metric ingestion using CMI and
Agent Metric Collector.
Streaming: In this method, OPTIC Reporting capability supports metrics streaming from the metric classes into OPTIC Data
Lake: GLOBAL, CPU, DISK, NETIF, FILESYSTEM . You can also integrate other metrics of your choice (those that aren't used in out-
of-the-box reports) into OPTIC DL. For more information, see Custom metric ingestion using the streaming policies
Open data ingestion: This method allows you to configure OPTIC DL and ingest data from different data sources using the APIs (
di_administration and di_receiver ). You can use the Streaming method to ingest data into OPTIC DL. In this method, you will stream
near real-time data from multiple sources into the OPTIC DL store. You can use this method when you want to stream data to
OPTIC DL. For more information, see Open data ingestion.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 400
AI Operations Management - Containerized 24.4
Custom metric ingestion using Custom Metric Ingestion (CMI) tools and Agent Metric Collector
Custom metric ingestion using the streaming policies
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 401
AI Operations Management - Containerized 24.4
Important
You must discard all the previous instances of this tool you're using and download the latest OPTIC DL deployment as described in this section.
Earlier versions of the Custom Metric Ingestions tools have the CVE-2021-45105 Apache-log4j security vulnerability which is fixed in the
current version. The version of the tools included with release 2022.05 are updated versions of the 2021.11 tools ( CMI_2021.11.zip ) with
the vulnerability removed. You must use the latest tool available with the hotfix. See hotfix.
Note
For information about logging custom data into the Metrics Datastore, see Logging custom
data.
This section describes how to ingest custom metrics from Metrics Datastore into OPTIC Data Lake to enable custom reporting using
Business Value Dashboard (BVD) or any other business intelligence reporting tool. To ingest custom metrics into OPTIC Data Lake, you
need to create custom content. The custom content is packaged as a .zip file with a known folder structure where each folder contains
a specific type of artifact. The supported artifacts include:
Metric (database schema) definition: You may define the OPTIC Data Lake tables and columns.
Collection definition for the Operations Agent data source: You may define which metrics to collect, the Operations Agents from
which to collect, and the frequency to collect the data.
Aggregation definition: You can aggregate the raw metrics in OPTIC Data Lake to hourly and/or daily tables. The aggregation type
can be generic (For example, min, max, average) or percentile.
Forecast definition: You use ''Forecast'' to identify the days to reach a particular threshold value, or to know the metric value at a
future point in time. You may apply linear forecast, wherein you use the standard linear equation y=mx+c, to compute forecast
value.
Retention rules: Metrics in OPTIC Data Lake get deleted based on the retention profiles associated with the data sets. Each data
set, which internally translates to a table in the database, can have one associated retention profile.
While you can create this content manually, the Custom Metric Ingestion tools (codatoexcel, exceltojson_schema, and
exceltoyaml_oacollector) automate much of the process by creating the folder structure and JSON/YAML files for configuring each
artifact. You can use the ops-content-ctl to upload and install the .zip file to create the schema. You can use the ops-monitoring-
ctl tool to start the collection.
After you install the custom content, use the Administer AMC with CLI to manage the custom metric collection. You can use
the Monitoring CTL (a CLI tool) to manage the Agent Metric Collection. To download and set up the monitoring CLI, see Set up
monitoring CLI for AMC. To manage the Agent Metric Collector, see Administer Agent Metric Collection.
You can download the Custom Metric Ingestion (CMI) tools from the following location:
https://${EXTERNALHOST}:${EXTERNALPORT}/staticfiles/custom-metric-ingestion/
On Linux:
You can download CMI tools using one of the following commands:
For example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 402
AI Operations Management - Containerized 24.4
For example:
Once you download the tool, run the unzip CMI_202x.xx.zip command to extract the file content.
On Windows:
https://<externalAccessHost>:<externalAccessPort>/staticfiles/custom-metric-ingestion/<CMI_yyyy.mm.zip>
1. codatoexcel tool: This tool converts the data in the Metrics Datastore (Operations Agent database) to excel files. It creates
two excel workbooks:
<DataSource.xlsx>: For every custom metric data source, the tool creates an excel workbook. For every system
metrics class (such as GLOBAL, CPU, DISK, NETIF, FILESYSTEM, and the like) the tool creates a worksheet inside the
workbook. Here, <DataSource.xlsx> is the name of the data source that you specified from the source.
Configuration.xlsx: These excel files contain metadata of raw, enrichment, and forecast tables. You must modify these
excel files to make them consumable by the exceltojson_schema tool.
2. exceltojson_schema tool: This tool uses the excel files generated by the codatoexcel tool (or any other excel files that are in the
required format) to create metadata, enrichment (daily, hourly, and forecast), and retention JSON files in respective folders.
3. exceltoyaml_oacollector tool: This tool uses the excel files generated by the codatoexcel tool to create Agent Metric Collector
configuration files.
4. The exceltojson_schema and exceltoyaml_oacollector tools would create the opr directory. You must then create a zip file containing
the opr directory and all its contents. Use the ops-content-ctl tool to upload the custom content to the Content Manager and
you could use ops-monitoring-ctl to deploy and start collection.
Note
For information about ops-content-ctl tool, see Configure CLI for Windows and
Linux.
For information about ops-monitoring-ctl tool, see Set up monitoring CLI for AMC.
Prerequisites
You can execute the CMI tool on an Operations Agent node or any machine that has the required custom class metadata. For more
details, see the topic ''Option 2: Run this tool outside an Operations Agent''.
Configure Agent Metric Collector. See Configure System Infrastructure Reports using Agent Metric Collector.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 403
AI Operations Management - Containerized 24.4
Synopsis
1. Run the codatoexcel tool to save the data in the Metrics Datastore into excel files
- <DataSource.xlsx> and Configuration.xlsx.
2. Modify the <DataSource.xlsx> and Configuration.xlsx. These excel files are used as inputs to the exceltojson_schema tool.
3. Run the exceltojson_schema tool to create metadata, enrichment (daily, hourly, and forecast), and retention JSON files in respective
folders.
4. Run the exceltoyaml_oacollector tool to create the Agent Metric Collector configuration files.
5. You must then create a zip file containing the opr directory and all its contents (The directory that contains all the artifacts for
custom metric ingestion).
6. Use the ops-content-ctl tool to upload the custom content to the Content Manager and you could use ops-monitoring-ctl to
deploy and start collection.
data The Operations Agent data source from which to collect metrics. You can see a list of data sources on an Agent by runningovcodautil -sho
source wds .
class The class names in the selected data source from which to collect metrics. You can see a list of classes and their metrics for each data
name source by running ovcodautil -obj on an Operations Agent.
Related topic
For information about the CodaToExcel fails to generate Excel files, see CMI tool fails to generate Excel files when ran directly on an OA
machine. You can also see https://kmviewer.saas.microfocus.com/#/OCTCR19G1747468.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 404
AI Operations Management - Containerized 24.4
The <DataSource>.xlsx and Configuration.xlsx files get populated with default values for most columns. You need to review the
contents and ensure that the mandatory columns are populated. Here are a few guidelines to modify the custom content and send the
metrics to OPTIC Data Lake:
Ensure that the right data types and column sizes are set appropriately. Modifying such aren't supported database operations.
Ensure that number of fields defined per table (including aggregate tables) is within Vertica system limits.
Don't create additional projections in the database or manually alter schema elements as this could impact the related metadata
and content upgrades.
Data type - Define the data type of the field correctly so that it enables join across data sets having semantically same fields.
When the data type is a string, define the max length correctly to avoid over allocation of resources during joins and load. If a data
type represents GUID/UID use UUID data type.
Max length - The default max length of the string field is 80. It's important to set the max length of the string to accommodate
the maximum size of data for that field. If you overestimate the length, it causes additional performance overhead during loading
and sorting.
Raw dataset - Raw dataset includes fields with predefined data. You may use them without making any modifications.
Aggregation dataset -
The aggregation dataset should include the tenant_id field. The values in this field contain either the tenant_id or Managed
Service Provider /Enterprise name.
The aggregation dataset should also include timestamp_utc_s and timestamp_tz, which contain time in epoch and timestamp
format respectively.
Other standard fields defined in the source dataset should be present in the aggregation dataset if the fields are applicable
for the aggregation dataset.
Most of the fields in the aggregation dataset have predefined data. We recommend that you don't modify the predefined
data. However, if you choose to edit, make sure that they have valid data.
Note
Agent Metric Collector can only collect metric classes that are summarized by the Operations Agent, it isn’t designed to collect raw
metric class (for example, Process).
The CMI tool doesn't support custom rollup functions.
Operations Agent limit in the amount of data that can be logged into a single CODA instance must be considered.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 405
AI Operations Management - Containerized 24.4
"metric_transformation": {
"ALL": {
"rules": [
{
"from": "test",
"to": ""
}
]
},
"SCOPE_GLOBAL": {
"rules": [
{
"from": "-1",
"to": ""
}
]
}
}
"metric_transformation": {
"ALL": {
"rules": [
{
"from": "test",
"to": "abc"
}
]
},
"SCOPE_GLOBAL": {
"rules": [
{
"from": "test",
"to": "xyz"
}
]
}
}
Ensure that the old and new value data type must match. If the data types mismatch, the tool rejects the mismatch metric data,
and it stores that data into the rejected table in Vertica.
Use empty quotes ("_") to specify blank or NULL value for a metric. The empty quotes are applicable to all data types.
Example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 406
AI Operations Management - Containerized 24.4
"ALL": {
"rules": [
{
"from": "-1",
"to": ""
}
]
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 407
AI Operations Management - Containerized 24.4
Note
Note
Here:
-source [or] -s (optional parameter) : ovcodautil command (-obj) output file name
-datasource [or] -d (optional parameter): Name of CODA DataSource (If you don't specify, all DataSource schema gets exported)
-class [or] -c (optional parameter) : Name of CODA Class (Along with this parameter, you must specify the DataSource name. If you don't spec
ify the CODA class name, all classes get exported.)
-output [or] -o (optional parameter) : Output directory path (If you don't specify, the excel gets created in current directory.)
-content_prefix [or] -cp (optional parameter) : Name (For example: opsb) that is prefixed to the OPTIC Data Lake table names
-print [or] -p (optional parameter) : Print debug messages on screen (If you don't specify, only progress messages are displayed.)
--help [or] -h (optional parameter) : Print usage details
For information about modifying the excel workbooks, see Modify the workbooks.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 408
AI Operations Management - Containerized 24.4
For example:
java -jar exceltojson_schema-2021.11.jar -c Configuration.xlsx -s opsb_ad.xlsx -cn msactivedirectory -ma -log error -o C:\test
In this example: <version> is 2021.11 , <configuration_excel> is Configuration.xlsx , <datasource_excel> is opsb_ad.xlsx and <content_n
ame> is msactivedirectory . Only aggregation tables (daily and hourly) get generated in the C:\test\opr\integration\coso\enrichment\daily
\msactivedirectory and C:\test\opr\integration\coso\enrichment\hourly\msactivedirectory directory. The log level gets set to error.
java -jar exceltojson_schema-2021.11.jar -c Configuration.xlsx -s opsb_ad.xlsx -cn msactivedirectory -mf -log error -o C:\test
In this example: <version> is 2021.11 , <configuration_excel> is Configuration.xlsx , <datasource_excel> is opsb_ad.xlsx and <content_n
ame> is msactivedirectory . When you pass the -mf argument, forecast tables get generated in the C:\test\opr\integration\coso\enrichm
ent\forecast\ path.
The log level gets set to error.
Mandatory parameters:
Optional parameters:
-help [or] -h [or] -? : Print this help message to the output stream
-bulk_change [or] -b : Accept the file path for metric override if provided, else, takes metric-override.json file from the resource folde
r
-metric_raw [or] -mr : Build raw(metadata) jsons and its retention profile
-metric_aggregation [or] -ma : Build aggregation(hourly/daily) jsons and its retention profile
-metric_forecast [or] -mf : Build forecast jsons and its retention profile
-log_level [or] -log : Set application log level using ERROR,WARN,INFO,DEBUG,TRACE. By default, the log level is set to DEBUG.
-out [or] -o : Output directory path
If -o/-out is not passed, output folder 'opr' gets generated in jar directory
Important
The tool automatically prefixes "opsb_ext_ " to the schema elements in the raw, and enrichment JSON files. Don't remove or modify this
prefix.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 409
AI Operations Management - Containerized 24.4
Here, <datasource_excel> is adspi.xlsx and <content_name> is msad. The YAML files get generated with the inputs that you
provided for the target_selection field.
Here:
-single_oacollector [or] -soa : Generate single oacollector file for all datasource excel/s
-skip_historic [or] -sh : Historic oacollector file will not be generated with json oacollector output
-target_selection [or] -ts : Input options for custom tqls with comma separator
-metric_transformation [or] -mt : oacollector files are generated with metric_transformation section
-test_append [or] -ta : Generate oacollector files with new name using test_append value
-bulk_change [or] -b : Accept the file path for metric overwrite if provided, else, takes metric-override.json file from the resource
folder
-help [or] -h : Prints this help message
2. Create a zip file containing the opr directory and all its contents. Make sure that you follow the naming convention to name the
zip file, else the ops-content-ctl tool will be unable to upload the custom content to the AI Operations Management Content
Manager.
Naming convention: <name_of_the_content>_<4 digit version year>.<2 digit version month>.<3 digit build number>
amc-credential-obm-certificate.yaml
Go to opr\integration\collection\credential\amc-credential-obm-certificate.yaml and update the parameters:
name: <obmName>_cert_auth
Note: Refer to this name in amc-target-oa.yaml
certificatestring: <ONE LINED CERTIFICATE>
password: <password given in the issue cert command>
trustcertificatestring: <USETHEREALCERTSTRINGHERE>
amc-target-oa.yaml
Go to opr\integration\collection\target\amc-target-oa.yaml and update the parameters:
name: <obmName>_oa_nodes
Note: Refer to this name in collector-oa.yaml
credential: <obmName>_cert_auth
Note: You must use the same name present in the "name" field of amc-credential-obm-certificate
endpoint: <obm url>
For example: https://abcd1234.hpeswlab.net:443/
amc-credential-obm-rtsm.yaml
Go to opr\integration\collection\target\amc-target-obm-rtsm.yaml and update the parameters:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 410
AI Operations Management - Containerized 24.4
name: <obmName>_basic_auth
Note: Refer to this name in amc-target-obm-rtsm.yaml
username: <rtsm username>
password: <rtsm password>
amc-target-obm-rtsm.yaml
Go to opr\integration\collection\target\amc-target-obm-rtsm.yaml and update the parameters:
name: <obmName>_rtsm
Note: Refer to this name in collector-oa.yaml
endpoint: <obm url>
For example: https://abcd1234.myexample.net:443/
credential: <obmName>_basic_auth
Note: You must use the same name present in "name" field of amc-credential-obm-rtsm.yaml
Note
For more information on creating the OBM-Certificate configuration file, see Create OBM-Certificate configuration
file.
ops-monitoring-ctl create file -n etc_hosts.txt --readfile <etc_hosts.txt file path> -type generic
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 411
AI Operations Management - Containerized 24.4
ops-monitoring-ctl create file -n proxy.xml --readfile <proxy.xml file path> --type generic
ops-monitoring-ctl create file -n port.txt --readfile < port.txt file path> -type generic
Note
For information about ops-content-ctl tool, see Configure CLI for Windows and
Linux.
For information about ops-monitoring-ctl tool, see Set up monitoring CLI for AMC.
1. Download and install the GPG tool for your platform from GNU Privacy Guard (GnuPG)
2. Go to the bin directory in the GnuPG directory.
3. Run the command: gpg --gen-key
4. When prompted to enter a key type. Enter 5.
For example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 412
AI Operations Management - Containerized 24.4
For example:
gpg --import /path_to_the_key/B1275EA3.pub
3. Execute the command to trust the MF Public key in the GPG keyring:
"gpg --edit-key <'Public key File name'> "
When prompted, select option 5 (I trust ultimately )
4. Exit from the GPG tool.
Here,
<filename.sig> Name of the signature file that you download along with the Custom Metric Ingestion tools.
For example:
Related topics
To troubleshoot issues during the tool execution, see Troubleshoot CMI tool errors.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 413
AI Operations Management - Containerized 24.4
<DataSource>.xlsx contains one worksheet per metric class that you want to collect. If the<DataSource>.xlsx contains more than one
worksheet, remember to update the values across all the worksheets.
The following table provides you with the information to modify the <DataSouce.xlsx>:
Aggregation Req The default value is y - yes. If you don't want to aggregate data, specify n.
String
uired (y/n) If a field is a key field (isKey=true ), then you must specify n.
If you set the Aggregation as daily, hourly, or both daily and hourly, you must specify the aggregation type. The default
value is g.
If you set the Aggregation Type as g, you must specify the aggregation function.
Set this value to indicate the type aggregate functions. You may enter a comma separated aggregation functions such
Aggregation Fun
String as min, max, sum, count, average, or lastval . The default value for:
ction
the integer is average
the string is lastval
If you set the Aggregation Type as p, you must specify the percentile.
Percentile Integer
The percentile is applicable only on percentage metrics.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 414
AI Operations Management - Containerized 24.4
Column Data
Description
name type
Forecast Rule You may choose to use the default value or set the value as ForecastPoint (fp), or ForecastThersholdType (dtt).
Type (fp/dtt/fp String
,dtt) fp specifies the days to forecast.
If you set the Forecast RuleType as fp or fp, dtt you must specify the forecast point.
ForecastPoint String
Specify the number of days to forecast. For example: 30,60,90
(Optional) If you set the Forecast RuleType as fp or fp, dtt, you can specify the "Minimum Value-Forecast Value" for each
ForecastFP ForecastPoint . You can set either the minimum value or the combination of the minimum value and the forecast value. For
Condition(Min String example, 1,31,63 or 1-10, 31-60, 63-90 or 1,31-60, 63
-Forecast)
The number of ForecastFP Condition(Min-Forecast)should be equal to the number of forecast points (ForecastPoint).
(Optional) If you set the Forecast RuleType as fp or fp, dtt, you can specify the "Maximum Value-Forecast Value" for each
ForecastFP ForecastPoint . You can set either the maximum value or the combination of the maximum value and the forecast value. For
Condition(Max String example, 10,44, 73 or 10-20, 44-60, 73-90 or 10, 44-60, 73
-Forecast)
The number of ForecastFP Condition(Max-Forecast)should be equal to the number of forecast points (ForecastPoint).
ForecastThres If you set the Forecast RuleType as dtt or fp, dtt, you must specify the ForecastThresholdValue.
String
holdValue For example: 90,95
(Optional) If you set the Forecast RuleType as dtt or fp, dtt, you can specify the "Minimum Value-Forecast Value" for each
ForecastDTT ForecastThresholdValue . You can set either the minimum value or the combination of the minimum value and the forecast
Condition(Min String value. For example: 1,31,63 or 1-10, 31-60, 63-90 or 1,31-60, 63
-Forecast) ForecastDTT Condition(Min-Forecast) list should match with the length of ForecastThresholdValue . You can set either the
minimum value or the minimum value and the forecast value.
(Optional) If you set the Forecast RuleType as dtt or fp, dtt, you can specify "Maximum Value-Forecast Value" for each For
ForecastDTT ecastThresholdValue . You can set either the maximum value or the combination of the maximum value and the forecast
Condition(Max String value. For example: 10,44, 73 or 10-20, 44-60, 73-90 or 10, 44-60, 73
-Forecast) ForecastDTT Condition(Max-Forecast) list should match with the length of ForecastThresholdValue . You can set either the
maximum value or the maximum value and the forecast value.
The unit for the retention period value is days. The retention period value must be positive and in multiples of 0.25 (6 hours). The
retentio
Double minimum permissible value is 0.25. The default value for the retention period is 90 days.
nPeriod
Update the retention period in the Schema-raw worksheet.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 415
AI Operations Management - Containerized 24.4
Important
You can't modify the fields in the Aggregation worksheet after content deployment or
across upgrades.
Column Data
Description
name type
Default value: OPTIC Data Lake Standard Fields (defined in 'id' column of COSOStandardFields.xlsx present in resource
folder), Key Fields (defined in 'id' column of respective 'cosoTableName' sheet in <datasource>.xlsx)
groupBy
String The ID of the fields to group by while aggregating the data.
Fields
groupByFields must be a comma separated string containing a valid metric id of the table.
groupByFields must contain id of the metric that must be present in the source dataset.
The ID of the fields to orderBy while aggregating the data. When using analytic functions that are sensitive to order like last_valu
e , you must give this value.
Enter a comma separated string containing the valid metric id of the source dataset.
orderBy String
Important
The unit for the retention period value is days. The retention period value must be positive and in multiples of 0.25 (6 hours). The
minimum permissible value is 0.25. The default values for:
retentio
Double daily aggregation is 1440 minutes
nPeriod
hourly aggregation is 60 minutes.
Column Data
Description
name type
Default value: OPTIC Data Lake Standard Fields (defined in 'id' column of COSOStandardFields.xlsx present in
keyFiel resource folder), Key Fields (defined in 'id' column of respective 'cosoTableName' sheet in <datasource>.xlsx)
String
ds
The ID of the fields to be considered as "Key" fields while calculating forecast.
schedul Since the schedule:type is set as 'fixedDelay', provide the delay between different runs of this task in minutes. For example:
Integer
e:value 1440 to run the task every day. The default value is 5 hours.
The unit for the retention period value is days. The retention period value must be positive and in multiples of 0.25 (6 hours). The
retentio minimum permissible value is 0.25. The default value is 1825 minutes.
Double
nPeriod
Update the retention period in the Forecast worksheet.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 416
AI Operations Management - Containerized 24.4
The following table details the key that are used for metrics override.
Data
Key Description
type
codaname String Metric Name in Coda (CODA NAME in the DataSource.xlsx file)
This field defines the scope of change you want to make to metrics.
regax String "" or null -> A parameter change is only applicable for the captioned CODA NAME.
"*" -> A parameter change is applicable for all metrics which contain the captioned CODA NAME.
The parameters for metrics which you want to update with new values.
null or " " -> No change in a current value.
parameter Non null -> A current value you want to replace with a new value.
String
s
The parameters contain keys for raw, aggregation, and forecast schema. The following tables detail keys for each schema
type.
id String The Id for COSO must follow COSO guidelines (the id column in the DataSource.xlsx file)
name String The Name for COSO must follow COSO guidelines (the name column in in the DataSource.xlsx file)
nullable String The Boolean value true / false (the isNullable column in in the DataSource.xlsx file)
key String The Boolean value true / false (the isKey column in in the DataSource.xlsx file)
primarykey Integer The Boolean value true / false (the isPrimaryKey column in in the DataSource.xlsx file)
Data
Key Description
type
aggregationReq
String A string value y / n ( Aggregation Required column in in the DataSource.xlsx file)
uired
aggregation String A string value of d / h / d , h ( d -> Daily , h -> Hourly ) (the Aggregation column in in the DataSource.xlsx file)
aggregationTyp A string value of g / p / g , p ( g -> GenericAggregation , p -> PercentileAggregation ) (the Aggregation Type column in
String
e in the DataSource.xlsx file)
aggregationFunc A string value of sum/average/min/max/count/lastval (the Aggregation Function column in in the DataSource.xlsx
String
tion file)
percentile Integer An integer value between 1-100 (the Percentile column in in the DataSource.xlsx file)
Data
Key Description
type
forecastRequired String A string value y/n (the Forecast Required column in in the DataSource.xlsx file)
forecastRuleTyp
String A string value of fp/dtt/fp,dtt (the Forecast RuleType column in in the DataSource.xlsx file)
e
A comma separated string value for number of days for forecast (the ForecastPoint column in in the DataSource.xlsx
forecastPoint String
file)
forecastFPMinCo A string value (comma separated and - split) for a minimum forecast day and forecast point (the ForecastFP Condition(M
String
ndition in-Forecast) column in in the DataSource.xlsx file)
forecastFPMaxCo A string value (comma separated and - split) for a maximum forecast day and forecast point (the ForecastFP Condition(
String
ndition Max-Forecast ) column in in the DataSource.xlsx file)
forecastThreshol A comma separated string value for number of days for forecast threshold (the ForecastThreshold column in in the
String
dValue DataSource.xlsx file)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 417
AI Operations Management - Containerized 24.4
Data
Key Description
type
forecastDTTMinC A string value (comma separated and - split) for a minimum forecast day and forecast point (the ForecastDTT Condition(
String
ondition Min-Forecast) column in in the DataSource.xlsx file)
forecastDTTMax A string value (comma separated and - split) for a maximum forecast day and forecast point (the ForecastDTT Condition
String
Condition (Max-Forecast ) column in in the DataSource.xlsx file)
[
{
"codaName": "CODA-NAME", /* Metric Name in Coda (CODA NAME in the datasource.xlsx file) */
"regax" : "*", /* This field is used to define scope of change needs to be done
"" or null -> Parameter Change is applicable only for captioned CODA NAME
"*" -> Parameter Change is applicable for all Metric contains captioned CODA NAME */
"parameters": /* Parameter for metric which need to be change with new values
null or " " -> no change in current value
NonNull -> New value to by which to be replaced */
{
/* "The following fields belong to basic raw_schema */
"id": "coda_name_id", // The Id for COSO must follow COSO guidelines (id column in DataSource.xlsx file)
"name": "coda_name", // The Name for COSO must follow COSO guidelines (name column in DataSource.xlsx file)"
"nullable": true, // Boolean value true/false (isNullable column in the DataSource.xlsx file)
"key": true, // Boolean value true/false (isKey column in the DataSource.xlsx file)
"primarykey": true, // Boolean value true/false (isPrimaryKey column in the DataSource.xlsx file)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 418
AI Operations Management - Containerized 24.4
You must include the category field in the metadata section of the custom content JSON file used for creation of Optic Data Lake
artifacts.
After you install custom content, you may modify it to include a new metric for collection, or include data aggregation and forecasting.
For the modifications to take effect, you must upgrade the content. Use either of the two options to upgrade content:
For example:
3. Add an incremented version to the name of the downloaded zip file. You can either increment the build number or add a custom
version.
Naming convention:
<name_of_the_content>_<4 digit version year>.<2 digit version month>.<3 digit build number>
<name_of_the_content>_<4 digit version year>.<2 digit version month>.<3 digit build number>.[optional 3 digit postfix to indicate custo
m versions over a build number]
For example:
For example:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 419
AI Operations Management - Containerized 24.4
After you modify the workbooks, follow the steps to upgrade the content:
1. Run the codatoexcel, exceltojson_schema, and exceltoyaml_oacollector. For details, see "Ingest custom metrics into OPTIC
Data Lake" for details.
2. Create a zip file containing the opr directory and all its contents.
3. Save the zipped file with an incremented version. You can either increment the build number or add a custom version.
Naming convention:
<name_of_the_content>_<4 digit version year>.<2 digit version month>.<3 digit build number>
<name_of_the_content>_<4 digit version year>.<2 digit version month>.<3 digit build number>.[optional 3 digit postfix to indicate custo
m versions over a build number]
4. Use the ops-content-ctl tool to upload the custom content to the Content Manager.
Note
For information about ops-content-ctl tool, see Configure CLI for Windows and
Linux.
Here, replace <path to configuration yaml file> with the path of the configuration yaml file.
For example:
Here, replace <path to configuration yaml file> with the path of the configuration yaml file.
For example:
Note
Use the command ops-monitoring-ctl get collector-status -V 2 to get the details of the logs.
If the " ops-monitoring-ctl
get collector-status " command returns " NA " as the status, it indicates that the collector hasn't
run yet.
Related topics
To modify the data retention, see Customize data retention.
To troubleshoot issues while using the Custom Metric Ingestion tool , see Troubleshoot CMI tool errors.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 420
AI Operations Management - Containerized 24.4
3. Expand the Sys_SystemMetrics_MetricStoreMapping aspect, select the latest version, click , and then click Edit Policy
Template.
4. On the Edit Raw Editor: Sys_SystemMetrics_MetricStoreMapping page, click Policy Data.
5. For each specific class, you can find the complete list of metrics under the metric_map section. Copy the metric that you want to
send to OPTIC Data Lake from the metric_map section. Add the metrics under the metric_list section within the specific
class_name.
For example: If you want to send GBL_OSKERNELTYPE_INT to OPTIC Data Lake, add the metric in the class_name GLOBAL in
the metric_list section.
6. Click Save.
3. Expand Sys_SystemMetrics_MetricStoreStreaming aspect, select the latest version, click , and then click Edit Policy
Template. The Edit Metric Streaming Configuration Policy window appears.
4. Expand the metric class where you want to add the metrics. Add the metrics and click SAVE AND CLOSE.
For example: Add the GBL_SYSTEM_UPTIME_SECONDS under GLOBAL:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 421
AI Operations Management - Containerized 24.4
3. Select the System Metrics Metric Store Streaming aspect, select the latest version of the aspect and click .
4. The Edit Aspect: System Metrics Metric Store Streaming page appears:
6. Select the latest version of the aspect and click Assign and Deploy Items.
7. In the Assign And Deploy Aspect window, select the Operations Agent node to which you want to deploy the aspect.
8. Click Assign.
The updated aspect gets deployed and the metrics (For example: GBL_OSKERNELTYPE_INT) sent to OPTIC Data Lake.
Related topics
For more information on Metric Streaming Policies, see Metric Streaming Configuration Policies.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 422
AI Operations Management - Containerized 24.4
To ingest the data into OPTIC DL, you can use the HTTPS streaming interface. OPTIC DL RESTful APIs are documented using the
OpenAPI Specification.
OPTIC DL Administration REST Interface - helps you to configure the datasets and data processing rules like aggregate in
OPTIC DL.
OPTIC DL HTTP Receiver Interface - helps you to ingest the data from third-party tools into OPTIC DL using the HTTP
interface. The messages sent to the OPTIC DL HTTP Receiver interface must be in JSON format.
OPTIC DL Data Access REST Interface - helps you to view the data stored in OPTIC Data Lake on your custom portals.
API functions
You can perform the following using the APIs:
Create datasets
Configure aggregate and forecast
Configure the retention period
Stream the data to OPTIC DL
Check the status of the dataset configuration
Access the data
Related topics
Use APIs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 423
AI Operations Management - Containerized 24.4
1.3.2.1. Plan
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 424
AI Operations Management - Containerized 24.4
Entity: represents a specific object in the data model. In data warehouse, an entity is also called as dimension. In configuration
management, it's called a configuration item (CI). In monitoring these are managed objects such as nodes, network devices,
applications, running software, business services, and their underpinning objects.
Schema: is a container for database objects like tables, views etc. You can set privileges at the schema or at individual object
within the schema.
Entity Dataset: contains a collection of entities. The relation between entities are also modeled as an entity.
Aggregate Dataset: contains data summarized from another dataset.
Topic: represents a data stream within OPTIC DL Message Bus. You can consume or produce messages from topics.
Important
You must add a prefix to the name as opsb_ext_ while creating the datasets or Aggregate datasets to avoid naming conflicts. For
example: opsb_ext_sysinfra_disk .
See the following examples for the domain naming conventions in the AI Operations Management context:
Application
Name Prefix Description using the
prefix
AI Operations Management
manages IT environments,
AI
such as systems, business
OpsB opsb Operations
and software applications,
Management
enterprise software
components, etc.
Hardware, software
components, and the links
AI
between these components
CMDB cmdb Operations
defined in the configuration
Management
management database
belongs to this domain.
A meaningful table class identifies the semantics of the metrics class with an underscore as the separator. You can derive the
class name for the aggregated dataset from the source dataset as _<5min/10min/15min/1h/1d/1m/1y> . For example
opsb_sysinfra_node: A dataset that contains system infrastructure node data.
opsb_sysinfra_node_1h: An aggregate table that contains hourly summarized system infrastructure node data.
To perform time aggregation, the timestamp must be in UTC in the source dataset. Hence, datasets that hold time series data
should include a column of type integer to represent the measurement time of the record.
Flatten the dimension/entity attributes that the query uses along with the data of the entity/dimension. This helps in avoiding joins
when accessing the data.
The total number of fields in the dataset shouldn't exceed 250 for optimal performance.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 425
AI Operations Management - Containerized 24.4
Don't use isPrimaryKey in the dataset to which the streaming interface ingests data. While loading data into the database, the data
load stops if a record violates the primary key restriction.
Don't overestimate the size of varchar columns for optimal performance.
Specify the storage hints like distribution key (shard key), and sort order while creating the dataset.
cmdb_glo CMDB
UUID The global CMDB id of the monitored entity (CI).
bal_id global ID
Name of the collection policy that configured the data producer to collect the data row.
For SiS this should include the name of the corresponding monitor.
For direct streaming from Agent, this should be the name of the corresponding streaming
collection Collection
policy.
_policy_n string 255 Policy
For collection service collecting agent metrics, this should be the name of the corresponding
ame Name
collection policy. In case the policies do have versions, then suffix with the corresponding
version number.
For example: MyCollectionPolicy_v1.3
Monitored
node_fqd
string 255 Node Fully qualified host name of the monitored server.
n
FQDN
node_ipv Monitored
IPv4
4_addres string 50 Node IPv4 IPv4 address of the monitored server.
address
s Address
node_ipv Monitored
IPv6
6_addres string 50 Node IPv6 IPv6 address of the monitored server.
address
s Address
Monitored
node_ip_t
string 80 Node IP IP type of the monitored node (IPv4 or IPv6).
ype
Type
Monitored
node_sho
string 255 Node Short Short name of the monitored server. The name mustn't contain any '.' (period) character.
rt_name
Name
Monitored
node_tim
Node
ezone_off double hours Timezone offset to UTC in hours, of the monitored server. For example: +1, +4.5, -8
Timezone
set_h
Offset
producer ID that uniquely defines the data producer instance within a given producer instance type.
Producer
_instance string 80 Examples are: SiteScope:<DNS name of the SiS server>, OBM:<external virtual IP used to
Instance ID
_id address this specific OBM server> , OA:<ovcoreid of agent system>
producer Producer
The type of data producer that ingested the data. For example: SiteScope, Operations
_instance string 80 Instance
Agent, OBM Server etc.
_type Type
tenant_id
string 80 Tenant ID ID of the tenant.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 426
AI Operations Management - Containerized 24.4
timestam
integer Timestamp Unix epoch time at which the counter value (sample) was gathered.
p_utc_s
Name
Use a meaningful name defined in the model catalog, and clearly identifies the requirement.
Note
The name of the aggregated field should be the same as the source field if you have derived the aggregated field from a single source
field in another dataset.
Avoid long names in field names. Use shortened forms that are accepted and commonly understood. For example: netif for
network interface, util for utilization, mem for memory, etc.
For metrics belonging to the same category, use consistent prefix. For example: mem_phys_mb , mem_virt_avail_mb.
You should follow the semantics of metrics. For example: You can't interchange the FQDN and host name.
Use prefixes for domain manager based integrations to avoid overlap. For example: opsb_agentless_metric1 , opsb_aws_metric1.
Don't create additional projections in the database or manually alter schema elements as this could impact the related metadata
and content upgrades.
Display labels should be meaningful and reference units wherever applicable. For example: CPU User Mode Time (seconds).
Aggregation_type
Applicable for fields that represent aggregated data. For example: sum, count, avg, min, max, sd, lv, pctl95, baseline, upper_normal,
lower_normal, baseline_dev, fcst, dtt etc.
Unit:
You can suffix the field name with the respective unit.
Data (in bytes): 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb'
Data (in bits): 'bit', 'kbit'
Time: 'us','ms', 's', 'min', 'h', 'd', 'm', 'y'
Frequency: 'hz', 'khz', 'mhz', 'ghz', 'thz'
Percentage: 'pct'
Count: 'count'. For example: cpu_interrupt_count, netif_collision_count
Rates: For well-defined rate units like bits per second use the corresponding abbreviation. For example: 'bps'. For others, use '<unit1>_per_<
unit2>' syntax. For example: count_per_min
Data type
Define the data type of the field correctly so that it enables joining across data sets having semantically the same fields. When the
data type is a string, define the max length correctly to avoid over allocation of resources during joins and load. If a data type
represents GUID/UID use the UUID data type.
Ensure that the right data types and column sizes are set. Database operations don't support any modification to data type.
Percentages are calculated and populated in the columns to avoid additional calculations of data.
Note
The metrics in the dataset must have one record for a timestamp in one row and not one metric in each row for the same
timestamp.
For example: The correct method is as follows:
12/06/2022:06:30:00 dbname1 metric1val metric2val metric3val
12/06/2022:06:35:00 dbname1 metric11val metric12val metric13val
Data ingestion
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 427
AI Operations Management - Containerized 24.4
When uploading data, if the clients didn't receive a successful response due to a network glitch or back pressure, clients should
retry the ingestion to avoid data loss. If the error persists for a longer duration, the clients must store the data and forward it later.
If a field is of type timestamp or timestamp_tz , then define the value in ISO 8601 format while ingesting data.
The value should be in the Unix epoch in seconds when loading data in the field based that's aggregated for time. You can include
additional timestamp fields to represent the time in milliseconds or timestamptz format in the record.
Numeric values mustn't have commas as defined in RFC 8259 specification. The fraction part in the numbers must include a
decimal point followed by one or more digits.
You must encode data in UTF-8 format.
Streaming
Streaming supports near real time ingestion. You can use streaming ingestion if there's a need to continuously stream data to OPTIC
Data Lake.
Aggregation
The dataset must include tenant_id field. The value in this field contains either the tenant ID or Managed Service
Provider/Enterprise name.
The dataset must have timestamp_utc_s and/or timestamp_tz which contains time in epoch (seconds) and/or timestamp format
respectively to use as the time aggregation field. You can't use the time in epoch (milliseconds) or time in epoch (nanoseconds) in
the time aggregation field.
Other standard fields (applicable to the aggregation dataset) defined in the source dataset must be present in the aggregation
dataset.
Downtime enrichment
The metrics forwarded to OPTIC Data Lake are enriched with received_in_downtime field. This field indicates that OPTIC Data Lake
received the data during the downtime of the entity.
You must include this field only in the raw datasets.
The received_in_downtime field must have boolean data type.
The data aggregation doesn't happen if the received_in_downtime is True .
Related topics
To enable the Performance Troubleshooting dashboard, see Enable PT dashboard.
For Open Data Ingestion steps, see Tutorial for streaming.
To create custom BVD reports, see BVD reports.
To configure downtime, see Configure downtime.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 428
AI Operations Management - Containerized 24.4
1.3.2.3. Prepare
The prerequisite to access the API and ingest data to OPTIC DL:
1. Ensure you have deployed OPTIC DL and the post install configurations are complete.
2. Make sure to create the required users in IdM to access the OPTIC DL Administration API, OPTIC DL HTTP Receiver API, and OPTIC
DL Data Access API. Associate them with the di_admin , di_ingestion , and di_data_access roles assigned to make the API calls. For
steps to create these users, see the Manage users topic in the OMT documentation.
3. Get the CA certificate of ingress controller and add it to the trust store of your application as the services use TLS communication.
4. Get the HTTP header name to identify the dataset while ingesting data to the Receiver.
5. Following are the endpoints of IdM service, OPTIC DL Administration, OPTIC DL HTTP Receiver, and OPTIC DL Data Access of the
deployment:
IdM service: https://<HOST>:<PORT>/idm-service/v3.0/tokens
OPTIC DL Administration: https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/<REST resource name>
OPTIC DL HTTP Receiver : https://<HOST>:<PORT>/itom-data-ingestion-receiver/data
OPTIC DL Data Access: https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/<REST resource name>
Where, <HOST> is the external access host. Run the command on the control plane or bastion node to get the <HOST> : helm get v
alues <deployment_name> -n <application namespace> | grep -i externalAccessHost
<PORT> is the port of the respective services. See Install > System requirements > Network requirement section for the
respective service port details.
6. Ensure you can access the OPTIC DL Administration, OPTIC DL HTTP Receiver, and OPTIC DL Data Access from the client system.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 429
AI Operations Management - Containerized 24.4
Make sure you have completed the steps in the Plan and Prepare section before you proceed with this topic.
{
"passwordCredentials" : {
"username" : "di_admin",
"password" : "<password>"
},
"tenantName" : "Provider"
}
Send an HTTP POST request to IdM service using the following command:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 430
AI Operations Management - Containerized 24.4
{
"token": {
"id": "eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.3ZDU3ZjgzYjVlMDEyMCIsImlzcyI6IklkTSAxLjM0LjAtYnVpbGQuMjQ5IiwiY29tLmhwZ
S5pZG06dHJ1c3RvciI6bnVsbCwiZXhwIjoxNjM4OTU5NjQ2LCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDgxOTc3ZDU3Zjgw
YTAxN2Q1N2Y4MzBlOTAwYzMiLCJuYW1lIjoiUHJvdmlkZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiYWRtaW4iLCJpYXQiOjE2Mzg5NTc4NDYsI
mp0aSI6IjU1MzQxNjc5LWUwMGItNGI4NC05MDRiLWZmNWNlYTE4YWFkOCJ9.OL7fVW2Xg2lc0gBomsUe2mHGAXz6_AmdxFSSzzKO95
w",
"issued_at": "2022-2-18T10:48:54.208Z",
"expires": "2022-2-18T10:48:54.208Z",
"tenant": {
"id": "2c9081977d57f80a0157f830e900c3",
"name": "Provider",
"enabled": true
}
},
"user": {
"username": "di_admin",
"id": "2c9081977d57f80a0157f83b5e0120",
"name": "di_admin",
"groups": [
],
"roles": [
{
"id": "2c9081977d57f80a0157f844b80136",
"description": "OPTIC DL Administration Role",
"groups": [],
"permissions": [],
"users": [],
"name": "di_admin",
"displayName": "di_admin"
}
],
"profile": {
"email": "[email protected]",
"username": "di_admin"
},
"lastAuthConfig": "2c9081977d57f80a0157f831a500e8"
},
"refreshToken": "XVVUAl7YjTEuRVPw2/1vpf+50wiefutnNx6MMoOvSCbNSI0f0xlyMRFQuURfDSlqfKTkX/vgWMKkTcAYsg3u46OQ5qLR73Fm5NKrANh
qRZhDhWy83BLWxxsOhKXLHYQlPCPMYarqZLpdWosSlzg0wgd3ssEvJHhMHkSe7UrG5ASEO9UtisBIgXH7AU7b+2/ZQxCsrTAeLUVuAxwFccFMQqlgc143
H09sadOLIN1R/umsPif/CXEQQtpKG1QxzkUh+4kDkwbxtA2CjwAGCP5mQN2r8HmoH21d3X3kYoG1Wh9Z+lFgHd3tD5+IOE+4UT9mZl/27OGs5WALQ5
Wd8DVklpDO0zMc6+WYa/ABC/JxyGjpS7Q9dNeqV6cvWxQmVejMFSJYEHs9Ug5whIhz6F7SwZMwMTx+3lNtRUm9/PJxY="
}
Note down the token id from the response. You will use this access token to access OPTIC DL API. In this sample response, the token id
is:
eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.3ZDU3ZjgzYjVlMDEyMCIsImlzcyI6IklkTSAxLjM0LjAtYnVpbGQuMjQ5IiwiY29tLmhwZS5pZG06dHJ1c3RvciI6bnVsbCw
iZXhwIjoxNjM4OTU5NjQ2LCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDgxOTc3ZDU3ZjgwYTAxN2Q1N2Y4MzBlOTAwYzMiLCJuYW1lIjoiUHJvdml
kZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiYWRtaW4iLCJpYXQiOjE2Mzg5NTc4NDYsImp0aSI6IjU1MzQxNjc5LWUwMGItNGI4NC05MDRiLWZmNWNlYTE4YWFkO
CJ9.OL7fVW2Xg2lc0gBomsUe2mHGAXz6_AmdxFSSzzKO95w
The token expires after the time given in the "expires" field in the response. You should periodically refresh the token.
{
"passwordCredentials" : {
"username" : "di_ingestion",
"password" : "<password>"
},
"tenantName" : "Provider"
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 431
AI Operations Management - Containerized 24.4
Send an HTTP POST request to IdM service using the following command:
{
"token": {
"id": "eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIy3MDQzMSIsImlzcyI6IklkTSAxLjM0LjEtYnVpbGQuMjcxIiwiY29tLmhwZS5
pZG06dHJ1c3RvciI6bnVsbCwiZXhwIjoxNjQ1MTA0NjgxLCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDg0OTc3ZWQ0Yjk2YT
AxN2VkNGI5YTI2OTAwYzMiLCJuYW1lIjoiUHJvdmlkZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiZGlpbmdlc3Rpb24iLCJpYXQiOjE2NDUxMDI4
ODEsImp0aSI6IjBiNjkwZTUxLTljN2EtNDdkYy05YWQzLTM3NmZlM2JmYjcxZSJ9.ORPrybr0yaU_2YU0xqT2M-zY2uWRc3yq3L_r2EHpTig",
"issued_at": "2022-2-18T10:48:54.208Z",
"expires": "2022-2-18T10:48:54.208Z",
"tenant": {
"id": "2c9084977ed4b96a4b9a26900c3",
"name": "Provider",
"enabled": true
}
},
"user": {
"username": "di_ingestion",
"id": "2c9084977ed4b96a05366070431",
"name": "di_ingestion",
"groups": [
],
"roles": [
{
"id": "2c9084977ed4b9615361fe0429",
"description": "OPTIC DL Ingestion Role",
"groups": [],
"permissions": [],
"users": [],
"name": "di_ingest",
"displayName": "di_ingest"
}
],
"profile": {
"email": "[email protected]",
"username": "di_ingestion"
},
"lastAuthConfig": "2c9084977ed4b9ed4b9a2e900e8"
},
"refreshToken": "qPkD2RReyyY1qhpBvqXQYCkHkso+ENJik6ITRfX3ZosImBgME2vKRX5ASwoNO5DHEn5KEaAe1XjEHYc1Rp6TbvEYgHEBqb590+bbd
4fyluo4Q9YPJx5/zulprwiA8eQ1F9W6lsCTj49OF2Qv054e+flTYM4dcfjEpuudjGZq3+7H4xQaI1RMkQEH3smcukgpO6qUlwR9exlXfdbdCFrJuNza9+OSpqq
UEA34pqb+ySKQAHHL7wLyEerE5yrkr0NIIl0/t/Pn6Fh79YFhf5tJPDoAfmmkKHCAYFD3zuCMfbjdkKk69CPfhxF8Zt0h45jc2uVHVcwfxAM06nbCMTnWo0XG
h23kXKDI9mB6TRHDePhfMtnmw9xeS5t1QL/9M/mz3xleJVkFwicUMfpIEWepQtQQ69X8A3fqd1RDJDQqrZU9ixAnoOe37+P440ANCA=="
}
Note down the token id from the response. You will use this access token to access OPTIC DL API. In this sample response, the token id
is:
eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIy3MDQzMSIsImlzcyI6IklkTSAxLjM0LjEtYnVpbGQuMjcxIiwiY29tLmhwZS5pZG06dHJ1c3RvciI6bnVsbCwiZ
XhwIjoxNjQ1MTA0NjgxLCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDg0OTc3ZWQ0Yjk2YTAxN2VkNGI5YTI2OTAwYzMiLCJuYW1lIjoiUHJvdmlkZX
IiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiZGlpbmdlc3Rpb24iLCJpYXQiOjE2NDUxMDI4ODEsImp0aSI6IjBiNjkwZTUxLTljN2EtNDdkYy05YWQzLTM3NmZlM2JmYjcxZ
SJ9.ORPrybr0yaU_2YU0xqT2M-zY2uWRc3yq3L_r2EHpTig
The token expires after the time given in the "expires" field in the response. You should periodically refresh the token.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 432
AI Operations Management - Containerized 24.4
{
"passwordCredentials" : {
"username" : "di_data_access",
"password" : "<Password>"
},
"tenantName" : "Provider"
}
Send an HTTP POST request to IdM service using the following command:
Response:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 433
AI Operations Management - Containerized 24.4
{
"token": {
"id": "eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzkwODMyMzgzNWZhZTAxMDE4MzVmYjI3NmNiMDE3MCIsImlzcyI6IklkTSAxLjM2LjAtY
nVpbGQuMjYzIiwiY29tLmhwZS5pZG06dHJ1c3RvciI6bnVsbCwiZXhwIjoxNjY0NDQ3MjUwLCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDgzMj
M4MzVmYWUwMTAxODM1ZmFlNDM1YzAwY2EiLCJuYW1lIjoiUHJvdmlkZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiZGlkYXRhYWNjZXNzIiwiaWF0IjoxNjY0ND
Q1NDUwLCJqdGkiOiJhYzViMDE1MC01MmVlLTRmMzYtYmI3MC04NzY1OWJiOGRlZjgifQ.Kod_jqUEAJtYzLKIKZEQZYKFTu5_evdm5MtX9aNgmhI",
"issued_at": "2022-09-29T09:57:30.379Z",
"expires": "2022-09-29T10:27:30.000Z",
"tenant": {
"id": "2c908323835fae0101835fae435c00ca",
"name": "Provider",
"enabled": true
}
},
"user": {
"username": "di_data_access",
"id": "2c908323835fae0101835fb276cb0170",
"name": "di_data_access",
"groups": [
{
"id": "2c908323835fae0101835fb267000160",
"name": "DiDataaccessGroup",
"displayName": "DiDataaccessGroup",
"groupInfo": "DiDataaccessGroup",
"createdDate": "2022-09-29T09:57:30.364Z",
"modifiedDate": "2022-09-29T09:57:30.364Z",
"metadata": {},
"roles": [],
"databaseRepresentationOnly": true
}
],
"roles": [
{
"id": "2c908166835fae1301835fb26d9f0006",
"description": "OPTIC DL DataAccess Role",
"groups": [],
"permissions": [],
"users": [],
"assignment": "all",
"name": "di_data_access",
"displayName": "di_data_access",
"application": "ProviderApp"
}
],
"profile": {
"email": [email protected],
"username": "di_data_access"
},
"lastAuthConfig": "2c908323835fae0101835fae43ce00f0",
"displayName": "di_data_access"
},
"refreshToken": "yvbOoJX2CNRJ3pZeajgV7iAqUOjS2E7t8I10mKzWyVrNYs7JieuQzE8OMskcEmp1kz/ALrl+AIivuq+nU7uGyzTrw8VRIpnaZ8Jl4HPp6L1
lw5VenX2LZeO/iQaWXmauURQe5lx4VIx4FuCssBWbUCUf8PnZ9sB33D6qaW30EzDpXxb5IZNMkhW62Vjk9ZQ6RGwUf96G6DaSBTWEK1YEZU5jbIJZm7
omZrCxFGXIygoQVEgMKlQmb4lxakaYqsbz7hpQSKOO8ZHAsLOpfEEe8eMKvKOOoMoc9CZlWpC2AiztGcCDATtH11yRbsWSKzrVJVP2I3ppMuez8/c6uuT
Mu7DFZ3jPNBpYZqmThY2yLi2MCm9oRh/0fAiVHmc2gmxsRVUItHsVtGse7p/lK/rzLUs6yiwcsuR87UlNOTwsMB6+afBa2F0FTEg7q5H6waxwKpd1ynustl7
FsFvwnv4+cg==",
"passwordExpiredDate": 1671533874851
}
You need to note down the token id from the response as you will use it to access OPTIC DL API. In this sample response, the token id
is:
eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzkwODMyMzgzNWZhZTAxMDE4MzVmYjI3NmNiMDE3MCIsImlzcyI6IklkTSAxLjM2LjAtYnVpbGQuMjYzIi
wiY29tLmhwZS5pZG06dHJ1c3RvciI6bnVsbCwiZXhwIjoxNjY0NDQ3MjUwLCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDgzMjM4MzVmYWUwMTA
xODM1ZmFlNDM1YzAwY2EiLCJuYW1lIjoiUHJvdmlkZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiZGlkYXRhYWNjZXNzIiwiaWF0IjoxNjY0NDQ1NDUwLCJqdGkiOiJhYz
ViMDE1MC01MmVlLTRmMzYtYmI3MC04NzY1OWJiOGRlZjgifQ.Kod_jqUEAJtYzLKIKZEQZYKFTu5_evdm5MtX9aNgmhI
The token expires after the time given in the "expires" field in the response. You should periodically refresh the token.
To stream the data, see the Open data ingestion API tutorial for streaming.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 434
AI Operations Management - Containerized 24.4
Tip
Tip: The IdM token expires after a specific time. This expiry time appears in the POST call response "expires" field when you create the
refreshToken value. Send the
token. You should periodically refresh the token. While you create the token, make sure to note down the
following POST request to https://<HOST>:<PORT>/idm-service/v3.0/tokens endpoint to refresh the token id:
{
"refresh_credentials":{ "refresh_token":"<REFRESH_TOKEN>" }
}
For example:
Tip
Tip: To revoke an IdM token after you complete the data ingestion or data access operation, run the following DELETE request to the
endpoint:
https://<HOST>:<PORT>/idm-service/v3.0/tokens/{IDM-Token}
Headers
Content-Type: application/json
Accept: application/json
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 435
AI Operations Management - Containerized 24.4
The following are examples of how to interact with the OPTIC DL REST API. These examples use cURL for the sample REST call.
However, you can use any other client application such as Postman.
{
"id": "node_demo_id",
"name": "node_demo",
"displayName": "Node Demo Set",
"description": "Sample dataset for demo",
"entityTypeCanonicalName": "node",
"fields": [
{
"id": "host_name",
"name": "host_name",
"type": "string",
"displayName": "Host Name",
"description": "Name of the Host",
"maxLength": 200,
"isKey": true,
"isPrimaryKey": false,
"isSampleTime": false,
"isNullable": false,
"entityTypeCanonicalName": "node",
"fieldCanonicalName": "hostname",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "attribute"
}
]
},
{
"id": "timestamp_utc",
"name": "timestamp_utc",
"type": "integer",
"displayName": "Timestamp",
"description": "Timestamp in Unix Epoch",
"isSampleTime": true,
"isNullable": false,
"entityTypeCanonicalName": "node",
"fieldCanonicalName": "timestamp",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "measurementType",
"value": "attribute"
}
]
},
{
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 436
AI Operations Management - Containerized 24.4
"id": "cpu_util",
"name": "cpu_util",
"type": "numeric",
"displayName": "CPU Utilization",
"description": "CPU Utilization in percentage",
"entityTypeCanonicalName": "node",
"fieldCanonicalName": "cpu_utilization",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementType",
"value": "gauge"
},
{
"name": "measurementUnit",
"value": "percentage"
}
]
}
],
"sortOrder": [
"host_name",
"timestamp_utc"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
},
"tags": [
{
"name": "retentionProfile",
"value": "raw"
}
]
}
Run the following command to send a POST request to the Administration interface:
Response:
{
"@uri": "/dataSetConfiguration/node_demo_id",
"@type": "dataSetConfiguration",
"@self": "https://itom-di-administration-svc:8443/itom-data-ingestion-administration/urest/v3/dataSetConfiguration/node_demo_id",
"created": "18-02-22 10:49:38",
"modified": "18-02-22 10:49:38",
"@eTag": "18-02-22 10:49:38",
"id": "node_demo_id",
"name": "node_demo",
"displayName": "Node Demo Set",
"description": "Sample dataset for demo",
"entityTypeCanonicalName": "node",
"sortOrder": [
"host_name",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 437
AI Operations Management - Containerized 24.4
"timestamp_utc"
],
"fields": [
{
"id": "host_name",
"name": "host_name",
"displayName": "Host Name",
"description": "Name of the Host",
"type": "string",
"maxLength": 200,
"isKey": true,
"isTenantOwner": false,
"entityTypeCanonicalName": "node",
"fieldCanonicalName": "hostname",
"isPrimaryKey": false,
"isSampleTime": false,
"isNullable": false,
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics",
"isInternal": false
},
{
"name": "fieldType",
"value": "attribute",
"isInternal": false
}
]
},
{
"id": "timestamp_utc",
"name": "timestamp_utc",
"displayName": "Timestamp",
"description": "Timestamp in Unix Epoch",
"type": "integer",
"isKey": false,
"isTenantOwner": false,
"entityTypeCanonicalName": "node",
"fieldCanonicalName": "timestamp",
"isPrimaryKey": false,
"isSampleTime": true,
"isNullable": false,
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric",
"isInternal": false
}
]
},
{
"id": "cpu_util",
"name": "cpu_util",
"displayName": "CPU Utilization",
"description": "CPU Utilization in percentage",
"type": "numeric",
"isKey": false,
"isTenantOwner": false,
"entityTypeCanonicalName": "node",
"fieldCanonicalName": "cpu_utilization",
"isPrimaryKey": false,
"isSampleTime": false,
"isNullable": true,
"tags": [
{
"name": "fieldGroup",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 438
AI Operations Management - Containerized 24.4
"value": "HostMetrics",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric",
"isInternal": false
},
{
"name": "measurementScale",
"value": "quantitative",
"isInternal": false
},
{
"name": "measurementType",
"value": "gauge",
"isInternal": false
},
{
"name": "measurementUnit",
"value": "percentage",
"isInternal": false
}
]
}
],
"isInternal": false,
"sortOrder": [
"host_name",
"timestamp_utc"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
},
"tags": [
{
"name": "retentionProfile",
"value": "raw",
"isInternal": false
}
],
"defaultLoadConfiguration": [
{
"loadMethod": "kafka-json-load",
"topicName": "node_demo"
}
]
}
Hourly Aggregation: Create a file hourly-aggregation.json for an hourly aggregation on the cpu_util metric using the min , max , and averag
e functions.
{
"id": "node_demo_hourly_rollup",
"name": "node_demo_hourly_rollup",
"sourceDataSetId": "node_demo_id",
"destinationDataSetId": "node_demo_dataset_1h",
"destinationDataSet": "node_demo_dataset_1h",
"displayName": "Node Demo Set Hourly",
"description": "Sample hourly dataset for demo",
"entityTypeCanonicalName": "node",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 439
AI Operations Management - Containerized 24.4
"aggregateRules": [
{
"aggregationFunction": "average",
"aggregationType": "GenericAggregateRuleConfiguration",
"destinationField": "avg_cpu_util",
"destinationFieldId": "avg_cpu_util",
"sourceFieldId": "cpu_util",
"displayName": "Average CPU Utilization",
"description": "Average hourly CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementUnit",
"value": "percentage"
}
]
},
{
"aggregationFunction": "min",
"aggregationType": "GenericAggregateRuleConfiguration",
"destinationField": "min_cpu_util",
"destinationFieldId": "min_cpu_util",
"sourceFieldId": "cpu_util",
"displayName": "Minimum CPU Utilization",
"description": "Minimum hourly CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementUnit",
"value": "percentage"
}
]
},
{
"aggregationFunction": "max",
"aggregationType": "GenericAggregateRuleConfiguration",
"destinationField": "max_cpu_util",
"destinationFieldId": "max_cpu_util",
"sourceFieldId": "cpu_util",
"displayName": "Maximum CPU Utilization",
"description": "Maximum hourly CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [
{
"name": "fieldGroup",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 440
AI Operations Management - Containerized 24.4
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementUnit",
"value": "percentage"
}
]
}
],
"groupByFields": [
"host_name",
"timestamp_utc"
],
"groupByInterval": 60,
"startTimeLag": 0,
"endTimeLag": 0,
"tags": [
{
"name": "retentionProfile",
"value": "hourly"
}
],
"defaultTaskFlow": true,
"sortOrder": [
"host_name",
"timestamp_utc"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
}
}
Run the following command to send a POST request to the Administration interface:
Response:
{
"@uri": "/aggregateConfiguration/node_demo_hourly_rollup",
"@type": "aggregate",
"@self": "https://itom-di-administration-svc:8443/itom-data-ingestion-administration/urest/v3/aggregateConfiguration/node_demo_hourly_rollup",
"created": "2022-02-18T11:26:23.286+0000",
"modified": "2022-02-18T11:26:23.286+0000",
"@eTag": "2022-02-18T11:26:23.286+0000",
"id": "node_demo_hourly_rollup",
"name": "node_demo_hourly_rollup",
"sourceDataSetId": "node_demo_id",
"destinationDataSet": "node_demo_1h",
"destinationDataSetId": "node_demo_1h",
"displayName": "Node Demo Set Hourly",
"description": "Sample hourly dataset for demo",
"entityTypeCanonicalName": "node",
"aggregateRules": [{
"aggregationType": "GenericAggregateRuleConfiguration",
"sourceFieldId": "cpu_util",
"destinationFieldId": "avg_cpu_util",
"destinationField": "avg_cpu_util",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 441
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 442
AI Operations Management - Containerized 24.4
},
{
"name": "fieldType",
"value": "metric",
"isInternal": false
},
{
"name": "measurementScale",
"value": "quantitative",
"isInternal": false
},
{
"name": "measurementUnit",
"value": "percentage",
"isInternal": false
}
],
"aggregationFunction": "max"
}
],
"groupByFields": [
"host_name",
"timestamp_utc"
],
"groupByInterval": 60,
"startTimeLag": 0,
"endTimeLag": 0,
"tags": [{
"name": "retentionProfile",
"value": "hourly",
"isInternal": false
}],
"defaultTaskFlow": false,
"sortOrder": [
"host_name",
"timestamp_utc"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
}
Daily Aggregation: Create daily-aggregation.json file for daily aggregation on the cpu_util metric using min , max , average rollup function.
{
"id": "node_demo_daily_rollup",
"name": "node_demo_daily_rollup",
"sourceDataSetId": "node_demo_id",
"destinationDataSetId": "node_demo_dataset_1d",
"destinationDataSet": "node_demo_dataset_1d",
"displayName": "Node Demo Set Daily",
"description": "Sample daily dataset for demo",
"entityTypeCanonicalName": "node",
"aggregateRules": [
{
"aggregationFunction": "average",
"aggregationType": "GenericAggregateRuleConfiguration",
"destinationField": "avg_cpu_util",
"destinationFieldId": "avg_cpu_util",
"sourceFieldId": "cpu_util",
"displayName": "Average CPU Utilization",
"description": "Average daily CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [
{
"name": "fieldGroup",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 443
AI Operations Management - Containerized 24.4
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementUnit",
"value": "percentage"
}
]
},
{
"aggregationFunction": "min",
"aggregationType": "GenericAggregateRuleConfiguration",
"destinationField": "min_cpu_util",
"destinationFieldId": "min_cpu_util",
"sourceFieldId": "cpu_util",
"displayName": "Minimum CPU Utilization",
"description": "Minimum daily CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementUnit",
"value": "percentage"
}
]
},
{
"aggregationFunction": "max",
"aggregationType": "GenericAggregateRuleConfiguration",
"destinationField": "max_cpu_util",
"destinationFieldId": "max_cpu_util",
"sourceFieldId": "cpu_util",
"displayName": "Maximum CPU Utilization",
"description": "Maximum daily CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [
{
"name": "fieldGroup",
"value": "HostMetrics"
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementScale",
"value": "quantitative"
},
{
"name": "measurementUnit",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 444
AI Operations Management - Containerized 24.4
"value": "percentage"
}
]
}
],
"groupByFields": [
"host_name",
"timestamp_utc"
],
"groupByInterval": 1440,
"startTimeLag": 0,
"endTimeLag": 0,
"tags": [
{
"name": "retentionProfile",
"value": "daily"
}
],
"defaultTaskFlow": true,
"sortOrder": [
"host_name",
"timestamp_utc"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
}
}
Run the following command to send a POST request to the Administration interface:
Response:
{
"@uri": "/aggregateConfiguration/node_demo_daily_rollup",
"@type": "aggregate",
"@self": "https://systemname.swinfra.net:port/itom-data-ingestion-administration/urest/v3/aggregateConfiguration/node_demo_daily_rollup",
"createTime": "2022-09-26T05:48:05.184+0000",
"updateTime": "2022-09-26T05:48:05.184+0000",
"@eTag": "2022-09-26T05:48:05.184+0000",
"id": "node_demo_daily_rollup",
"name": "node_demo_daily_rollup",
"sourceDataSetId": "node_demo_id",
"destinationDataSet": "node_demo_dataset_1d",
"destinationDataSetId": "node_demo_dataset_1d",
"displayName": "Node Demo Set Daily",
"description": "Sample daily dataset for demo",
"entityTypeCanonicalName": "node",
"aggregateRules": [{
"aggregationType": "GenericAggregateRuleConfiguration",
"sourceFieldId": "cpu_util",
"destinationFieldId": "avg_cpu_util",
"destinationField": "avg_cpu_util",
"displayName": "Average CPU Utilization",
"description": "Average daily CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [{
"name": "fieldGroup",
"value": "HostMetrics",
"isInternal": false
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 445
AI Operations Management - Containerized 24.4
},
{
"name": "fieldType",
"value": "metric",
"isInternal": false
},
{
"name": "measurementScale",
"value": "quantitative",
"isInternal": false
},
{
"name": "measurementUnit",
"value": "percentage",
"isInternal": false
}
],
"aggregationFunction": "avg"
},
{
"aggregationType": "GenericAggregateRuleConfiguration",
"sourceFieldId": "cpu_util",
"destinationFieldId": "min_cpu_util",
"destinationField": "min_cpu_util",
"displayName": "Minimum CPU Utilization",
"description": "Minimum daily CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [{
"name": "fieldGroup",
"value": "HostMetrics",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric",
"isInternal": false
},
{
"name": "measurementScale",
"value": "quantitative",
"isInternal": false
},
{
"name": "measurementUnit",
"value": "percentage",
"isInternal": false
}
],
"aggregationFunction": "min"
},
{
"aggregationType": "GenericAggregateRuleConfiguration",
"sourceFieldId": "cpu_util",
"destinationFieldId": "max_cpu_util",
"destinationField": "max_cpu_util",
"displayName": "Maximum CPU Utilization",
"description": "Maximum daily CPU utilization",
"entityTypeCanonicalName": "Node",
"destinationFieldCanonicalName": "CPUUtilization",
"tags": [{
"name": "fieldGroup",
"value": "HostMetrics",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric",
"isInternal": false
},
{
"name": "measurementScale",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 446
AI Operations Management - Containerized 24.4
"value": "quantitative",
"isInternal": false
},
{
"name": "measurementUnit",
"value": "percentage",
"isInternal": false
}
],
"aggregationFunction": "max"
}
],
"groupByFields": [
"host_name",
"timestamp_utc"
],
"groupByInterval": 1440,
"startTimeLag": 0,
"endTimeLag": 0,
"tags": [{
"name": "retentionProfile",
"value": "daily",
"isInternal": false
}],
"defaultTaskFlow": true,
"sortOrder": [
"host_name",
"timestamp_utc"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
}
}
For example, create a forecast.json file for a 30 days forecast of the cpu_util metric.
{
"id": "node_demo_forecast_id",
"name": "node_demo_forecast",
"algorithm": "linear",
"sourceDataSetId": "node_demo_id",
"destinationDataSetId": "node_demo_forecast_id",
"destinationDataSet": "node_demo_forecast",
"entityTypeCanonicalName": "node",
"displayName": "Node demo Forecast",
"description": "Node demo Forecast",
"analysisPeriod": 30,
"keyFields": [
"host_name"
],
"forecastDefinition": [{
"sourceFieldId": "cpu_util",
"forecastFieldId": "cpu_util_fp_30_id",
"forecastField": "cpu_util_fp_30",
"forecastFieldDisplayName": "ForecastRuleFP CPU Utilization %",
"forecastFieldDescription": "The forecast of the cpu utilization during the interval",
"entityTypeCanonicalName": "node",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 30,
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 447
AI Operations Management - Containerized 24.4
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
}]
},
{
"sourceFieldId": "cpu_util",
"forecastFieldId": "cpu_util_dtt_95_id",
"forecastField": "cpu_util_dtt_95",
"forecastFieldDisplayName": "ForecastRuleDTT CPU Utilization %",
"forecastFieldDescription": "The forecast days to threshold of the cpu utilization during the interval",
"entityTypeCanonicalName": "node",
"forecastRule": {
"forecastRuleType": "ForecastRuleDTT",
"forecastThresholdValue" : 95.0,
"minValueCondition" : {
"minValue" : 0,
"forecastValue" : 0
},
"maxValueCondition" : {
"maxValue" : 90,
"forecastValue" : 90
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
}]
}
],
"tags": [{
"name": "retentionProfile",
"value": "forecast",
"isInternal": false
}],
"schedule": {
"type": "fixedDelay",
"value": "5"
},
"defaultTaskFlow": true,
"sortOrder": [
"host_name"
],
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
}
}
Run the following command to send a POST request to the Administration interface:
Response:
{
"@uri": "/timeSeriesForecastConfiguration/node_demo_forecast_id",
"@type": "forecast",
"@self": https://systemname.swinfra.net:port/itom-data-ingestion-administration/urest/v3/timeSeriesForecastConfiguration/node_demo_forecast_
id,
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 448
AI Operations Management - Containerized 24.4
"createTime": "2022-11-17T12:41:50.513+0000",
"updateTime": "2022-11-17T12:41:50.513+0000",
"@eTag": "2022-11-17T12:41:50.513+0000",
"name": "node_demo_forecast",
"id": "node_demo_forecast_id",
"algorithm": "linear",
"sourceDataSetId": "node_demo_id",
"destinationDataSetId": "node_demo_forecast_id",
"destinationDataSet": "node_demo_forecast",
"displayName": "Node demo Forecast",
"description": "Node demo Forecast",
"entityTypeCanonicalName": "node",
"analysisPeriod": 30,
"keyFields": [
"host_name"
],
"forecastDefinition": [
{
"sourceFieldId": "cpu_util",
"forecastFieldId": "cpu_util_fp_30_id",
"forecastField": "cpu_util_fp_30",
"forecastFieldDisplayName": "ForecastRuleFP CPU Utilization %",
"forecastFieldDescription": "The forecast of the cpu utilization during the interval",
"entityTypeCanonicalName": "node",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 30,
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [
{
"name": "Unit",
"value": "Percentage",
"isInternal": false
}
]
},
{
"sourceFieldId": "cpu_util",
"forecastFieldId": "cpu_util_dtt_95_id",
"forecastField": "cpu_util_dtt_95",
"forecastFieldDisplayName": "ForecastRuleDTT CPU Utilization %",
"forecastFieldDescription": "The forecast days to threshold of the cpu utilization during the interval",
"entityTypeCanonicalName": "node",
"forecastRule": {
"forecastRuleType": "ForecastRuleDTT",
"forecastThresholdValue": 95.0,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 90,
"forecastValue": 90
}
},
"tags": [
{
"name": "Unit",
"value": "Percentage",
"isInternal": false
}
]
}
],
"schedule": {
"type": "fixedDelay",
"value": "5"
},
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 449
AI Operations Management - Containerized 24.4
"tags": [
{
"name": "retentionProfile",
"value": "forecast",
"isInternal": false
}
],
"defaultTaskFlow": true,
"shardDefinition": {
"shardType": "distribute",
"shardKeys": [
"host_name"
]
},
"sortOrder": [
"host_name"
]
}
[{"timestamp_utc":1536747489,"host_name":"myhost.microfocus.com","cpu_util":79.5},
{"timestamp_utc":1536747789,"host_name":"myhost.microfocus.com","cpu_util":80.5}]
Run the following command to send a POST request to the streaming interface:
Response:
{
"items": [
{
"@self": "https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata/45035996275046320",
"@uri": "/dataSetMetadata/45035996275046320",
"@type": "metadata",
"createTime": "2022-09-29T10:02:15.189+0000",
"updateTime": "2022-09-29T10:02:15.189+0000",
"@eTag": "2022-09-29 10:02:12.000861",
"id": "45035996275046320",
"name": "node_demo_dataset_1d",
"schema": "mf_shared_provider_default",
"displayName": "Node Demo Set Daily",
"description": "Sample daily dataset for demo",
"tags": [
{
"name": "retentionprofile",
"value": "daily"
}
]
},
{
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 450
AI Operations Management - Containerized 24.4
"@self": "https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata/45035996274456426",
"@uri": "/dataSetMetadata/45035996274456426",
"@type": "metadata",
"createTime": "2022-09-26T11:22:29.717+0000",
"updateTime": "2022-09-26T11:22:29.717+0000",
"@eTag": "2022-09-26 11:22:28.000360",
"id": "45035996274456426",
"name": "node_demo_dataset_1h",
"schema": "mf_shared_provider_default",
"displayName": "Node Demo Set Hourly",
"description": "Sample hourly dataset for demo",
"tags": [
{
"name": "retentionprofile",
"value": "hourly"
}
]
},
{
"@self": "https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata/45035996275049982",
"@uri": "/dataSetMetadata/45035996275049982",
"@type": "metadata",
"createTime": "2022-09-29T10:18:57.984+0000",
"updateTime": "2022-09-29T10:18:57.984+0000",
"@eTag": "2022-09-29 10:18:56.000439",
"id": "45035996275049982",
"name": "node_demo_forecast",
"schema": "mf_shared_provider_default",
"displayName": "node demo forecast",
"description": "node demo forecast",
"tags": [
{
"name": "node_demo_forecast",
"value": "node_demo_forecast"
}
]
},
{
"@self": "https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata/45035996275045102",
"@uri": "/dataSetMetadata/45035996275045102",
"@type": "metadata",
"createTime": "2022-09-29T10:00:06.486+0000",
"updateTime": "2022-09-29T10:00:06.486+0000",
"@eTag": "2022-09-29 10:00:03.000874",
"id": "45035996275045102",
"name": "node_demo",
"schema": "mf_shared_provider_default",
"displayName": "Node Demo Set",
"description": "Sample dataset for demo",
"tags": [
{
"name": "retentionprofile",
"value": "raw"
}
]
}
Execute the Data Access API call via the following curl call to fetch the details of the dataset:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 451
AI Operations Management - Containerized 24.4
Response:
[
{
"timestamp_utc" : 1536747489,
"host_name" : "myhost.microfocus.com",
"cpu_util" : 79.500000000000000
}
,
{
"timestamp_utc" : 1536747789,
"host_name" : "myhost.microfocus.com",
"cpu_util" : 80.500000000000000
}
]
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 452
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 453
AI Operations Management - Containerized 24.4
"value":"custom_node"
},
{
"name":"instanceTitle",
"value":"custom_node"
}
]
},
{
"id" : "node_ip_type_id",
"name" : "node_ip_type",
"displayName" : "Monitored Node IP Type",
"description" : "IP Type of the monitored node (IPV4 or IPV6).",
"type" : "string",
"maxLength": 80,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}
]
},
{
"id" : "node_ipv4_address_id",
"name" : "node_ipv4_address",
"displayName" : "Monitored Node IPV4 Address",
"description" : "IPV4 address of the server being monitored if using IPV4.",
"type" : "string",
"maxLength": 50,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}
]
},
{
"id" : "node_ipv6_address_id",
"name" : "node_ipv6_address",
"displayName" : "Monitored Node IPV6 Address",
"description" : "The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format without any simplification rules.",
"type" : "string",
"maxLength": 50,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}
]
},
{
"id" : "node_short_name_id",
"name" : "node_short_name",
"displayName" : "Monitored Node Short Name",
"description" : "Short name of the server being monitored. Name must not contain any '.' (Period) character.",
"type" : "string",
"maxLength": 255,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 454
AI Operations Management - Containerized 24.4
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}]
},
{
"id" : "node_timezone_offset_h_id",
"name" : "node_timezone_offset_h",
"displayName" : "Monitored Node Timezone Offset",
"description" : "Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8",
"type" : "string",
"maxLength": 80,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}
]
},
{
"id" : "producer_instance_id_id",
"name" : "producer_instance_id",
"displayName" : "Producer Instance ID",
"description" : "ID that uniquely defines the data producer instance within a given producer instance type. Examples: \"SiteScope:<DNS nam
e of SiteScope server>\", \"OBM:<external virtual IP used to address this specific OBM server>\", \"OA:<ovcoreid of agent system>\".",
"type" : "string",
"maxLength": 80,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}]
},
{
"id" : "producer_instance_type_id",
"name" : "producer_instance_type",
"displayName" : "Producer Instance Type",
"description" : "Type of data producer that ingested this data. For example: 'SiteScope', 'Operations Agent', 'OBM Server', 'OpsBridge Collect
ion Service'.",
"type" : "string",
"maxLength": 80,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}]
},
{
"id" : "tenant_id_id",
"name" : "tenant_id",
"displayName" : "Tenant ID",
"description" : "ID of the tenant.",
"type" : "string",
"maxLength": 80,
"isKey" : false,
"isSampleTime" : false,
"isNullable" : true,
"isTenantOwner" : true,
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 455
AI Operations Management - Containerized 24.4
"isPrimaryKey" : false,
"tags": [
{
"name": "fieldType",
"value": "attribute"
}]
},
{
"id":"timestamp_utc_s_id",
"name":"timestamp_utc_s",
"type":"integer",
"displayName":"Timestamp",
"description":"Timestamp in Unix Epoch",
"isSampleTime":true,
"isNullable":false,
"fieldCanonicalName":"timestamp",
"tags":[
{
"name":"fieldType",
"value":"attribute"
}
]
}
],
"sortOrder":["tenant_id_id","node_fqdn_id","timestamp_utc_s_id"],
"shardDefinition":{
"shardType":"distribute",
"shardKeys":["tenant_id_id","node_fqdn_id"]
},
"tags":[
{
"name":"retentionProfile",
"value":"opsb_ext_metrics_raw"
},
{
"name":"fieldGroup",
"value":"opsb_ext_node"
},
{
"name":"data_grain",
"value":"raw"
}
]
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 456
AI Operations Management - Containerized 24.4
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"aggregationFunction":"min",
"aggregationType":"GenericAggregateRuleConfiguration",
"destinationField":"cpu_util_pct_min",
"destinationFieldId":"cpu_util_pct_min_id",
"sourceFieldId":"cpu_util_pct_id",
"displayName":"Minimum CPU Utilization",
"description":"Minimum hourly CPU utilization",
"destinationFieldCanonicalName":"CPUUtilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"aggregationFunction":"max",
"aggregationType":"GenericAggregateRuleConfiguration",
"destinationField":"cpu_util_pct_max",
"destinationFieldId":"cpu_util_pct_max_id",
"sourceFieldId":"cpu_util_pct_id",
"displayName":"Maximum CPU Utilization",
"description":"Maximum hourly CPU utilization",
"destinationFieldCanonicalName":"CPUUtilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"aggregationFunction":"average",
"aggregationType":"GenericAggregateRuleConfiguration",
"destinationField":"disk_util_pct_avg",
"destinationFieldId":"disk_util_pct_avg_id",
"sourceFieldId":"disk_util_pct_id",
"displayName":"Average Disk Utilization",
"description":"Average hourly Disk utilization",
"destinationFieldCanonicalName":"DiskUtilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"aggregationFunction":"min",
"aggregationType":"GenericAggregateRuleConfiguration",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 457
AI Operations Management - Containerized 24.4
"destinationField":"disk_util_pct_min",
"destinationFieldId":"disk_util_pct_min_id",
"sourceFieldId":"disk_util_pct_id",
"displayName":"Minimum Disk Utilization",
"description":"Minimum hourly Disk utilization",
"destinationFieldCanonicalName":"DiskUtilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"aggregationFunction":"max",
"aggregationType":"GenericAggregateRuleConfiguration",
"destinationField":"disk_util_pct_max",
"destinationFieldId":"disk_util_pct_max_id",
"sourceFieldId":"disk_util_pct_id",
"displayName":"Maximum Disk Utilization",
"description":"Maximum hourly Disk utilization",
"destinationFieldCanonicalName":"DiskUtilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "node_ip_type_id",
"destinationFieldId" : "node_ip_type_id",
"destinationField" : "node_ip_type",
"displayName" : "Monitored Node IP Type",
"description" : "IP Type of the monitored node (IPV4 or IPV6).",
"aggregationFunction" : "lastval",
"tags": [{
"name": "fieldType",
"value": "attribute"
},
{
"name": "node_ip_type",
"value": "node_ip_type"
}
]
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "node_ipv4_address_id",
"destinationFieldId" : "node_ipv4_address_id",
"destinationField" : "node_ipv4_address",
"displayName" : "Monitored Node IPV4 Address",
"description" : "IPV4 address of the server being monitored if using IPV4.",
"tags": [
{
"name": "node_ipv4_address",
"value": "node_ipv4_address"
},
{
"name": "fieldType",
"value": "attribute"
}
],
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 458
AI Operations Management - Containerized 24.4
"aggregationFunction" : "lastval"
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "node_ipv6_address_id",
"destinationFieldId" : "node_ipv6_address_id",
"destinationField" : "node_ipv6_address",
"displayName" : "Monitored Node IPV6 Address",
"description" : "The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format without any simplification rules.",
"tags": [
{
"name": "node_ipv6_address",
"value": "node_ipv6_address"
},
{
"name": "fieldType",
"value": "attribute"
}
],
"aggregationFunction" : "lastval"
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "node_short_name_id",
"destinationFieldId" : "node_short_name_id",
"destinationField" : "node_short_name",
"displayName" : "Monitored Node Short Name",
"description" : "Short name of the server being monitored. Name must not contain any '.' (Period) character.",
"tags": [
{
"name": "node_short_name",
"value": "node_short_name"
},
{
"name": "fieldType",
"value": "attribute"
}],
"aggregationFunction" : "lastval"
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "node_timezone_offset_h_id",
"destinationFieldId" : "node_timezone_offset_h_id",
"destinationField" : "node_timezone_offset_h",
"displayName" : "Monitored Node Timezone Offset",
"description" : "Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8",
"tags": [
{
"name": "node_timezone_offset_h",
"value": "node_timezone_offset_h"
},
{
"name": "fieldType",
"value": "attribute"
}
],
"aggregationFunction" : "lastval"
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "producer_instance_id_id",
"destinationFieldId" : "producer_instance_id_id",
"destinationField" : "producer_instance_id",
"displayName" : "Producer Instance ID",
"description" : "ID that uniquely defines the data producer instance within a given producer instance type. Examples: \"SiteScope:<DNS nam
e of SiteScope server>\", \"OBM:<external virtual IP used to address this specific OBM server>\", \"OA:<ovcoreid of agent system>\".",
"tags": [{
"name": "fieldType",
"value": "attribute"
},
{
"name": "producer_instance_id",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 459
AI Operations Management - Containerized 24.4
"value": "producer_instance_id"
}],
"aggregationFunction" : "lastval"
},
{
"aggregationType" : "GenericAggregateRuleConfiguration",
"sourceFieldId" : "producer_instance_type_id",
"destinationFieldId" : "producer_instance_type_id",
"destinationField" : "producer_instance_type",
"displayName" : "Producer Instance Type",
"description" : "Type of data producer that ingested this data. For example: 'SiteScope', 'Operations Agent', 'OBM Server', 'OpsBridge Collect
ion Service'.",
"tags": [{
"name": "fieldType",
"value": "attribute"
},
{
"name": "producer_instance_type",
"value": "producer_instance_type"
}],
"aggregationFunction" : "lastval"
}
],
"groupByFields":[ "tenant_id_id","node_fqdn_id","timestamp_utc_s_id"],
"orderBy": ["tenant_id_id","node_fqdn_id","timestamp_utc_s_id"],
"partitionByExpression":"FLOOR((timestamp_utc_s / (60 * 60 * 24 * 365)))",
"groupByInterval":60,
"startTimeLag":0,
"tags":[
{
"name" : "retentionProfile",
"value" : "opsb_ext_metrics_hourly",
"isInternal" : false
},
{
"name":"fieldGroup",
"value":"opsb_ext_node"
},
{
"name":"data_grain",
"value":"hourly"
}
],
"defaultTaskFlow":true,
"sortOrder":["tenant_id_id","node_fqdn_id","timestamp_utc_s_id"],
"shardDefinition":{
"shardType":"distribute",
"shardKeys":["tenant_id_id","node_fqdn_id"]
}
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 460
AI Operations Management - Containerized 24.4
"forecastFieldDescription" : "The forecast of the average percentage of time the CPU was not idle during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 30,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Percentage"
}]
},
{
"sourceFieldId" : "cpu_util_pct_avg_id",
"forecastFieldId" : "cpu_util_pct_fp_60_id",
"forecastField" : "cpu_util_pct_fp_60",
"forecastFieldDisplayName" : "ForecastRuleFP CPU Utilization %",
"forecastFieldDescription" : "The forecast of the average percentage of time the CPU was not idle during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 60,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Percentage"
}]
},
{
"sourceFieldId" : "cpu_util_pct_avg_id",
"forecastFieldId" : "cpu_util_pct_fp_90_id",
"forecastField" : "cpu_util_pct_fp_90",
"forecastFieldDisplayName" : "ForecastRuleFP CPU Utilization %",
"forecastFieldDescription" : "The forecast of the average percentage of time the CPU was not idle during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 90,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 461
AI Operations Management - Containerized 24.4
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Percentage"
}]
},
{
"sourceFieldId" : "cpu_util_pct_avg_id",
"forecastFieldId" : "cpu_util_pct_dtt_90_id",
"forecastField" : "cpu_util_pct_dtt_90",
"forecastFieldDisplayName" : "ForecastRuleDTT CPU Utilization %",
"forecastFieldDescription" : "The forecast days to threshold of the average percentage of time the CPU was not idle during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleDTT",
"forecastThresholdValue": 90,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 90,
"forecastValue": 90
}
},
"tags": [{
"name": "Unit",
"value": "Days",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Days"
}]
},
{
"sourceFieldId" : "cpu_util_pct_avg_id",
"forecastFieldId" : "cpu_util_pct_dtt_95_id",
"forecastField" : "cpu_util_pct_dtt_95",
"forecastFieldDisplayName" : "ForecastRuleDTT CPU Utilization %",
"forecastFieldDescription" : "The forecast days to threshold of the average percentage of time the CPU was not idle during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleDTT",
"forecastThresholdValue": 95,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 90,
"forecastValue": 90
}
},
"tags": [{
"name": "Unit",
"value": "Days",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 462
AI Operations Management - Containerized 24.4
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Days"
}]
},
{
"sourceFieldId" : "disk_util_pct_avg_id",
"forecastFieldId" : "disk_util_pct_fp_30_id",
"forecastField" : "disk_util_pct_fp_30",
"forecastFieldDisplayName" : "ForecastRuleFP Disk Utilization %",
"forecastFieldDescription" : "The forecast of the average percentage of physical Disk in use during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 30,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Percentage"
}]
},
{
"sourceFieldId" : "disk_util_pct_avg_id",
"forecastFieldId" : "disk_util_pct_fp_60_id",
"forecastField" : "disk_util_pct_fp_60",
"forecastFieldDisplayName" : "ForecastRuleFP Disk Utilization %",
"forecastFieldDescription" : "The forecast of the average percentage of physical disk in use during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 60,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 463
AI Operations Management - Containerized 24.4
"value": "Percentage"
}]
},
{
"sourceFieldId" : "disk_util_pct_avg_id",
"forecastFieldId" : "disk_util_pct_fp_90_id",
"forecastField" : "disk_util_pct_fp_90",
"forecastFieldDisplayName" : "ForecastRuleFP Disk Utilization %",
"forecastFieldDescription" : "The forecast of the average percentage of physical disk in use during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleFP",
"forecastPoint": 90,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 100,
"forecastValue": 100
}
},
"tags": [{
"name": "Unit",
"value": "Percentage",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Percentage"
}]
},
{
"sourceFieldId" : "disk_util_pct_avg_id",
"forecastFieldId" : "disk_util_pct_dtt_90_id",
"forecastField" : "disk_util_pct_dtt_90",
"forecastFieldDisplayName" : "ForecastRuleDTT Disk Utilization %",
"forecastFieldDescription" : "The forecast days to threshold of the average percentage of physical disk in use during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleDTT",
"forecastThresholdValue": 90,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 90,
"forecastValue": 90
}
},
"tags": [{
"name": "Unit",
"value": "Days",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Days"
}]
},
{
"sourceFieldId" : "disk_util_pct_avg_id",
"forecastFieldId" : "disk_util_pct_dtt_95_id",
"forecastField" : "disk_util_pct_dtt_95",
"forecastFieldDisplayName" : "ForecastRuleDTT Disk Utilization %",
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 464
AI Operations Management - Containerized 24.4
"forecastFieldDescription" : "The forecast days to threshold of the average percentage of physical disk in use during the interval.",
"forecastRule": {
"forecastRuleType": "ForecastRuleDTT",
"forecastThresholdValue": 95,
"minValueCondition": {
"minValue": 0,
"forecastValue": 0
},
"maxValueCondition": {
"maxValue": 90,
"forecastValue": 90
}
},
"tags": [{
"name": "Unit",
"value": "Days",
"isInternal": false
},
{
"name": "fieldType",
"value": "metric"
},
{
"name": "measurementUnit",
"value": "Days"
}]
}
],
"keyFields": [
"tenant_id_id","node_fqdn_id"
],
"schedule": {
"type": "fixedDelay",
"value": "1440"
},
"sortOrder":["tenant_id_id","node_fqdn_id","timestamp_utc_s_id"],
"shardDefinition":{
"shardType":"distribute",
"shardKeys":["tenant_id_id","node_fqdn_id"]
},
"partitionByExpression":"FLOOR((timestamp_utc_s / (60 * 60 * 24 * 365)))",
"tags": [{
"name" : "retentionProfile",
"value" : "opsb_ext_metrics_forecast",
"isInternal" : false
}],
"defaultTaskFlow" : false
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 465
AI Operations Management - Containerized 24.4
[
{
"timestamp_utc_s":1648039200,
"node_fqdn":"myhost1.microfocus.com",
"node_ip_type": "IPV4",
"node_ipv4_address": "12.2.3.4",
"node_timezone_offset_h": "+5.5",
"cpu_util_pct":16.5,
"disk_util_pct": 28.9876
},
{
"timestamp_utc_s":1648039200,
"node_fqdn":"myhost2.microfocus.com",
"node_ip_type": "IPV4",
"node_ipv4_address": "12.2.4.5",
"node_timezone_offset_h": "+5.5",
"cpu_util_pct":28.5,
"disk_util_pct": 56.9876
}
]
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 466
AI Operations Management - Containerized 24.4
To ingest the data into OPTIC Data Lake, you must deploy the metadata JSON files. You can choose any one of the following methods to
deploy the artifacts:
Use APIs
OPTIC DL gives you a set of RESTful APIs. Using these APIs, you can configure OPTIC DL, and ingest the data into OPTIC DL from
different data sources using the HTTPS streaming interface. For more information, see Use APIs.
1. Create a content folder with the name and version. Following is the naming convention:
<name_of_the_content>_<2 digit version year>.<1 digit yearly quater>.<3 digit build number>
For example: OpsB_Apache_Content_23.2.001, or OpsB_Apache_Content_23.4.001
2. Create the folders as follows within the folder according to the metadata that you have created in Step 1. Note that you must
create these folders according to the custom content and you may skip folders or file creation if they aren't applicable to your
content:
Folder structure Description
opr > integration> bvd > dashboard Files for the bvd reports. You must save these files with .bvd extension.
opr > integration> collection > oa YAML file for the Agent metric collection data.
JSON files for the dataset flow control. You can set the backlog quota for topics on these
opr > integration> coso > dataset-flowcontrol
files.
opr > integration> coso > enrichment > daily JSON files for data enrichment for daily .
opr > integration> coso > enrichment > hourly JSON files for data enrichment for hourly .
opr > integration> coso > metadata JSON files to create the tables.
opr > integration> coso > retention JSON files for data retention.
opr > integration> coso > roll-up > perl JSON files for Perl script for custom aggregation.
opr > integration> coso > roll-up > task JSON files for custom aggregation tasks.
opr > integration> coso > roll-up > task-flow JSON files for custom aggregation taskflows.
opr > integration> uif JSON files for the flex reports.
Tip
The JSON files are the files that you created referring to the sectionOpen data ingestion API tutorial for
streaming.
For more information on the tool commands, see Administer OPTIC Reporting.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 467
AI Operations Management - Containerized 24.4
1. OPTIC DL Administration REST Interface - helps you to configure the datasets and data processing rules like aggregate in OPTIC
DL.
2. OPTIC DL HTTP Receiver Interface - helps you to ingest the data from third-party tools into OPTIC DL using the HTTP interface. The
messages sent to the OPTIC DL HTTP Receiver interface must be in JSON format.
3. The OPTIC DL Data Access Rest API - helps you to view the data stored in OPTIC Data Lake on your custom portals.
postload-config API to configure the task flow to define the sequence for task execution.
DataSetMetadata Get metadata of the dataset (tables) in the OPTIC Data Lake datastore which can either be for all dataset or for a particular
API dataset based on the dataSetId .
DataSetAPI Get data (records) from the dataset in the OPTIC Data Lake datastore based on the provided dataSetId .
You can access the APIs from the suite container or from the external system. To invoke the API from an external system, you require
an IdM token.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 468
AI Operations Management - Containerized 24.4
postload-config API to configure the task flow to define the sequence of aggregate and forecast task execution.
For more information on each of the APIs, you can see the swagger documentation documented using OpenAPI specification here.
The following configuration APIs return 202 status codes during the create and modify calls. This indicates that the system validates
and accepts the configuration. All required changes are done in the system asynchronously so that the actual configuration matches
the expected configuration.
dataset-config
You must create the datasets before streaming data to OPTIC DL. Dataset configuration defines the dataset name and fields in the
dataset. You can create, update, view, and delete the dataset configuration using this API.
URI
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/dataSetConfiguration
Method
POST - Create dataset configuration.
PUT - Update dataset configuration. Allows you to add additional fields or remove fields in the already defined dataset.
GET - To view the dataset configuration.
DELETE - To delete the dataset configuration.
aggregate-config
API to configure data roll up. Aggregate configuration API allows you to aggregate the already aggregated data to reduce used storage
space and to improve the performance of queries using aggregated data. You can create, update, view, and delete the data
aggregation and forecast configurations.
URI
For aggregate configuration:
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/aggregateConfiguration
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/timeSeriesForecastConfiguration
Method
POST - Create data aggregation and forecast configuration.
PUT - Update data aggregation and forecast configuration.
GET - To view the data aggregation and forecast configuration
DELETE - To delete the data aggregation and forecast configuration
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 469
AI Operations Management - Containerized 24.4
postload-config
API to define the execution order for aggregation and forecast tasks. You can create, update, view, and delete the post load
configuration.
URI
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/taskFlowConfiguration
Method
POST - Create a post load configuration.
PUT - Update post load configuration.
GET - To view the post load configuration
DELETE - To delete the post load configuration
retention-config
API to configure retention period for datasets. This configuration helps clean the data in the datastore. You can create, update, view,
and delete the data retention configuration.
If you want to set a retention period for a group of datasets follow these steps:
1. Associate retentionProfile tag for the datasets with value set to a specific retention profile name through dataset configuration
API. If retention profile tag isn't associated with a dataset, then such dataset gets associated with the ' dataset ' retention profile.
The retention period defined for ' dataset ' retention profile will get applied to such datasets.
2. The dataset must include a field for which isSampleTime property as true . The timestamp must be in UNIX epoch format.
3. Set retention period for the configured retention profile using retention configuration API.
URI
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/dataRetentionConfiguration
Method
POST - Create data retention configuration.
PUT - Update data retention configuration.
GET - To view the data retention configuration.
DELETE - To delete the data retention configuration.
dataset-status
API to view the status of dataset configuration. This API allows viewing the actual dataset configuration in the system and the difference
between actual and expected dataset configuration.
URI
To view the status of a specific dataset:
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3//dataSetConfiguration/{id}/status
https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/dataSetConfiguration/status
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 470
AI Operations Management - Containerized 24.4
Method
GET - To view the dataset(s) status.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 471
AI Operations Management - Containerized 24.4
URI
https://<HOST>:<PORT>/itom-data-ingestion-receiver/data
Header parameters
HTTP POST requests are sent to ingest data to OPTIC DL. Following are the headers:
Name Description
messa
Name of the topic to which you are streaming messages.
getopi
Typically mapped to the dataset name to which you want to stream the data.
c*
messa Unique key associated with messages. This is an optional header. Messages are distributed across all partitions in round robin manner. If
gekey you want to send all the messages corresponding to a key to the same partition, set this header. The header value should hold the key.
* For example: Unique identifier of the system from which messages are sourced.
Conte
nt-Typ This is the standard HTTP header and you must set it as application/json.
e
X-Auth
IdM token of the user with the di_ingestion role.
-Token
* These header names may be different on your deployment. To get the header names on your deployment, run the following
command on the master/bastion node:
helm get values -a -n <suite namespace> RELEASE_NAME | grep headerFieldnameForTopic
Where,
<RELEASE_NAME> : Name of the Helm release. Can be the same as <suite namespace> .
<suite namespace> : The application namespace.
headerFieldnameForTopic: messagetopic
headerFieldnameForTopicKey: messagekey
Note down headerFieldnameForTopic and headerFieldnameForTopicKey values and use that as the topic header and key header.
Payload
HTTP Receiver accepts a JSON array or a stream of JSON objects, splits it to separate JSON objects, and forwards it to configured topic
in the OPTIC DL Message Bus.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 472
AI Operations Management - Containerized 24.4
Response code(s)
Response
Description
Code
Request can't be processed as the system is overloaded. This can happen if the clients send too many requests within a short
429
period of time.
Response body
Successful Response
If the request processes successfully, it returns the HTTP Status code 200. The response body has the "Success" text included.
Unsuccessful Response
When the request isn't processed successfully, one of the following status codes appears other than 200 mentioned in the Response
code(s) table.
For example, response code 400 for improper headers appears as follows:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 473
AI Operations Management - Containerized 24.4
DataSetMetadata API
You can use this API to perform the following operations:
Operation URI
For more information on each of the APIs, you can see the swagger documentation documented using OpenAPI specification here.
URI
https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata
Method
URI
https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata/{dataSetId}
Method
GET - View the Metadata of the dataset with ID in the OPTIC DL store.
DataSet API
To get data (records) from the datasets stored in the OPTIC Data Lake store for the dataSetId from the DataSetMetadata API
response.
URI
https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSet/{dataSetId}
Method
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 474
AI Operations Management - Containerized 24.4
fieldGroup and data_grain tags are added to the dataset tags array ( dataset level tags) and fieldType , instanceType ,
and instanceTitle tags are added to the field tags array (Field level tags).
dataset level tags are defined at the dataset level (for example retentionProfile ). OPTIC DL stores these tags in the DATASET
_TAG table in the itom_di_metadata_provider_default schema.
Field level tags are added to fields in a dataset configuration. OPTIC DL stores field level tags in the FIELD_TAG table under itom_
di_metadata_provider_default schema.
The sequence number guides the Troubleshoot Performance API order in which the field value is displayed in the target title. The
sequence uses comma (,) as the delimiter. A sequence number isn't required in the tag value if only one field identify the entity type
(for example In opsb_sysinfra_node or opsb_ext_node, node_fqdn field uniquely identify the host).
Important
Value of all Troubleshoot Performance tags must use the prefix as <table_class>_ to avoid naming conflicts. For example: For opsb_sysi
nfra_node the table class is sysinfra and metric is node.
Value of the instanceType tag is unique and identify the entity type across the database.
The instanceTitle tag should be added to a field in a dataset whose column FIELD_NAME can be used to display the instance name.
For a given entity type, the value of instanceTitle and instanceType is same.
If more than one field uniquely identify the entity type (Composite key), then instanceType and instanceTitle tag should be added to
all the fields along with the sequence number.
For example: In opsb_sysinfra_netif dataset, node_fqdn and netif_name columns identify a single network interface on a specific
host. In this scenario, you need to add instanceType and instanceTitle tag to both fields in the dataset configuration. In the following
table, the sequence number assigned to the node_fqdn field is 1 and netif_name is 2. In the target title, the FQDN name is
displayed first followed by the network interface name.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 475
AI Operations Management - Containerized 24.4
The value of Troubleshoot Performance tags should be unique and contain only lower case alphabets [a-z], numbers [0-9], and
word separator. It's recommended to begin the names with alphabets and the maximum length of name is 120 characters.
If the Troubleshoot Performance tags are added to a field that is in groupByFields then OPTIC DL forwards the tags from raw to the
aggregate dataset.
Tip
Important
The Troubleshoot Performance chart can't be enabled for Forecast dataset. For more information, see Forecast display
issue.
The fieldGroup tag groups the metrics across tables (raw, aggregation, etc). It's defined at the dataset level and should be added in
both raw and aggregate dataset configuration JSONs.
The data_grain tag allows the Troubleshoot Performance API to select the dataset based on the time parameter. If the selected
time is:
For example:
In opsb_ext_node , opsb_ext_node_1h , and opsb_ext_node_1d dataset configuration JSONs, adding fieldGroup tag with opsb_ext_node as
the value in the tags section, group all the metrics from Raw and Aggregate tables under a single field group called opsb_ext_node
and the same appears on the Troubleshoot Performance UI in the metrics section.
The data_grain tag is defined with raw as the value for opsb_ext_node dataset, hourly for opsb_ext_node_1h dataset, and daily for op
sb_ext_node_1d .
Raw dataset:
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 476
AI Operations Management - Containerized 24.4
"tags":[
{
"name":"fieldGroup",
"value":"opsb_ext_node"
},
{
"name":"data_grain",
"value":"raw"
}
]
Hourly dataset:
"tags":[
{
"name":"fieldGroup",
"value":"opsb_ext_node"
},
{
"name":"data_grain",
"value":"hourly"
}
]
Daily dataset:
"tags":[
{
"name":"fieldGroup",
"value":"opsb_ext_node"
},
{
"name":"data_grain",
"value":"daily"
}
]
2. instanceType
The instanceType tag is used in the Troubleshoot Performance API to identify the potential list of field groups for a given type
name. The tag can be of any unique value across the database but should represent the entity type.
For example:
In opsb_ext_node (given in the example) table, node_fqdn column has the instanceType tag with value < table_class>_node.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 477
AI Operations Management - Containerized 24.4
{
"id":"node_fqdn_id",
"name":"node_fqdn",
"type":"string",
"displayName":"Host Name",
"description":"Name of the Host",
"maxLength":200,
"isKey":true,
"isPrimaryKey":false,
"isSampleTime":false,
"isNullable":false,
"fieldCanonicalName":"hostname",
"tags":[
{
"name":"fieldType",
"value":"attribute"
},
{
"name":"instanceType",
"value":"<table_class>_node"
},
{
"name":"instanceTitle",
"value":"<table_class>_node"
}
]
},
3. instanceTitle:
The instanceTitle tag guides the Troubleshoot Performance API on which column should be used as the display name for a
particular target.
For example:
In the opsb_ext_node (given in the example) table, node_fqdn column has the instanceTitle tag with value
< table_class>_node . Hence, the node_fqdn column values are displayed in the targets dropdown.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 478
AI Operations Management - Containerized 24.4
4. Metrics:
The Metric tag ( fieldType tag with metric as value) can be used in the Troubleshoot Performance API to fetch the possible metrics
for a selected fieldGroup . You can view the time series graph for the fields having a Metric tag.
For example:
In the aggregate configuration of opsb_ext_node, adding the fieldType tag with metric as value to the aggregate field cpu_util_pct_av
g will list this metric under the field group opsb_ext_node on the Troubleshoot Performance UI.
{
"aggregationFunction":"average",
"aggregationType":"GenericAggregateRuleConfiguration",
"destinationField":"cpu_util_pct_avg",
"destinationFieldId":"cpu_util_pct_avg_id",
"sourceFieldId":"cpu_util_pct_id",
"displayName":"Average CPU Utilization",
"description":"Average hourly CPU utilization",
"destinationFieldCanonicalName":"CPUUtilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
}
5. Attributes:
The Attribute tag ( fieldType tag with attribute as value) can be used in the Troubleshoot Performance API to fetch the target filter
columns for a selected fieldGroup .
For example:
To filter the < table_class>_node targets based on their Hostname, add fieldType tag with the value attribute for node_fqdn field in
the dataset configuration.
{
"id":"node_fqdn_id",
"name":"node_fqdn",
"type":"string",
"displayName":"Host Name",
"description":"Name of the Host",
"maxLength":200,
"isKey":true,
"isPrimaryKey":false,
"isSampleTime":false,
"isNullable":false,
"fieldCanonicalName":"hostname",
"tags":[
{
"name":"fieldType",
"value":"attribute"
},
{
"name":"instanceType",
"value":"<table_class>_node"
},
{
"name":"instanceTitle",
"value":"<table_class>_node"
}
]
}
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 479
AI Operations Management - Containerized 24.4
Related topics
For Open Data Ingestion steps, see Tutorial for streaming.
To create custom BVD reports, see BVD reports.
For more information about Troubleshoot Performance, see Enable logging for Troubleshoot Performance.
To view the Troubleshoot Performance user interface dashboard, see Troubleshoot Performance.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 480
AI Operations Management - Containerized 24.4
Prerequisites
One instance of BVD must be running along with OPTIC DL/Vertica database
Installed instance of Microsoft Visio
Access to BVD with administrator user credentials using the URL https://<external_hostname>:<port>/bvd>
5. In the Open Stencil window, go to the location where you have saved BusinessValueDashboardStencil and select BusinessValue
DashboardStencil.vssx
Create dashboard
Use the appropriate widgets from the left pane to create your report
1. Drag the widget/shapes to the drawing page to add them to the report
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 481
AI Operations Management - Containerized 24.4
Important
Save the file with a different name. Avoid using report names. For example:
SystemInfrastructureSummary.svg
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 482
AI Operations Management - Containerized 24.4
SQL Query
SELECT * FROM <database table name> WHERE <conditions> GROUP BY <columns> ORDER BY <columns>
Sample query:
SELECT * from opsb_ext_node WHERE timestamp_tz >= '2022-03-12 12:00:00' and timestamp_tz <= '2022-03-18 12:00:00' GROUP BY
node_fqdn order by timestamp_tz
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 483
AI Operations Management - Containerized 24.4
Enterprise Application
System Infrastructure
Event
Real User Monitoring
Synthetic Transaction
CMDB
Hyperscale Observability
You can use these datasets in the out of the box applications like reporting and while creating custom reports in BVD or any other
Business Intelligence tool of your choice.
Important
Ensure that you don't modify the out of the box datasets present in themf_shared_provider_default schema in the database. Doing so
will overwrite all the customizations during a content upgrade.
Note
There are additional internal tables within the schema and additional schema (itom_di_configuration_default_default ,
itom_di_meta
data_default_default , itom_di_postload_default_default , itom_di_scheduler_default_default , and others) that are created as
part of OPTIC Data Lake configurations. These tables and schema are intended only for the product’s internal functioning (usage) and not for
data access.
b Data byte
kb Data Kilobytes
hz Frequency Hertz
us Time Microsecond
ms Time Millisecond
s Time Second
h Time Hour
d Time Day
m Time Month
y Time Year
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 484
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 485
AI Operations Management - Containerized 24.4
OPTIC Reporting
The following new schemas are added in this release:
opsb_agent_application
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 486
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 487
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 488
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 489
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 490
AI Operations Management - Containerized 24.4
Not available
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 491
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 492
AI Operations Management - Containerized 24.4
Forecast
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily)
Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 493
AI Operations Management - Containerized 24.4
1.4.2.1.1. opsb_websphere_ejb
Description Websphere Server Enterprise JavaBeans Monitoring Data
Key columns websphere_ejb_app_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
EJBPOOLUTILAPPPCT ejb_pool_active_beans_app_pct double 48 Percentage of active beans in the pool for an application
EJBCONCLIVESAPP ejb_avg_concurr_lives_app_count double 48 Average number of EJB Concurrent Lives for an application
EJBMETHCALLSRTAPP ejb_method_calls_app_count_per_min double 48 Number of EJB method calls per minute for an application
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 494
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 495
AI Operations Management - Containerized 24.4
1.4.2.1.2. opsb_websphere_ejb_1d
Description Websphere Server Enterprise JavaBeans Monitoring Data (Daily)
Source dataset opsb_websphere_ejb
Aggregation
Column Name Data Type Size Description
Type
ejb_avg_pool_size_min_count double 48 min The Minimum average size of the EJB pool
ejb_avg_pool_size_max_count double 48 max The Maximum average size of the EJB pool
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 496
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 497
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 498
AI Operations Management - Containerized 24.4
1.4.2.1.3. opsb_websphere_ejb_1h
Description Websphere Server Enterprise JavaBeans Monitoring Data (Hourly)
Source dataset opsb_websphere_ejb
Aggregation
Column Name Data Type Size Description
Type
ejb_avg_pool_size_min_count double 48 min The Minimum average size of the EJB pool
ejb_avg_pool_size_max_count double 48 max The Maximum average size of the EJB pool
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 499
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 500
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 501
AI Operations Management - Containerized 24.4
1.4.2.1.4. opsb_websphere_ejb_descriptor
Description Websphere Server Enterprise JavaBeans Descriptor Data
Key columns websphere_ejb_app_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 502
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 503
AI Operations Management - Containerized 24.4
1.4.2.1.5. opsb_websphere_ejb_descriptor_1d
Description Websphere Server Enterprise JavaBeans Descriptor Data (Daily)
Source dataset opsb_websphere_ejb_descriptor
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 504
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 505
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 506
AI Operations Management - Containerized 24.4
1.4.2.1.6. opsb_websphere_ejb_descriptor_1h
Description Websphere Server Enterprise JavaBeans Descriptor Data (Hourly)
Source dataset opsb_websphere_ejb_descriptor
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 507
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 508
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 509
AI Operations Management - Containerized 24.4
1.4.2.1.7. opsb_websphere_jdbc
Description Websphere Server Java Database Connectivity Data
Key columns websphere_jdbc_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 510
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 511
AI Operations Management - Containerized 24.4
1.4.2.1.8. opsb_websphere_jdbc_1d
Description Websphere Server Java Database Connectivity Data (Daily)
Source dataset opsb_websphere_jdbc
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 512
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 513
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 514
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 515
AI Operations Management - Containerized 24.4
1.4.2.1.9. opsb_websphere_jdbc_1h
Description Websphere Server Java Database Connectivity Data (Hourly)
Source dataset opsb_websphere_jdbc
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 516
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 517
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 518
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 519
AI Operations Management - Containerized 24.4
1.4.2.1.10. opsb_websphere_jdbc_descriptor
Description Websphere Server Java Database Connectivity Descriptor Data
Key columns websphere_jdbc_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 520
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 521
AI Operations Management - Containerized 24.4
1.4.2.1.11. opsb_websphere_jdbc_descriptor_1d
Description Websphere Server Java Database Connectivity Descriptor Data (Daily)
Source dataset opsb_websphere_jdbc_descriptor_1h
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 522
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 523
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 524
AI Operations Management - Containerized 24.4
1.4.2.1.12. opsb_websphere_jdbc_descriptor_1h
Description Websphere Server Java Database Connectivity Descriptor Data (Hourly)
Source dataset opsb_websphere_jdbc_descriptor
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 525
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 526
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 527
AI Operations Management - Containerized 24.4
1.4.2.1.13. opsb_websphere_jvm_perf
Description Websphere Server Java Virtual Machine Performance Data
Key columns websphere_jvm_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
USDHEAPSZ_P jvm_used_heap_size_pct double 48 Percentage of heap space used in the JVM in kilobytes.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 528
AI Operations Management - Containerized 24.4
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 529
AI Operations Management - Containerized 24.4
1.4.2.1.14. opsb_websphere_jvm_perf_1d
Description Websphere Server Java Virtual Machine Performance Data (Daily)
Source dataset opsb_websphere_jvm_perf
Aggregation
Column Name Data Type Size Description
Type
cpu_usage_pctl_pct integer 24 90 percentile The Percentile of the percentage of process CPU usage
jvm_heap_size_avg_kb double 48 average The Average JVM runtime total heap size in kilobytes.
jvm_heap_size_min_kb double 48 min The Minimum JVM runtime total heap size in kilobytes.
jvm_heap_size_max_kb double 48 max The Maximum JVM runtime total heap size in kilobytes.
jvm_used_heap_size_avg_kb double 48 average The Average heap space used in the JVM in kilobytes.
jvm_used_heap_size_min_kb double 48 min The Minimum heap space used in the JVM in kilobytes.
jvm_used_heap_size_max_kb double 48 max The Maximum heap space used in the JVM in kilobytes.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 530
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
jvm_free_mem_available_avg_kb double 48 average The Average JVM Free Memory available in kilobytes.
jvm_free_mem_available_min_kb double 48 min The Minimum JVM Free Memory available in kilobytes.
jvm_free_mem_available_max_kb double 48 max The Maximum JVM Free Memory available in kilobytes.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 531
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 532
AI Operations Management - Containerized 24.4
1.4.2.1.15. opsb_websphere_jvm_perf_1h
Description Websphere Server Java Virtual Machine Performance Data (Hourly)
Source dataset opsb_websphere_jvm_perf
Aggregation
Column Name Data Type Size Description
Type
cpu_usage_pctl_pct integer 24 90 percentile The Percentile of the percentage of process CPU usage
jvm_heap_size_avg_kb double 48 average The Average JVM runtime total heap size in kilobytes.
jvm_heap_size_min_kb double 48 min The Minimum JVM runtime total heap size in kilobytes.
jvm_heap_size_max_kb double 48 max The Maximum JVM runtime total heap size in kilobytes.
jvm_used_heap_size_avg_kb double 48 average The Average heap space used in the JVM in kilobytes.
jvm_used_heap_size_min_kb double 48 min The Minimum heap space used in the JVM in kilobytes.
jvm_used_heap_size_max_kb double 48 max The Maximum heap space used in the JVM in kilobytes.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 533
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
jvm_free_mem_available_avg_kb double 48 average The Average JVM Free Memory available in kilobytes.
jvm_free_mem_available_min_kb double 48 min The Minimum JVM Free Memory available in kilobytes.
jvm_free_mem_available_max_kb double 48 max The Maximum JVM Free Memory available in kilobytes.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 534
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 535
AI Operations Management - Containerized 24.4
1.4.2.1.16. opsb_websphere_server_status
Description Websphere Server Status
Key columns websphere_srv_instance, timestamp_utc_s, node_fqdn
SERVERSTATUS srv_status integer 24 Status of a server that monitors whether running or not.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 536
AI Operations Management - Containerized 24.4
1.4.2.1.17. opsb_websphere_server_status_1d
Description Websphere Server Status (Daily)
Source dataset opsb_websphere_server_status_1h
Aggregation
Column Name Data Type Size Description
Type
Indicates the type of the data producer that ingested the data.
producer_instance_type string 50 lastval
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
collection_policy_name string 255 lastval policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 537
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 538
AI Operations Management - Containerized 24.4
1.4.2.1.18. opsb_websphere_server_status_1h
Description Websphere Server Status (Hourly)
Key columns websphere_srv_instance, timestamp_utc_s, node_fqdn
The time duration (in minutes) in an hour when the Websphere server is in
null uptime_min double
running state.
The time duration (in minutes) in an hour when the Websphere server is
null downtime_min double
not in running state.
The time duration (in minutes) in an hour when the Websphere server is
null planned_downtime_min double
not running due to planned outage.
The time duration (in minutes) in an hour when the Websphere server is
null unknown_time_min double
not running due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 539
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 540
AI Operations Management - Containerized 24.4
1.4.2.1.19. opsb_websphere_servlet
Description Websphere Servlet Monitoring Data
Key columns websphere_app_instance, websphere_srv_instance, domain_name, timestamp_utc_s, node_fqdn
WEBAPPSERVREQRTAPP servlet_req_app_count_per_s double 48 Number of requests for a servlet per second for an application
WEBAPPSRVLTRESPTIME servlet_avg_resp_time_ms double 48 Average response time for a web application servlet in milliseconds
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 541
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 542
AI Operations Management - Containerized 24.4
1.4.2.1.20. opsb_websphere_servlet_1d
Description Websphere Servlet Monitoring Data (Daily)
Source dataset opsb_websphere_servlet_1h
Aggregation
Column Name Data Type Size Description
Type
servlet_err_avg_count_per_s double 48 average The Average number of errors in a servlet per second.
servlet_err_min_count_per_s double 48 min The Minimum number of errors in a servlet per second.
servlet_err_max_count_per_s double 48 max The Maximum number of errors in a servlet per second.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 543
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 544
AI Operations Management - Containerized 24.4
1.4.2.1.21. opsb_websphere_servlet_1h
Description Websphere Servlet Monitoring Data (Hourly)
Source dataset opsb_websphere_servlet
Aggregation
Column Name Data Type Size Description
Type
servlet_err_avg_count_per_s double 48 average The Average number of errors in a servlet per second.
servlet_err_min_count_per_s double 48 min The Minimum number of errors in a servlet per second.
servlet_err_max_count_per_s double 48 max The Maximum number of errors in a servlet per second.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 545
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 546
AI Operations Management - Containerized 24.4
1.4.2.1.22. opsb_websphere_servlet_session_module
Description Websphere Servlet Session Module Data
Key columns websphere_app_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
WEBAPPSERVREQRT servlet_session_invalidated_count_per_s double 48 Number of servlet sessions being invalidated per second
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 547
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 548
AI Operations Management - Containerized 24.4
1.4.2.1.23.
opsb_websphere_servlet_session_module_1d
Description Websphere Servlet Session Module Data(Daily)
Source dataset opsb_websphere_servlet_session_module_1h
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 549
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 550
AI Operations Management - Containerized 24.4
1.4.2.1.24.
opsb_websphere_servlet_session_module_1h
Description Websphere Servlet Session Module Data(Hourly)
Source dataset opsb_websphere_servlet_session_module
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 551
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 552
AI Operations Management - Containerized 24.4
1.4.2.1.25. opsb_websphere_thread
Description Websphere Server Thread Data
Key columns websphere_thread_pool_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
THREADPOOLUTILPCT thread_pool_threads_used_pct double 48 Percentage of threads used in a pool during collection interval
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 553
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 554
AI Operations Management - Containerized 24.4
1.4.2.1.26. opsb_websphere_thread_1d
Description Websphere Server Thread Data (Daily)
Source dataset opsb_websphere_thread
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 555
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 556
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 557
AI Operations Management - Containerized 24.4
1.4.2.1.27. opsb_websphere_thread_1h
Description Websphere Server Thread Data (Hourly)
Source dataset opsb_websphere_thread
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 558
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 559
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 560
AI Operations Management - Containerized 24.4
1.4.2.1.28. opsb_websphere_thread_descriptor
Description Websphere Server Thread Descriptor Data
Key columns websphere_thread_pool_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
THREADPOOLHUNGRT threads_declared_hung_count_per_s double 48 The rate at which the threads are declared hung.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 561
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 562
AI Operations Management - Containerized 24.4
1.4.2.1.29. opsb_websphere_thread_descriptor_1d
Description Websphere Server Thread Descriptor Data (Daily)
Source dataset opsb_websphere_thread_descriptor
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 563
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 564
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 565
AI Operations Management - Containerized 24.4
1.4.2.1.30. opsb_websphere_thread_descriptor_1h
Description Websphere Server Thread Descriptor Data (Hourly)
Source dataset opsb_websphere_thread_descriptor
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 566
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 567
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 568
AI Operations Management - Containerized 24.4
1.4.2.1.31. opsb_websphere_transact
Description Websphere Server Transact Data
Key columns websphere_txn_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
TRANROLLBACKRT txn_rolled_back_count_per_s double 48 Number of global and local transactions rolled back per second
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 569
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 570
AI Operations Management - Containerized 24.4
1.4.2.1.32. opsb_websphere_transact_1d
Description Websphere Server Transact Data (Daily)
Source dataset opsb_websphere_transact_1h
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 571
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 572
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 573
AI Operations Management - Containerized 24.4
1.4.2.1.33. opsb_websphere_transact_1h
Description Websphere Server Transact Data (Hourly)
Source dataset opsb_websphere_transact
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 574
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 575
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 576
AI Operations Management - Containerized 24.4
1.4.2.1.34. opsb_websphere_webapp
Description Websphere Server Webapp Data
Key columns websphere_app_instance, websphere_srv_instance, timestamp_utc_s, node_fqdn
WEBAPPSERVREQRT servlet_session_invalidated_count_per_s double 48 Number of servlet sessions being invalidated per second.
WEBAPPSERVLOAD webapp_servlets_loaded_count_per_s double 48 Number of servlets currently loaded for a web application
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 577
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 578
AI Operations Management - Containerized 24.4
1.4.2.1.35. opsb_websphere_webapp_1d
Description Websphere Server Webapp Data (Daily)
Source dataset opsb_websphere_webapp_1h
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 579
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 580
AI Operations Management - Containerized 24.4
1.4.2.1.36. opsb_websphere_webapp_1h
Description Websphere Server Webapp Data (Hourly)
Source dataset opsb_websphere_webapp
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 581
AI Operations Management - Containerized 24.4
Aggregation
Column Name Data Type Size Description
Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 582
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 583
AI Operations Management - Containerized 24.4
1.4.2.2.1. opsb_jboss_appstatus
Description JBoss Server Application Status Monitoring
Key columns jboss_srv_instance_name, app_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 584
AI Operations Management - Containerized 24.4
1.4.2.2.2. opsb_jboss_availability
Description JBoss Server Availability Data
Key columns jboss_srv_instance_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 585
AI Operations Management - Containerized 24.4
1.4.2.2.3. opsb_jboss_availability_1d
Description Jboss Server Health Data (Daily)
Source dataset opsb_jboss_availability_1h
Data Aggregation
Column Name Size Description
Type Type
uptime_min double sum The time duration (in minutes) in an hour when the AD service is in running state.
uptime_avg_pct double avg The Average percentage of time in an hour when the AD service is in running state.
downtime_min double sum The time duration (in minutes) in an hour when the AD service is not in running state.
downtime_avg_pct double avg The Average percentage of time in an hour when the AD service is not in running state.
The time duration (in minutes) in an hour when the AD service not running due to AD
planned_downtime_min double sum
server planned outage.
The Average percentage of time in an hour when the AD service not running due to AD
planned_downtime_avg_pct double avg
server planned outage.
The time duration (in minutes) in an hour when the AD service state information not
unknown_time_min double sum
available due to unknown outage.
The Average percentage of time in an hour when the AD service state information not
unknown_time_avg_pct double avg
available due to unknown outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBoss uniquely identify each server based on server host , server port and server name
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 586
AI Operations Management - Containerized 24.4
1.4.2.2.4. opsb_jboss_availability_1h
Description Jboss Server Health Hourly
Key columns jboss_srv_instance_name, timestamp_utc_s, node_fqdn
JBoss uniquely identify each server based on server host , server port and
JBOSSINST jboss_srv_instance_name string 255
server name
The time duration (in minutes) in an hour when the AD service is not in
null downtime_min double
running state.
The time duration (in minutes) in an hour when the AD service not
null planned_downtime_min double
running due to AD server planned outage.
The percentage of time in an hour when the AD service not running due
null planned_downtime_pct double
to AD server planned outage.
The time duration (in minutes) in an hour when the AD service state
null unknown_time_min double
information not available due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 587
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 588
AI Operations Management - Containerized 24.4
1.4.2.2.5. opsb_jboss_gc
Description JBoss Server Garbage Collection Data
Key columns jboss_srv_instance_name, gc_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
GARBAGECOLLNAME gc_name string 255 The name representing this garbage collector
COLLECTIONCOUNT gc_count integer 24 The total number of collections that have occurred
COLLECTIONTIME gc_time_ms double 24 The approximate accumulated collection elapsed time in milliseconds
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 589
AI Operations Management - Containerized 24.4
1.4.2.2.6. opsb_jboss_gc_1d
Description JBoss Server Garbage Collection Data (Daily)
Source dataset opsb_jboss_gc_1h
Data Aggregation
Column Name Size Description
Type Type
gc_count integer 24 lastval The total number of collections that have occurred
gc_avg_count integer 24 average The Average total number of collections that have occurred
gc_min_count integer 24 min The Minimum total number of collections that have occurred
gc_max_count integer 24 max The Maximum total number of collections that have occurred
gc_time_avg_ms double 24 average The Average approximate accumulated collection elapsed time in milliseconds
gc_time_min_ms double 24 min The Minimum approximate accumulated collection elapsed time in milliseconds
gc_time_max_ms double 24 max The Maximum approximate accumulated collection elapsed time in milliseconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 590
AI Operations Management - Containerized 24.4
1.4.2.2.7. opsb_jboss_gc_1h
Description JBoss Server Garbage Collection Data (Hourly)
Source dataset opsb_jboss_gc
Data Aggregation
Column Name Size Description
Type Type
gc_count integer 24 lastval The total number of collections that have occurred
gc_avg_count integer 24 average The Average total number of collections that have occurred
gc_min_count integer 24 min The Minimum total number of collections that have occurred
gc_max_count integer 24 max The Maximum total number of collections that have occurred
gc_time_avg_ms double 24 average The Average approximate accumulated collection elapsed time in milliseconds
gc_time_min_ms double 24 min The Minimum approximate accumulated collection elapsed time in milliseconds
gc_time_max_ms double 24 max The Maximum approximate accumulated collection elapsed time in milliseconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 591
AI Operations Management - Containerized 24.4
1.4.2.2.8. opsb_jboss_j2eeejbmsg
Description JBoss Server J2ee EJB Message Driven Bean Data
Key columns jboss_srv_instance_name, msg_bean_name, ejb_jar_name, ejb_ear_name, timestamp_utc_s, node_fqdn
STATELESSAVAILCT available_pool_instance_count integer 24 The number of available (i.e. not in use) instances in the pool
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 592
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 593
AI Operations Management - Containerized 24.4
1.4.2.2.9. opsb_jboss_j2eeejbmsg_1d
Description JBoss Server J2ee EJB Message Driven Bean Data (Daily)
Source dataset opsb_jboss_j2eeejbmsg_1h
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 594
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_ear_name_id string 255 Name of the deployed ear where the message driven bean present
ejb_jar_name_id string 255 Name of the deployed jar where the message driven bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 595
AI Operations Management - Containerized 24.4
1.4.2.2.10. opsb_jboss_j2eeejbmsg_1h
Description JBoss Server J2ee EJB Message Driven Bean Data (Hourly)
Source dataset opsb_jboss_j2eeejbmsg
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 596
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_ear_name_id string 255 Name of the deployed ear where the message driven bean present
ejb_jar_name_id string 255 Name of the deployed jar where the message driven bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 597
AI Operations Management - Containerized 24.4
1.4.2.2.11. opsb_jboss_j2eeejbstful
Description JBoss Server J2ee EJB Stateful Bean Data
Key columns jboss_srv_instance_name, bean_name, ejb_jar_name, ejb_ear_name, timestamp_utc_s, node_fqdn
Name of the deployed jar where the stateful session bean bean
EJBJARNAME ejb_jar_name string 255
present
STATEFULBEANINVOKE bean_invocations_count integer 24 Number of invocations processed for the stateful bean
STATEFULWAITTIME wait_time_ms integer 24 Time spend waiting to obtain an instance of the stateful bean
STATEFULPEAKCONINVRT peak_concurr_invocation_count_per_s integer 24 Peak concurrent invocations of the stateful bean Per Second
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 598
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 599
AI Operations Management - Containerized 24.4
1.4.2.2.12. opsb_jboss_j2eeejbstful_1d
Description JBoss Server J2ee EJB Stateful Bean Data (Daily)
Source dataset opsb_jboss_j2eeejbstful_1h
Data Aggregation
Column Name Size Description
Type Type
bean_total_avg_count integer 24 average The Average total number of size of Stateful session bean
bean_total_min_count integer 24 min The Minimum total number of size of Stateful session bean
bean_total_max_count integer 24 max The Maximum total number of size of Stateful session bean
bean_cache_avg_count double 24 average The Average cache size of the stateful session bean
bean_cache_min_count double 24 min The Minimum cache size of the stateful session bean
bean_cache_max_count double 24 max The Maximum cache size of the stateful session bean
passive_bean_avg_count double 24 average The Average passivated count of the stateful session bean
passive_bean_min_count double 24 min The Minimum passivated count of the stateful session bean
passive_bean_max_count double 24 max The Maximum passivated count of the stateful session bean
bean_invocations_count integer 24 lastval Number of invocations processed for the stateful bean
bean_invocations_avg_count integer 24 average The Average number of invocations processed for the stateful bean
bean_invocations_min_count integer 24 min The Minimum number of invocations processed for the stateful bean
bean_invocations_max_count integer 24 max The Maximum number of invocations processed for the stateful bean
peak_concurr_invocations_avg_count integer 24 average The Average peak concurrent invocations of the stateful bean
peak_concurr_invocations_min_count integer 24 min The Minimum peak concurrent invocations of the stateful bean
peak_concurr_invocations_max_count integer 24 max The Maximum peak concurrent invocations of the stateful bean
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 600
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_ear_name_id string 255 Name of the deployed ear where the stateful session bean present
ejb_jar_name_id string 255 Name of the deployed jar where the stateful session bean bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 601
AI Operations Management - Containerized 24.4
1.4.2.2.13. opsb_jboss_j2eeejbstful_1h
Description JBoss Server J2ee EJB Stateful Bean Data (Hourly)
Source dataset opsb_jboss_j2eeejbstful
Data Aggregation
Column Name Size Description
Type Type
bean_total_avg_count integer 24 average The Average total number of size of Stateful session bean
bean_total_min_count integer 24 min The Minimum total number of size of Stateful session bean
bean_total_max_count integer 24 max The Maximum total number of size of Stateful session bean
bean_cache_avg_count double 24 average The Average cache size of the stateful session bean
bean_cache_min_count double 24 min The Minimum cache size of the stateful session bean
bean_cache_max_count double 24 max The Maximum cache size of the stateful session bean
passive_bean_avg_count double 24 average The Average passivated count of the stateful session bean
passive_bean_min_count double 24 min The Minimum passivated count of the stateful session bean
passive_bean_max_count double 24 max The Maximum passivated count of the stateful session bean
bean_invocations_count integer 24 lastval Number of invocations processed for the stateful bean
bean_invocations_avg_count integer 24 average The Average number of invocations processed for the stateful bean
bean_invocations_min_count integer 24 min The Minimum number of invocations processed for the stateful bean
bean_invocations_max_count integer 24 max The Maximum number of invocations processed for the stateful bean
peak_concurr_invocations_avg_count integer 24 average The Average peak concurrent invocations of the stateful bean
peak_concurr_invocations_min_count integer 24 min The Minimum peak concurrent invocations of the stateful bean
peak_concurr_invocations_max_count integer 24 max The Maximum peak concurrent invocations of the stateful bean
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 602
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_ear_name_id string 255 Name of the deployed ear where the stateful session bean present
ejb_jar_name_id string 255 Name of the deployed jar where the stateful session bean bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 603
AI Operations Management - Containerized 24.4
1.4.2.2.14. opsb_jboss_j2eeejbstless
Description JBoss Server J2ee EJB Stateless Bean Data
Key columns jboss_srv_instance_name, bean_name, ejb_jar_name, ejb_ear_name, timestamp_utc_s, node_fqdn
EJBJARNAME ejb_jar_name string 255 Stateless Session Bean Deployed JAR Name
J2EEAPPEARNAME ejb_ear_name string 255 Stateless Session Bean Deployed EAR Name
STATELESSAVAILCT available_pool_instance_count integer 24 The number of available (i.e. not in use) instances in the pool
STATELESSCURSIZE pool_curr_req_count integer 24 The current size of the pool of stateless session bean
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 604
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 605
AI Operations Management - Containerized 24.4
1.4.2.2.15. opsb_jboss_j2eeejbstless_1d
Description JBoss Server J2ee EJB Stateless Bean Data (Daily)
Source dataset opsb_jboss_j2eeejbstless_1h
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
pool_curr_req_count integer 24 lastval The current size of the pool of stateless session bean
pool_curr_req_avg_count integer 24 average The Average current size of the pool of stateless session bean
pool_curr_req_min_count integer 24 min The Minimum current size of the pool of stateless session bean
pool_curr_req_max_count integer 24 max The Maximum current size of the pool of stateless session bean
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 606
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 607
AI Operations Management - Containerized 24.4
1.4.2.2.16. opsb_jboss_j2eeejbstless_1h
Description JBoss Server J2ee EJB Stateless Bean Data (Hourly)
Source dataset opsb_jboss_j2eeejbstless
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
pool_curr_req_count integer 24 lastval The current size of the pool of stateless session bean
pool_curr_req_avg_count integer 24 average The Average current size of the pool of stateless session bean
pool_curr_req_min_count integer 24 min The Minimum current size of the pool of stateless session bean
pool_curr_req_max_count integer 24 max The Maximum current size of the pool of stateless session bean
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 608
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 609
AI Operations Management - Containerized 24.4
1.4.2.2.17. opsb_jboss_j2eeservlet
Description JBoss Server J2ee Servlet Data
Key columns jboss_srv_instance_name, servlet_name, web_app_war_name, j2ee_app_ear_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
WEBAPPWARNAME web_app_war_name string 255 Name of the web application where the servlet is present
J2EEAPPEARNAME j2ee_app_ear_name string 255 Name of the J2ee application where the servlet is present
SERVLETMAXTIME max_processing_req_time_ms double 24 Maximal time for processing request by the servlet
SERVLETMINTIME min_processing_req_time_ms double 24 Minimal time for processing request by the servlet
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 610
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 611
AI Operations Management - Containerized 24.4
1.4.2.2.18. opsb_jboss_j2eeservlet_1d
Description JBoss Server J2ee Servlet Data (Daily)
Source dataset opsb_jboss_j2eeservlet_1h
Data Aggregation
Column Name Size Description
Type Type
max_processing_req_time_avg_ms double 24 average The Average maximal time for processing request by the servlet
min_processing_req_time_avg_ms double 24 average The Average minimal time for processing request by the servlet
min_processing_req_time_min_ms double 24 min The Minimum minimal time for processing request by the servlet
servlet_req_avg_count integer 24 average The Average number of all requests for the servlet
servlet_req_min_count integer 24 min The Minimum number of all requests for the servlet
servlet_req_max_count integer 24 max The Maximum number of all requests for the servlet
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
j2ee_app_ear_name_id string 255 Name of the J2ee application where the servlet is present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
web_app_war_name_id string 255 Name of the web application where the servlet is present
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 612
AI Operations Management - Containerized 24.4
1.4.2.2.19. opsb_jboss_j2eeservlet_1h
Description JBoss Server J2ee Servlet Data (Hourly)
Source dataset opsb_jboss_j2eeservlet
Data Aggregation
Column Name Size Description
Type Type
max_processing_req_time_avg_ms double 24 average The Average maximal time for processing request by the servlet
min_processing_req_time_avg_ms double 24 average The Average minimal time for processing request by the servlet
min_processing_req_time_min_ms double 24 min The Minimum minimal time for processing request by the servlet
servlet_req_avg_count integer 24 average The Average number of all requests for the servlet
servlet_req_min_count integer 24 min The Minimum number of all requests for the servlet
servlet_req_max_count integer 24 max The Maximum number of all requests for the servlet
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
j2ee_app_ear_name_id string 255 Name of the J2ee application where the servlet is present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
web_app_war_name_id string 255 Name of the web application where the servlet is present
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 613
AI Operations Management - Containerized 24.4
1.4.2.2.20. opsb_jboss_j2eewebapp
Description JBoss Server J2ee Web Application Data
Key columns jboss_srv_instance_name, web_app_war_name, j2ee_app_ear_name, timestamp_utc_s, node_fqdn
JBoss uniquely identify each server based on server host , server port and
JBOSSINST jboss_srv_instance_name string 255
server name
WEBAPPWARNAME web_app_war_name string 255 Name of the web application where the servlet is present
J2EEAPPEARNAME j2ee_app_ear_name string 255 Name of the J2ee application where the servlet is present
AVGALIVETIME session_avg_alive_time_s double 24 Average time (in seconds) that expired sessions had been alive
MAXALIVETIME session_max_alive_time_s double 24 The longest time (in seconds) that an expired session had been alive
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 614
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 615
AI Operations Management - Containerized 24.4
1.4.2.2.21. opsb_jboss_j2eewebapp_1d
Description JBoss Server J2ee Web Application Data (Daily)
Source dataset opsb_jboss_j2eewebapp_1h
Data Aggregation
Column Name Size Description
Type Type
expired_sessions_avg_count integer 24 average The Average total number of sessions that have expired
expired_sessions_min_count integer 24 min The Minimum total number of sessions that have expired
expired_sessions_max_count integer 24 max The Maximum total number of sessions that have expired
session_avg_alive_time_avg_s average The Average average time (in seconds) that expired sessions had been alive
session_avg_alive_time_min_s min The Minimum average time (in seconds) that expired sessions had been alive
session_avg_alive_time_max_s max The Maximum average time (in seconds) that expired sessions had been alive
session_max_alive_time_avg_s average The Average longest time (in seconds) that an expired session had been alive
session_max_alive_time_max_s max The Maximum longest time (in seconds) that an expired session had been alive
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 616
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
j2ee_app_ear_name_id string 255 Name of the J2ee application where the servlet is present
JBoss uniquely identify each server based on server host , server port and server
jboss_srv_instance_name_id string 255
name
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
web_app_war_name_id string 255 Name of the web application where the servlet is present
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 617
AI Operations Management - Containerized 24.4
1.4.2.2.22. opsb_jboss_j2eewebapp_1h
Description JBoss Server J2ee Web Application Data (Hourly)
Source dataset opsb_jboss_j2eewebapp
Data Aggregation
Column Name Size Description
Type Type
expired_sessions_avg_count integer 24 average The Average total number of sessions that have expired
expired_sessions_min_count integer 24 min The Minimum total number of sessions that have expired
expired_sessions_max_count integer 24 max The Maximum total number of sessions that have expired
session_avg_alive_time_avg_s double 24 average The Average average time (in seconds) that expired sessions had been alive
session_avg_alive_time_min_s double 24 min The Minimum average time (in seconds) that expired sessions had been alive
session_avg_alive_time_max_s double 24 max The Maximum average time (in seconds) that expired sessions had been alive
session_max_alive_time_avg_s double 24 average The Average longest time (in seconds) that an expired session had been alive
session_max_alive_time_max_s double 24 max The Maximum longest time (in seconds) that an expired session had been alive
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 618
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
j2ee_app_ear_name_id string 255 Name of the J2ee application where the servlet is present
JBoss uniquely identify each server based on server host , server port and server
jboss_srv_instance_name_id string 255
name
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
web_app_war_name_id string 255 Name of the web application where the servlet is present
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 619
AI Operations Management - Containerized 24.4
1.4.2.2.23. opsb_jboss_jarejbmessage
Description JBoss Server Jar EJB Message Driven Bean Data
Key columns jboss_srv_instance_name, msg_bean_name, ejb_jar_name, timestamp_utc_s, node_fqdn
STATELESSAVAILCT available_pool_instance_count integer 24 The number of available (i.e. not in use) instances in the pool
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 620
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 621
AI Operations Management - Containerized 24.4
1.4.2.2.24. opsb_jboss_jarejbmessage_1d
Description JBoss Server Jar EJB Message Driven Bean Data (Daily)
Source dataset opsb_jboss_jarejbmessage_1h
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 622
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_jar_name_id string 255 Name of the deployed jar where the message driven bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 623
AI Operations Management - Containerized 24.4
1.4.2.2.25. opsb_jboss_jarejbmessage_1h
Description JBoss Server Jar EJB Message Driven Bean Data (Hourly)
Source dataset opsb_jboss_jarejbmessage
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 624
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_jar_name_id string 255 Name of the deployed jar where the message driven bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 625
AI Operations Management - Containerized 24.4
1.4.2.2.26. opsb_jboss_jarejbstateful
Description JBoss Server Jar EJB Stateful Bean Data
Key columns jboss_srv_instance_name, bean_name, ejb_jar_name, timestamp_utc_s, node_fqdn
Name of the deployed jar where the stateful session bean bean
EJBJARNAME ejb_jar_name string 255
present
STATEFULBEANINVOKE bean_invocations_count integer 24 Number of invocations processed for the stateful bean
STATEFULWAITTIME wait_time_ms integer 24 Time spend waiting to obtain an instance of the stateful bean
STATEFULPEAKCONINVRT peak_concurr_invocation_count_per_s integer 24 Peak concurrent invocations of the statefulbean Per Second
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 626
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 627
AI Operations Management - Containerized 24.4
1.4.2.2.27. opsb_jboss_jarejbstateful_1d
Description JBoss Server Jar EJB Stateful Bean Data (Daily)
Source dataset opsb_jboss_jarejbstateful_1h
Data Aggregation
Column Name Size Description
Type Type
bean_total_avg_count integer 24 average The Average total number of size of Stateful session bean
bean_total_min_count integer 24 min The Minimum total number of size of Stateful session bean
bean_total_max_count integer 24 max The Maximum total number of size of Stateful session bean
bean_cache_avg_count double 24 average The Average cache size of the stateful session bean
bean_cache_min_count double 24 min The Minimum cache size of the stateful session bean
bean_cache_max_count double 24 max The Maximum cache size of the stateful session bean
bean_passivated_avg_count double 24 average The Average passivated count of the stateful session bean
bean_passivated_min_count double 24 min The Minimum passivated count of the stateful session bean
bean_passivated_max_count double 24 max The Maximum passivated count of the stateful session bean
bean_invocations_count integer 24 lastval Number of invocations processed for the stateful bean
bean_invocations_avg_count integer 24 average The Average number of invocations processed for the stateful bean
bean_invocations_min_count integer 24 min The Minimum number of invocations processed for the stateful bean
bean_invocations_max_count integer 24 max The Maximum number of invocations processed for the stateful bean
peak_concurr_invocations_avg_count integer 24 average The Average peak concurrent invocations of the statefulbean
peak_concurr_invocations_min_count integer 24 min The Minimum peak concurrent invocations of the statefulbean
peak_concurr_invocations_max_count integer 24 max The Maximum peak concurrent invocations of the statefulbean
peak_concurr_invocation_avg_count_per_s integer 24 average The Average peak concurrent invocations of the statefulbean Per Second
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 628
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_jar_name_id string 255 Name of the deployed jar where the stateful session bean bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 629
AI Operations Management - Containerized 24.4
1.4.2.2.28. opsb_jboss_jarejbstateful_1h
Description JBoss Server Jar EJB Stateful Bean Data (Hourly)
Source dataset opsb_jboss_jarejbstateful
Data Aggregation
Column Name Size Description
Type Type
bean_total_avg_count integer 24 average The Average total number of size of Stateful session bean
bean_total_min_count integer 24 min The Minimum total number of size of Stateful session bean
bean_total_max_count integer 24 max The Maximum total number of size of Stateful session bean
bean_cache_avg_count double 24 average The Average cache size of the stateful session bean
bean_cache_min_count double 24 min The Minimum cache size of the stateful session bean
bean_cache_max_count double 24 max The Maximum cache size of the stateful session bean
bean_passivated_avg_count double 24 average The Average passivated count of the stateful session bean
bean_passivated_min_count double 24 min The Minimum passivated count of the stateful session bean
bean_passivated_max_count double 24 max The Maximum passivated count of the stateful session bean
bean_invocations_count integer 24 lastval Number of invocations processed for the stateful bean
bean_invocations_avg_count integer 24 average The Average number of invocations processed for the stateful bean
bean_invocations_min_count integer 24 min The Minimum number of invocations processed for the stateful bean
bean_invocations_max_count integer 24 max The Maximum number of invocations processed for the stateful bean
peak_concurr_invocations_avg_count integer 24 average The Average peak concurrent invocations of the statefulbean
peak_concurr_invocations_min_count integer 24 min The Minimum peak concurrent invocations of the statefulbean
peak_concurr_invocations_max_count integer 24 max The Maximum peak concurrent invocations of the statefulbean
peak_concurr_invocation_avg_count_per_s integer 24 average The Average peak concurrent invocations of the statefulbean Per Second
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 630
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
ejb_jar_name_id string 255 Name of the deployed jar where the stateful session bean bean present
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 631
AI Operations Management - Containerized 24.4
1.4.2.2.29. opsb_jboss_jarejbstateles
Description JBoss Server Jar EJB Stateless Bean Data
Key columns jboss_srv_instance_name, bean_name, ejb_name, timestamp_utc_s, node_fqdn
EJBJARNAME ejb_name string 255 Stateless Session Bean Deployed JAR Name
STATELESSAVAILCT available_pool_instance_count integer 24 The number of available (i.e. not in use) instances in the pool
STATELESSCREATECTRT bean_instance_created_count_per_s double 24 he number of bean instances that have been created per second
STATELESSCURSIZE pool_curr_req_count integer 24 The current size of the pool of stateless session bean
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 632
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 633
AI Operations Management - Containerized 24.4
1.4.2.2.30. opsb_jboss_jarejbstateles_1d
Description JBoss Server Jar EJB Stateless Bean Data (Daily)
Source dataset opsb_jboss_jarejbstateles_1h
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average he number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum he number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum he number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
pool_curr_req_count integer 24 lastval The current size of the pool of stateless session bean
pool_curr_req_avg_count integer 24 average The Average current size of the pool of stateless session bean
pool_curr_req_min_count integer 24 min The Minimum current size of the pool of stateless session bean
pool_curr_req_max_count integer 24 max The Maximum current size of the pool of stateless session bean
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 634
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 635
AI Operations Management - Containerized 24.4
1.4.2.2.31. opsb_jboss_jarejbstateles_1h
Description JBoss Server Jar EJB Stateless Bean Data (Hourly)
Source dataset opsb_jboss_jarejbstateles
Data Aggregation
Column Name Size Description
Type Type
available_pool_instance_count integer 24 lastval The number of available (i.e. not in use) instances in the pool
available_pool_instance_avg_count integer 24 average The Average number of available (i.e. not in use) instances in the pool
available_pool_instance_min_count integer 24 min The Minimum number of available (i.e. not in use) instances in the pool
available_pool_instance_max_count integer 24 max The Maximum number of available (i.e. not in use) instances in the pool
The Average he number of bean instances that have been created per
bean_instance_created_avg_count_per_s double 24 average
second
The Minimum he number of bean instances that have been created per
bean_instance_created_min_count_per_s double 24 min
second
The Maximum he number of bean instances that have been created per
bean_instance_created_max_count_per_s double 24 max
second
The Average number of bean instances that have been removed per
bean_instance_removed_avg_count_per_s double 24 average
second
The Minimum number of bean instances that have been removed per
bean_instance_removed_min_count_per_s double 24 min
second
The Maximum number of bean instances that have been removed per
bean_instance_removed_max_count_per_s double 24 max
second
pool_curr_req_count integer 24 lastval The current size of the pool of stateless session bean
pool_curr_req_avg_count integer 24 average The Average current size of the pool of stateless session bean
pool_curr_req_min_count integer 24 min The Minimum current size of the pool of stateless session bean
pool_curr_req_max_count integer 24 max The Maximum current size of the pool of stateless session bean
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 636
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 637
AI Operations Management - Containerized 24.4
1.4.2.2.32. opsb_jboss_jdbc
Description JBoss Server JDBC Data
Key columns jboss_srv_instance_name, jdbc_ds_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
JDBCPRPDSTCACHACCCNT cache_access_count integer 24 The number of times that the statement cache was accessed
JDBCPRPDSTCACHHITCNT cache_hit_count integer 24 The number of times that statements from the cache were used
The number of times that a statement request could not be satisfied with a
JDBCPRPDSTCACHMISCNT cache_miss_count integer 24
statement from the cache
JDBCPRPDSTCACHDELCNT cache_del_count integer 24 The number of statements discarded from the cache
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 638
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 639
AI Operations Management - Containerized 24.4
1.4.2.2.33. opsb_jboss_jdbc_1d
Description JBoss Server JDBC Data (Daily)
Source dataset opsb_jboss_jdbc_1h
Data Aggregation
Column Name Size Description
Type Type
cache_access_count integer 24 lastval The number of times that the statement cache was accessed
cache_access_avg_count integer 24 average The Average number of times that the statement cache was accessed
cache_access_min_count integer 24 min The Minimum number of times that the statement cache was accessed
cache_access_max_count integer 24 max The Maximum number of times that the statement cache was accessed
The number of prepared and callable statements currently cached in the statement
cache_curr_count integer 24 lastval
cache
The Average number of prepared and callable statements currently cached in the
cache_curr_avg_count integer 24 average
statement cache
The Minimum number of prepared and callable statements currently cached in the
cache_curr_min_count integer 24 min
statement cache
The Maximum number of prepared and callable statements currently cached in the
cache_curr_max_count integer 24 max
statement cache
cache_hit_count integer 24 lastval The number of times that statements from the cache were used
cache_hit_avg_count integer 24 average The Average number of times that statements from the cache were used
cache_hit_min_count integer 24 min The Minimum number of times that statements from the cache were used
cache_hit_max_count integer 24 max The Maximum number of times that statements from the cache were used
The number of times that a statement request could not be satisfied with a statement
cache_miss_count integer 24 lastval
from the cache
The Average number of times that a statement request could not be satisfied with a
cache_miss_avg_count integer 24 average
statement from the cache
The Minimum number of times that a statement request could not be satisfied with a
cache_miss_min_count integer 24 min
statement from the cache
The Maximum number of times that a statement request could not be satisfied with a
cache_miss_max_count integer 24 max
statement from the cache
cache_del_count integer 24 lastval The number of statements discarded from the cache
cache_del_avg_count integer 24 average The Average number of statements discarded from the cache
cache_del_min_count integer 24 min The Minimum number of statements discarded from the cache
cache_del_max_count integer 24 max The Maximum number of statements discarded from the cache
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 640
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 641
AI Operations Management - Containerized 24.4
1.4.2.2.34. opsb_jboss_jdbc_1h
Description JBoss Server JDBC Data (Hourly)
Source dataset opsb_jboss_jdbc
Data Aggregation
Column Name Size Description
Type Type
cache_access_count integer 24 lastval The number of times that the statement cache was accessed
cache_access_avg_count integer 24 average The Average number of times that the statement cache was accessed
cache_access_min_count integer 24 min The Minimum number of times that the statement cache was accessed
cache_access_max_count integer 24 max The Maximum number of times that the statement cache was accessed
The number of prepared and callable statements currently cached in the statement
cache_curr_count integer 24 lastval
cache
The Average number of prepared and callable statements currently cached in the
cache_curr_avg_count integer 24 average
statement cache
The Minimum number of prepared and callable statements currently cached in the
cache_curr_min_count integer 24 min
statement cache
The Maximum number of prepared and callable statements currently cached in the
cache_curr_max_count integer 24 max
statement cache
cache_hit_count integer 24 lastval The number of times that statements from the cache were used
cache_hit_avg_count integer 24 average The Average number of times that statements from the cache were used
cache_hit_min_count integer 24 min The Minimum number of times that statements from the cache were used
cache_hit_max_count integer 24 max The Maximum number of times that statements from the cache were used
The number of times that a statement request could not be satisfied with a statement
cache_miss_count integer 24 lastval
from the cache
The Average number of times that a statement request could not be satisfied with a
cache_miss_avg_count integer 24 average
statement from the cache
The Minimum number of times that a statement request could not be satisfied with a
cache_miss_min_count integer 24 min
statement from the cache
The Maximum number of times that a statement request could not be satisfied with a
cache_miss_max_count integer 24 max
statement from the cache
cache_del_count integer 24 lastval The number of statements discarded from the cache
cache_del_avg_count integer 24 average The Average number of statements discarded from the cache
cache_del_min_count integer 24 min The Minimum number of statements discarded from the cache
cache_del_max_count integer 24 max The Maximum number of statements discarded from the cache
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 642
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 643
AI Operations Management - Containerized 24.4
1.4.2.2.35. opsb_jboss_jdbcpool
Description JBoss Server JDBC Pool Data
Key columns jboss_srv_instance_name, jdbc_ds_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
JDBCPOOLINUSECT physical_conn_in_use_count integer 24 The number of physical connections currently in use in datasource
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 644
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 645
AI Operations Management - Containerized 24.4
1.4.2.2.36. opsb_jboss_jdbcpool_1d
Description JBoss Server JDBC Pool Data (Daily)
Source dataset opsb_jboss_jdbcpool
Data Aggregation
Column Name Size Description
Type Type
pool_active_avg_count integer 24 average The Average pool active count of the datasource
pool_active_min_count integer 24 min The Minimum pool active count of the datasource
pool_active_max_count integer 24 max The Maximum pool active count of the datasource
pool_available_avg_count integer 24 average The Average pool available count of the datasource
pool_available_min_count integer 24 min The Minimum pool available count of the datasource
pool_available_max_count integer 24 max The Maximum pool available count of the datasource
pool_created_avg_count integer 24 average The Average pool created count of the datasource
pool_created_min_count integer 24 min The Minimum pool created count of the datasource
pool_created_max_count integer 24 max The Maximum pool created count of the datasource
physical_conn_in_use_count integer 24 lastval The number of physical connections currently in use in datasource
physical_conn_in_use_avg_count integer 24 average The Average number of physical connections currently in use in datasource
physical_conn_in_use_min_count integer 24 min The Minimum number of physical connections currently in use in datasource
physical_conn_in_use_max_count integer 24 max The Maximum number of physical connections currently in use in datasource
max_conn_used_avg_count integer 24 average The Average maximum number of connections used in datasource
max_conn_used_max_count integer 24 max The Maximum maximum number of connections used in datasource
pool_destroyed_avg_count integer 24 average The Average pool The destroyed count in datasource
pool_destroyed_min_count integer 24 min The Minimum pool The destroyed count in datasource
pool_destroyed_max_count integer 24 max The Maximum pool The destroyed count in datasource
physical_conn_in_use_pct double 24 lastval The number of physical connections currently in use in datasource in percentage
The Average this metric monitors the percentage utilization of available JDBC
pool_conn_avg_count_per_s double 24 average
connections in connection pool seconds
The Minimum this metric monitors the percentage utilization of available JDBC
pool_conn_min_count_per_s double 24 min
connections in connection pool seconds
The Maximum this metric monitors the percentage utilization of available JDBC
pool_conn_max_count_per_s double 24 max
connections in connection pool seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 646
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 647
AI Operations Management - Containerized 24.4
1.4.2.2.37. opsb_jboss_jdbcpool_1h
Description JBoss Server JDBC Pool Data (Hourly)
Source dataset opsb_jboss_jdbcpool
Data Aggregation
Column Name Size Description
Type Type
pool_active_avg_count integer 24 average The Average pool active count of the datasource
pool_active_min_count integer 24 min The Minimum pool active count of the datasource
pool_active_max_count integer 24 max The Maximum pool active count of the datasource
pool_available_avg_count integer 24 average The Average pool available count of the datasource
pool_available_min_count integer 24 min The Minimum pool available count of the datasource
pool_available_max_count integer 24 max The Maximum pool available count of the datasource
pool_created_avg_count integer 24 average The Average pool created count of the datasource
pool_created_min_count integer 24 min The Minimum pool created count of the datasource
pool_created_max_count integer 24 max The Maximum pool created count of the datasource
physical_conn_in_use_count integer 24 lastval The number of physical connections currently in use in datasource
physical_conn_in_use_avg_count integer 24 average The Average number of physical connections currently in use in datasource
physical_conn_in_use_min_count integer 24 min The Minimum number of physical connections currently in use in datasource
physical_conn_in_use_max_count integer 24 max The Maximum number of physical connections currently in use in datasource
max_conn_used_avg_count integer 24 average The Average maximum number of connections used in datasource
max_conn_used_max_count integer 24 max The Maximum maximum number of connections used in datasource
pool_destroyed_avg_count integer 24 average The Average pool The destroyed count in datasource
pool_destroyed_min_count integer 24 min The Minimum pool The destroyed count in datasource
pool_destroyed_max_count integer 24 max The Maximum pool The destroyed count in datasource
physical_conn_in_use_pct double 24 lastval The number of physical connections currently in use in datasource in percentage
The Average this metric monitors the percentage utilization of available JDBC
pool_conn_avg_count_per_s double 24 average
connections in connection pool seconds
The Minimum this metric monitors the percentage utilization of available JDBC
pool_conn_min_count_per_s double 24 min
connections in connection pool seconds
The Maximum this metric monitors the percentage utilization of available JDBC
pool_conn_max_count_per_s double 24 max
connections in connection pool seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 648
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 649
AI Operations Management - Containerized 24.4
1.4.2.2.38. opsb_jboss_jmsqueue
Description JBoss Server JMS Queue Data
Key columns jboss_srv_instance_name, jms_que_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
JMSCONSUMERCNT consumer_count integer 24 The number of consumers consuming messages from this queue
JMSMESSAGESADDED que_msgs_added_count integer 24 The number of messages added to this queue since it was created
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 650
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 651
AI Operations Management - Containerized 24.4
1.4.2.2.39. opsb_jboss_jmsqueue_1d
Description JBoss Server JMS Queue Data (Daily)
Source dataset opsb_jboss_jmsqueue_1h
Data Aggregation
Column Name Size Description
Type Type
delivering_msgs_count integer 24 lastval The number of messages that this queue is currently delivering to its consumers
The Average number of messages that this queue is currently delivering to its
delivering_msgs_avg_count integer 24 average
consumers
The Minimum number of messages that this queue is currently delivering to its
delivering_msgs_min_count integer 24 min
consumers
The Maximum number of messages that this queue is currently delivering to its
delivering_msgs_max_count integer 24 max
consumers
scheduled_msgs_avg_count integer 24 average The Average number of scheduled messages in this queue
scheduled_msgs_min_count integer 24 min The Minimum number of scheduled messages in this queue
scheduled_msgs_max_count integer 24 max The Maximum number of scheduled messages in this queue
consumer_count integer 24 lastval The number of consumers consuming messages from this queue
consumer_avg_count integer 24 average The Average number of consumers consuming messages from this queue
consumer_min_count integer 24 min The Minimum number of consumers consuming messages from this queue
consumer_max_count integer 24 max The Maximum number of consumers consuming messages from this queue
que_msg_avg_count integer 24 average The Average number of messages currently in this queue
que_msg_min_count integer 24 min The Minimum number of messages currently in this queue
que_msg_max_count integer 24 max The Maximum number of messages currently in this queue
que_msgs_added_count integer 24 lastval The number of messages added to this queue since it was created
que_msgs_added_avg_count integer 24 average The Average number of messages added to this queue since it was created
que_msgs_added_min_count integer 24 min The Minimum number of messages added to this queue since it was created
que_msgs_added_max_count integer 24 max The Maximum number of messages added to this queue since it was created
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API but
collection_data_flow string 80 lastval
a separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 652
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 653
AI Operations Management - Containerized 24.4
1.4.2.2.40. opsb_jboss_jmsqueue_1h
Description JBoss Server JMS Queue Data (Hourly)
Source dataset opsb_jboss_jmsqueue
Data Aggregation
Column Name Size Description
Type Type
delivering_msgs_count integer 24 lastval The number of messages that this queue is currently delivering to its consumers
The Average number of messages that this queue is currently delivering to its
delivering_msgs_avg_count integer 24 average
consumers
The Minimum number of messages that this queue is currently delivering to its
delivering_msgs_min_count integer 24 min
consumers
The Maximum number of messages that this queue is currently delivering to its
delivering_msgs_max_count integer 24 max
consumers
scheduled_msgs_avg_count integer 24 average The Average number of scheduled messages in this queue
scheduled_msgs_min_count integer 24 min The Minimum number of scheduled messages in this queue
scheduled_msgs_max_count integer 24 max The Maximum number of scheduled messages in this queue
consumer_count integer 24 lastval The number of consumers consuming messages from this queue
consumer_avg_count integer 24 average The Average number of consumers consuming messages from this queue
consumer_min_count integer 24 min The Minimum number of consumers consuming messages from this queue
consumer_max_count integer 24 max The Maximum number of consumers consuming messages from this queue
que_msg_avg_count integer 24 average The Average number of messages currently in this queue
que_msg_min_count integer 24 min The Minimum number of messages currently in this queue
que_msg_max_count integer 24 max The Maximum number of messages currently in this queue
que_msgs_added_count integer 24 lastval The number of messages added to this queue since it was created
que_msgs_added_avg_count integer 24 average The Average number of messages added to this queue since it was created
que_msgs_added_min_count integer 24 min The Minimum number of messages added to this queue since it was created
que_msgs_added_max_count integer 24 max The Maximum number of messages added to this queue since it was created
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API but
collection_data_flow string 80 lastval
a separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 654
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 655
AI Operations Management - Containerized 24.4
1.4.2.2.41. opsb_jboss_jmstopic
Description JBoss Server JMS Topic Data
Key columns jboss_srv_instance_name, jms_topic_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
JMSDURABLEMSGCNT durable_msgs_count integer 24 The number of messages for all durable subscribers for this topic
JMSDURABLESUBSCNT durable_subscription_count integer 24 The number of durable subscribers for this topic
JMSMESSAGESADDED que_msgs_added_count integer 24 The number of messages added to this queue since it was created
JMSNONDURABLESUBSCNT non_durable_subscription_count integer 24 The number of non-durable subscribers for this topic
JMSSUBSCRIPTIONCNT subscribers_count integer 24 The number of (durable and non-durable) subscribers for this topic
JMSDURABLEMSGPCT durable_msg_pct double 24 The percentage of messages for all durable subscribers for this topic
JMSNONDURABLEMSGPCT non_durable_msg_pct double 24 The number of messages for all non-durable subscribers for this topic
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed.
For Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 656
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 657
AI Operations Management - Containerized 24.4
1.4.2.2.42. opsb_jboss_jmstopic_1d
Description JBoss Server JMS Topic Data (Daily)
Source dataset opsb_jboss_jmstopic
Data Aggregation
Column Name Size Description
Type Type
The Average number of messages that this queue is currently delivering to its
delivering_msgs_avg_count integer 24 average
consumers
durable_msgs_count integer 24 lastval The number of messages for all durable subscribers for this topic
durable_msgs_avg_count integer 24 average The Average number of messages for all durable subscribers for this topic
durable_msgs_min_count integer 24 min The Minimum number of messages for all durable subscribers for this topic
durable_msgs_max_count integer 24 max The Maximum number of messages for all durable subscribers for this topic
durable_subscription_count integer 24 lastval The number of durable subscribers for this topic
durable_subscription_avg_count integer 24 average The Average number of durable subscribers for this topic
durable_subscription_min_count integer 24 min The Minimum number of durable subscribers for this topic
durable_subscription_max_count integer 24 max The Maximum number of durable subscribers for this topic
que_msg_avg_count integer 24 average The Average number of messages currently in this queue
que_msg_min_count integer 24 min The Minimum number of messages currently in this queue
que_msg_max_count integer 24 max The Maximum number of messages currently in this queue
que_msgs_added_count integer 24 lastval The number of messages added to this queue since it was created
que_msgs_added_avg_count integer 24 average The Average number of messages added to this queue since it was created
que_msgs_added_min_count integer 24 min The Minimum number of messages added to this queue since it was created
que_msgs_added_max_count integer 24 max The Maximum number of messages added to this queue since it was created
non_durable_msg_count integer 24 lastval The percentage of messages for all non-durable subscribers for this topic
The Average percentage of messages for all non-durable subscribers for this
non_durable_msg_avg_count integer 24 average
topic
The Minimum percentage of messages for all non-durable subscribers for this
non_durable_msg_min_count integer 24 min
topic
The Maximum percentage of messages for all non-durable subscribers for this
non_durable_msg_max_count integer 24 max
topic
non_durable_subscription_count integer 24 lastval The number of non-durable subscribers for this topic
non_durable_subscription_avg_count integer 24 average The Average number of non-durable subscribers for this topic
non_durable_subscription_min_count integer 24 min The Minimum number of non-durable subscribers for this topic
non_durable_subscription_max_count integer 24 max The Maximum number of non-durable subscribers for this topic
subscribers_count integer 24 lastval The number of (durable and non-durable) subscribers for this topic
subscribers_avg_count integer 24 average The Average number of (durable and non-durable) subscribers for this topic
subscribers_min_count integer 24 min The Minimum number of (durable and non-durable) subscribers for this topic
subscribers_max_count integer 24 max The Maximum number of (durable and non-durable) subscribers for this topic
durable_msg_pct double 24 lastval The percentage of messages for all durable subscribers for this topic
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 658
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
durable_msg_avg_pct double 24 average The Average percentage of messages for all durable subscribers for this topic
durable_msg_min_pct double 24 min The Minimum percentage of messages for all durable subscribers for this topic
The Maximum percentage of messages for all durable subscribers for this
durable_msg_max_pct double 24 max
topic
The Percentile of the percentage of messages for all durable subscribers for
durable_msg_pctl_pct double 24 90 percentile
this topic
non_durable_msg_pct double 24 lastval The number of messages for all non-durable subscribers for this topic
non_durable_msg_avg_pct double 24 average The Average number of messages for all non-durable subscribers for this topic
The Minimum number of messages for all non-durable subscribers for this
non_durable_msg_min_pct double 24 min
topic
The Maximum number of messages for all non-durable subscribers for this
non_durable_msg_max_pct double 24 max
topic
The Percentile of the number of messages for all non-durable subscribers for
non_durable_msg_pctl_pct double 24 90 percentile
this topic
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and
scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 659
AI Operations Management - Containerized 24.4
1.4.2.2.43. opsb_jboss_jmstopic_1h
Description JBoss Server JMS Topic Data (Hourly)
Source dataset opsb_jboss_jmstopic
Data Aggregation
Column Name Size Description
Type Type
The Average number of messages that this queue is currently delivering to its
delivering_msgs_avg_count integer 24 average
consumers
durable_msgs_count integer 24 lastval The number of messages for all durable subscribers for this topic
durable_msgs_avg_count integer 24 average The Average number of messages for all durable subscribers for this topic
durable_msgs_min_count integer 24 min The Minimum number of messages for all durable subscribers for this topic
durable_msgs_max_count integer 24 max The Maximum number of messages for all durable subscribers for this topic
durable_subscription_count integer 24 lastval The number of durable subscribers for this topic
durable_subscription_avg_count integer 24 average The Average number of durable subscribers for this topic
durable_subscription_min_count integer 24 min The Minimum number of durable subscribers for this topic
durable_subscription_max_count integer 24 max The Maximum number of durable subscribers for this topic
que_msg_avg_count integer 24 average The Average number of messages currently in this queue
que_msg_min_count integer 24 min The Minimum number of messages currently in this queue
que_msg_max_count integer 24 max The Maximum number of messages currently in this queue
que_msgs_added_count integer 24 lastval The number of messages added to this queue since it was created
que_msgs_added_avg_count integer 24 average The Average number of messages added to this queue since it was created
que_msgs_added_min_count integer 24 min The Minimum number of messages added to this queue since it was created
que_msgs_added_max_count integer 24 max The Maximum number of messages added to this queue since it was created
non_durable_msg_count integer 24 lastval The percentage of messages for all non-durable subscribers for this topic
The Average percentage of messages for all non-durable subscribers for this
non_durable_msg_avg_count integer 24 average
topic
The Minimum percentage of messages for all non-durable subscribers for this
non_durable_msg_min_count integer 24 min
topic
The Maximum percentage of messages for all non-durable subscribers for this
non_durable_msg_max_count integer 24 max
topic
non_durable_subscription_count integer 24 lastval The number of non-durable subscribers for this topic
non_durable_subscription_avg_count integer 24 average The Average number of non-durable subscribers for this topic
non_durable_subscription_min_count integer 24 min The Minimum number of non-durable subscribers for this topic
non_durable_subscription_max_count integer 24 max The Maximum number of non-durable subscribers for this topic
subscribers_count integer 24 lastval The number of (durable and non-durable) subscribers for this topic
subscribers_avg_count integer 24 average The Average number of (durable and non-durable) subscribers for this topic
subscribers_min_count integer 24 min The Minimum number of (durable and non-durable) subscribers for this topic
subscribers_max_count integer 24 max The Maximum number of (durable and non-durable) subscribers for this topic
durable_msg_pct double 24 lastval The percentage of messages for all durable subscribers for this topic
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 660
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
durable_msg_avg_pct double 24 average The Average percentage of messages for all durable subscribers for this topic
durable_msg_min_pct double 24 min The Minimum percentage of messages for all durable subscribers for this topic
The Maximum percentage of messages for all durable subscribers for this
durable_msg_max_pct double 24 max
topic
The Percentile of the percentage of messages for all durable subscribers for
durable_msg_pctl_pct double 24 90 percentile
this topic
non_durable_msg_pct double 24 lastval The number of messages for all non-durable subscribers for this topic
non_durable_msg_avg_pct double 24 average The Average number of messages for all non-durable subscribers for this topic
The Minimum number of messages for all non-durable subscribers for this
non_durable_msg_min_pct double 24 min
topic
The Maximum number of messages for all non-durable subscribers for this
non_durable_msg_max_pct double 24 max
topic
The Percentile of the number of messages for all non-durable subscribers for
non_durable_msg_pctl_pct double 24 90 percentile
this topic
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and
scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 661
AI Operations Management - Containerized 24.4
1.4.2.2.44. opsb_jboss_jvm
Description JBoss Server JVM Data
Key columns jboss_srv_instance_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
The current memory usage of the heap that is used for object allocation in
HEAPMEMUTILPCT heap_mem_usage_pct double
percent
The current memory usage of non-heap memory that is used by the Java
NONHEAPMEMUTILPCT non_heap_mem_usage_pct double
virtual machine by percent
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data
collection_data_flow collection_data_flow string 80
through an API but a separate collection process does a periodic and
scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 662
AI Operations Management - Containerized 24.4
1.4.2.2.45. opsb_jboss_jvm_1d
Description JBoss Server JVM Data (Daily)
Source dataset opsb_jboss_jvm
Data Aggregation
Column Name Size Description
Type Type
heap_mem_usage_pct double lastval The current memory usage of the heap that is used for object allocation in percent
The Average current memory usage of the heap that is used for object allocation in
heap_mem_usage_avg_pct double average
percent
The Minimum current memory usage of the heap that is used for object allocation
heap_mem_usage_min_pct double min
in percent
The Maximum current memory usage of the heap that is used for object allocation
heap_mem_usage_max_pct double max
in percent
The Percentile of the current memory usage of the heap that is used for object
heap_mem_usage_pctl_pct double 90 percentile
allocation in percent
The current memory usage of non-heap memory that is used by the Java virtual
non_heap_mem_usage_pct double lastval
machine by percent
The Average current memory usage of non-heap memory that is used by the Java
non_heap_mem_usage_avg_pct double average
virtual machine by percent
The Minimum current memory usage of non-heap memory that is used by the Java
non_heap_mem_usage_min_pct double min
virtual machine by percent
The Maximum current memory usage of non-heap memory that is used by the Java
non_heap_mem_usage_max_pct double max
virtual machine by percent
The Percentile of the current memory usage of non-heap memory that is used by
non_heap_mem_usage_pctl_pct double 90 percentile
the Java virtual machine by percent
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 663
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 664
AI Operations Management - Containerized 24.4
1.4.2.2.46. opsb_jboss_jvm_1h
Description JBoss Server JVM Data (Hourly)
Source dataset opsb_jboss_jvm
Data Aggregation
Column Name Size Description
Type Type
heap_mem_usage_pct double lastval The current memory usage of the heap that is used for object allocation in percent
The Average current memory usage of the heap that is used for object allocation in
heap_mem_usage_avg_pct double average
percent
The Minimum current memory usage of the heap that is used for object allocation
heap_mem_usage_min_pct double min
in percent
The Maximum current memory usage of the heap that is used for object allocation
heap_mem_usage_max_pct double max
in percent
The Percentile of the current memory usage of the heap that is used for object
heap_mem_usage_pctl_pct double 90 percentile
allocation in percent
The current memory usage of non-heap memory that is used by the Java virtual
non_heap_mem_usage_pct double lastval
machine by percent
The Average current memory usage of non-heap memory that is used by the Java
non_heap_mem_usage_avg_pct double average
virtual machine by percent
The Minimum current memory usage of non-heap memory that is used by the Java
non_heap_mem_usage_min_pct double min
virtual machine by percent
The Maximum current memory usage of non-heap memory that is used by the Java
non_heap_mem_usage_max_pct double max
virtual machine by percent
The Percentile of the current memory usage of non-heap memory that is used by
non_heap_mem_usage_pctl_pct double 90 percentile
the Java virtual machine by percent
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 665
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 666
AI Operations Management - Containerized 24.4
1.4.2.2.47. opsb_jboss_transactions
Description JBoss Server Transactions Data
Key columns jboss_srv_instance_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
TRANSACTIONSABORTED aborted_txn_count integer 24 The number of aborted (i.e. rolled back) transactions.
TRANHEURISTICS heuristics_count integer 24 The number of transactions which have terminated with heuristic outcomes
TRANSACTIONSNESTED nested_txns_count integer 24 The total number of nested (sub) transactions created
TRANTIMEDOUT timed_out_txns_count integer 24 The number of transactions that have rolled back due to timeout
TRANSACTIONSTOTAL txns_created_count integer 24 The total number of transactions (top-level and nested) created
TRANTIMEDOUTPCT timed_out_txns_pct double 24 The percent of transactions that have rolled back due to timeout
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 667
AI Operations Management - Containerized 24.4
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 668
AI Operations Management - Containerized 24.4
1.4.2.2.48. opsb_jboss_transactions_1d
Description JBoss Server Transactions Data (Daily)
Source dataset opsb_jboss_transactions
Data Aggregation
Column Name Size Description
Type Type
aborted_txn_count integer 24 lastval The number of aborted (i.e. rolled back) transactions.
aborted_txn_avg_count integer 24 average The Average number of aborted (i.e. rolled back) transactions.
aborted_txn_min_count integer 24 min The Minimum number of aborted (i.e. rolled back) transactions.
aborted_txn_max_count integer 24 max The Maximum number of aborted (i.e. rolled back) transactions.
The number of transactions that have been rolled back by application request. This
app_rollbacks_count integer 24 lastval includes those that timeout, since the timeout behaviour is considered an attribute of
the application configuration
The Average number of transactions that have been rolled back by application
app_rollbacks_avg_count integer 24 average request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Minimum number of transactions that have been rolled back by application
app_rollbacks_min_count integer 24 min request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Maximum number of transactions that have been rolled back by application
app_rollbacks_max_count integer 24 max request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
heuristics_count integer 24 lastval The number of transactions which have terminated with heuristic outcomes
heuristics_avg_count integer 24 average The Average number of transactions which have terminated with heuristic outcomes
heuristics_min_count integer 24 min The Minimum number of transactions which have terminated with heuristic outcomes
nested_txns_count integer 24 lastval The total number of nested (sub) transactions created
nested_txns_avg_count integer 24 average The Average total number of nested (sub) transactions created
nested_txns_min_count integer 24 min The Minimum total number of nested (sub) transactions created
nested_txns_max_count integer 24 max The Maximum total number of nested (sub) transactions created
resource_rollbacks_count integer 24 lastval The number of transactions that rolled back due to resource (participant) failure
The Average number of transactions that rolled back due to resource (participant)
resource_rollbacks_avg_count integer 24 average
failure
The Minimum number of transactions that rolled back due to resource (participant)
resource_rollbacks_min_count integer 24 min
failure
The Maximum number of transactions that rolled back due to resource (participant)
resource_rollbacks_max_count integer 24 max
failure
timed_out_txns_count integer 24 lastval The number of transactions that have rolled back due to timeout
timed_out_txns_avg_count integer 24 average The Average number of transactions that have rolled back due to timeout
timed_out_txns_min_count integer 24 min The Minimum number of transactions that have rolled back due to timeout
timed_out_txns_max_count integer 24 max The Maximum number of transactions that have rolled back due to timeout
txns_created_count integer 24 lastval The total number of transactions (top-level and nested) created
txns_created_avg_count integer 24 average The Average total number of transactions (top-level and nested) created
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 669
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
txns_created_min_count integer 24 min The Minimum total number of transactions (top-level and nested) created
txns_created_max_count integer 24 max The Maximum total number of transactions (top-level and nested) created
resource_rollbacks_pct double 24 lastval The percent of transactions that rolled back due to resource (participant) failure
The Average percent of transactions that rolled back due to resource (participant)
resource_rollbacks_avg_pct double 24 average
failure
The Minimum percent of transactions that rolled back due to resource (participant)
resource_rollbacks_min_pct double 24 min
failure
The Maximum percent of transactions that rolled back due to resource (participant)
resource_rollbacks_max_pct double 24 max
failure
The Percentile of the percent of transactions that rolled back due to resource
resource_rollbacks_pctl_pct double 24 90 percentile
(participant) failure
The percent of transactions that have been rolled back by application request. This
app_rollbacks_pct double 24 lastval includes those that timeout, since the timeout behaviour is considered an attribute of
the application configuration
The Average percent of transactions that have been rolled back by application
app_rollbacks_avg_pct double 24 average request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Minimum percent of transactions that have been rolled back by application
app_rollbacks_min_pct double 24 min request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Maximum percent of transactions that have been rolled back by application
app_rollbacks_max_pct double 24 max request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Percentile of the percent of transactions that have been rolled back by
app_rollbacks_pctl_pct double 24 90 percentile application request. This includes those that timeout, since the timeout behaviour is
considered an attribute of the application configuration
timed_out_txns_pct double 24 lastval The percent of transactions that have rolled back due to timeout
timed_out_txns_avg_pct double 24 average The Average percent of transactions that have rolled back due to timeout
timed_out_txns_min_pct double 24 min The Minimum percent of transactions that have rolled back due to timeout
timed_out_txns_max_pct double 24 max The Maximum percent of transactions that have rolled back due to timeout
timed_out_txns_pctl_pct double 24 90 percentile The Percentile of the percent of transactions that have rolled back due to timeout
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 670
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 671
AI Operations Management - Containerized 24.4
1.4.2.2.49. opsb_jboss_transactions_1h
Description JBoss Server Transactions Data (Hourly)
Source dataset opsb_jboss_transactions
Data Aggregation
Column Name Size Description
Type Type
aborted_txn_count integer 24 lastval The number of aborted (i.e. rolled back) transactions.
aborted_txn_avg_count integer 24 average The Average number of aborted (i.e. rolled back) transactions.
aborted_txn_min_count integer 24 min The Minimum number of aborted (i.e. rolled back) transactions.
aborted_txn_max_count integer 24 max The Maximum number of aborted (i.e. rolled back) transactions.
The number of transactions that have been rolled back by application request. This
app_rollbacks_count integer 24 lastval includes those that timeout, since the timeout behaviour is considered an attribute of
the application configuration
The Average number of transactions that have been rolled back by application
app_rollbacks_avg_count integer 24 average request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Minimum number of transactions that have been rolled back by application
app_rollbacks_min_count integer 24 min request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Maximum number of transactions that have been rolled back by application
app_rollbacks_max_count integer 24 max request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
heuristics_count integer 24 lastval The number of transactions which have terminated with heuristic outcomes
heuristics_avg_count integer 24 average The Average number of transactions which have terminated with heuristic outcomes
heuristics_min_count integer 24 min The Minimum number of transactions which have terminated with heuristic outcomes
nested_txns_count integer 24 lastval The total number of nested (sub) transactions created
nested_txns_avg_count integer 24 average The Average total number of nested (sub) transactions created
nested_txns_min_count integer 24 min The Minimum total number of nested (sub) transactions created
nested_txns_max_count integer 24 max The Maximum total number of nested (sub) transactions created
resource_rollbacks_count integer 24 lastval The number of transactions that rolled back due to resource (participant) failure
The Average number of transactions that rolled back due to resource (participant)
resource_rollbacks_avg_count integer 24 average
failure
The Minimum number of transactions that rolled back due to resource (participant)
resource_rollbacks_min_count integer 24 min
failure
The Maximum number of transactions that rolled back due to resource (participant)
resource_rollbacks_max_count integer 24 max
failure
timed_out_txns_count integer 24 lastval The number of transactions that have rolled back due to timeout
timed_out_txns_avg_count integer 24 average The Average number of transactions that have rolled back due to timeout
timed_out_txns_min_count integer 24 min The Minimum number of transactions that have rolled back due to timeout
timed_out_txns_max_count integer 24 max The Maximum number of transactions that have rolled back due to timeout
txns_created_count integer 24 lastval The total number of transactions (top-level and nested) created
txns_created_avg_count integer 24 average The Average total number of transactions (top-level and nested) created
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 672
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
txns_created_min_count integer 24 min The Minimum total number of transactions (top-level and nested) created
txns_created_max_count integer 24 max The Maximum total number of transactions (top-level and nested) created
resource_rollbacks_pct double 24 lastval The percent of transactions that rolled back due to resource (participant) failure
The Average percent of transactions that rolled back due to resource (participant)
resource_rollbacks_avg_pct double 24 average
failure
The Minimum percent of transactions that rolled back due to resource (participant)
resource_rollbacks_min_pct double 24 min
failure
The Maximum percent of transactions that rolled back due to resource (participant)
resource_rollbacks_max_pct double 24 max
failure
The Percentile of the percent of transactions that rolled back due to resource
resource_rollbacks_pctl_pct double 24 90 percentile
(participant) failure
The percent of transactions that have been rolled back by application request. This
app_rollbacks_pct double 24 lastval includes those that timeout, since the timeout behaviour is considered an attribute of
the application configuration
The Average percent of transactions that have been rolled back by application
app_rollbacks_avg_pct double 24 average request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Minimum percent of transactions that have been rolled back by application
app_rollbacks_min_pct double 24 min request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Maximum percent of transactions that have been rolled back by application
app_rollbacks_max_pct double 24 max request. This includes those that timeout, since the timeout behaviour is considered
an attribute of the application configuration
The Percentile of the percent of transactions that have been rolled back by
app_rollbacks_pctl_pct double 24 90 percentile application request. This includes those that timeout, since the timeout behaviour is
considered an attribute of the application configuration
timed_out_txns_pct double 24 lastval The percent of transactions that have rolled back due to timeout
timed_out_txns_avg_pct double 24 average The Average percent of transactions that have rolled back due to timeout
timed_out_txns_min_pct double 24 min The Minimum percent of transactions that have rolled back due to timeout
timed_out_txns_max_pct double 24 max The Maximum percent of transactions that have rolled back due to timeout
timed_out_txns_pctl_pct double 24 90 percentile The Percentile of the percent of transactions that have rolled back due to timeout
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 673
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 674
AI Operations Management - Containerized 24.4
1.4.2.2.50. opsb_jboss_webapp
Description JBoss Server Web Application Data
Key columns jboss_srv_instance_name, web_app_war_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
WEBAPPWARNAME web_app_war_name string 255 Name of the web application deployment war file
AVGALIVETIME session_avg_alive_time_s double 24 Average time (in seconds) that expired sessions had been alive
MAXALIVETIME session_max_alive_time_s double 24 The longest time (in seconds) that an expired session had been alive
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 675
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 676
AI Operations Management - Containerized 24.4
1.4.2.2.51. opsb_jboss_webapp_1d
Description JBoss Server Web Application Data (Daily)
Source dataset opsb_jboss_webapp_1h
Data Aggregation
Column Name Size Description
Type Type
expired_sessions_avg_count integer 24 average The Average number of sessions that have expired
expired_sessions_min_count integer 24 min The Minimum number of sessions that have expired
expired_sessions_max_count integer 24 max The Maximum number of sessions that have expired
session_avg_alive_time_avg_s average The Average average time (in seconds) that expired sessions had been alive
session_avg_alive_time_min_s min The Minimum average time (in seconds) that expired sessions had been alive
session_avg_alive_time_max_s max The Maximum average time (in seconds) that expired sessions had been alive
session_max_alive_time_avg_s average The Average longest time (in seconds) that an expired session had been alive
session_max_alive_time_min_s min The Minimum longest time (in seconds) that an expired session had been alive
session_max_alive_time_max_s max The Maximum longest time (in seconds) that an expired session had been alive
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 677
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
web_app_war_name_id string 255 Name of the web application deployment war file
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 678
AI Operations Management - Containerized 24.4
1.4.2.2.52. opsb_jboss_webapp_1h
Description JBoss Server Web Application Data (Hourly)
Source dataset opsb_jboss_webapp
Data Aggregation
Column Name Size Description
Type Type
expired_sessions_avg_count integer 24 average The Average number of sessions that have expired
expired_sessions_min_count integer 24 min The Minimum number of sessions that have expired
expired_sessions_max_count integer 24 max The Maximum number of sessions that have expired
session_avg_alive_time_avg_s double 24 average The Average average time (in seconds) that expired sessions had been alive
session_avg_alive_time_min_s double 24 min The Minimum average time (in seconds) that expired sessions had been alive
session_avg_alive_time_max_s double 24 max The Maximum average time (in seconds) that expired sessions had been alive
session_max_alive_time_avg_s double 24 average The Average longest time (in seconds) that an expired session had been alive
session_max_alive_time_min_s double 24 min The Minimum longest time (in seconds) that an expired session had been alive
session_max_alive_time_max_s double 24 max The Maximum longest time (in seconds) that an expired session had been alive
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 679
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
web_app_war_name_id string 255 Name of the web application deployment war file
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 680
AI Operations Management - Containerized 24.4
1.4.2.2.53. opsb_jboss_webconhttp
Description JBoss Server Http Connetor Data
Key columns jboss_srv_instance_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
SERVLETREQUESTCOUNT req_count integer 24 The number of requests this listener has served
ERRORCOUNT err_count integer 24 The number of 500 responses that have been sent by this listener
PROCESSINGTIME processing_time_s double 24 The total processing time of all requests handed by this listener
BYTESSENT sent_bytes_count double 24 The number of bytes that have been sent out on this listener
BYTESRECEIVED recvd_bytes_count double 24 The number of bytes that have been received by this listener
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC-DL. Pull:Data producer provides data through
collection_data_flow collection_data_flow string 80
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 681
AI Operations Management - Containerized 24.4
1.4.2.2.54. opsb_jboss_webconhttp_1d
Description JBoss Server Http Connetor Data (Daily)
Source dataset opsb_jboss_webconhttp_1h
Data Aggregation
Column Name Size Description
Type Type
req_count integer 24 lastval The number of requests this listener has served
req_avg_count integer 24 average The Average number of requests this listener has served
req_min_count integer 24 min The Minimum number of requests this listener has served
req_max_count integer 24 max The Maximum number of requests this listener has served
err_count integer 24 lastval The number of 500 responses that have been sent by this listener
err_avg_count integer 24 average The Average number of 500 responses that have been sent by this listener
err_min_count integer 24 min The Minimum number of 500 responses that have been sent by this listener
err_max_count integer 24 max The Maximum number of 500 responses that have been sent by this listener
processing_time_avg_s double 24 average The Average total processing time of all requests handed by this listener
processing_time_min_s double 24 min The Minimum total processing time of all requests handed by this listener
processing_time_max_s double 24 max The Maximum total processing time of all requests handed by this listener
sent_bytes_count double 24 lastval The number of bytes that have been sent out on this listener
sent_bytes_avg_count double 24 average The Average number of bytes that have been sent out on this listener
sent_bytes_min_count double 24 min The Minimum number of bytes that have been sent out on this listener
sent_bytes_max_count double 24 max The Maximum number of bytes that have been sent out on this listener
recvd_bytes_count double 24 lastval The number of bytes that have been received by this listener
recvd_bytes_avg_count double 24 average The Average number of bytes that have been received by this listener
recvd_bytes_min_count double 24 min The Minimum number of bytes that have been received by this listener
recvd_bytes_max_count double 24 max The Maximum number of bytes that have been received by this listener
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 682
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 683
AI Operations Management - Containerized 24.4
1.4.2.2.55. opsb_jboss_webconhttp_1h
Description JBoss Server Http Connetor Data (Hourly)
Source dataset opsb_jboss_webconhttp
Data Aggregation
Column Name Size Description
Type Type
req_count integer 24 lastval The number of requests this listener has served
req_avg_count integer 24 average The Average number of requests this listener has served
req_min_count integer 24 min The Minimum number of requests this listener has served
req_max_count integer 24 max The Maximum number of requests this listener has served
err_count integer 24 lastval The number of 500 responses that have been sent by this listener
err_avg_count integer 24 average The Average number of 500 responses that have been sent by this listener
err_min_count integer 24 min The Minimum number of 500 responses that have been sent by this listener
err_max_count integer 24 max The Maximum number of 500 responses that have been sent by this listener
processing_time_avg_s double 24 average The Average total processing time of all requests handed by this listener
processing_time_min_s double 24 min The Minimum total processing time of all requests handed by this listener
processing_time_max_s double 24 max The Maximum total processing time of all requests handed by this listener
sent_bytes_count double 24 lastval The number of bytes that have been sent out on this listener
sent_bytes_avg_count double 24 average The Average number of bytes that have been sent out on this listener
sent_bytes_min_count double 24 min The Minimum number of bytes that have been sent out on this listener
sent_bytes_max_count double 24 max The Maximum number of bytes that have been sent out on this listener
recvd_bytes_count double 24 lastval The number of bytes that have been received by this listener
recvd_bytes_avg_count double 24 average The Average number of bytes that have been received by this listener
recvd_bytes_min_count double 24 min The Minimum number of bytes that have been received by this listener
recvd_bytes_max_count double 24 max The Maximum number of bytes that have been received by this listener
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 684
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 685
AI Operations Management - Containerized 24.4
1.4.2.2.56. opsb_jboss_webservlet
Description JBoss Server web Servlet Data
Key columns jboss_srv_instance_name, servlet_name, web_app_war_name, timestamp_utc_s, node_fqdn
JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified
WEBAPPWARNAME web_app_war_name string 255 Name of the deployable war file where the servlet present
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 686
AI Operations Management - Containerized 24.4
1.4.2.2.57. opsb_jboss_webservlet_1d
Description JBoss Server web Servlet Data (Daily)
Source dataset opsb_jboss_webservlet_1h
Data Aggregation
Column Name Size Description
Type Type
max_req_processing_time_avg_ms double 24 average The Average maximal time for processing request
max_req_processing_time_min_ms double 24 min The Minimum maximal time for processing request
max_req_processing_time_max_ms double 24 max The Maximum maximal time for processing request
min_req_processing_time_avg_ms double 24 average The Average minimal time for processing request
min_req_processing_time_min_ms double 24 min The Minimum minimal time for processing request
min_req_processing_time_max_ms double 24 max The Maximum minimal time for processing request
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 687
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
web_app_war_name_id string 255 Name of the deployable war file where the servlet present
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 688
AI Operations Management - Containerized 24.4
1.4.2.2.58. opsb_jboss_webservlet_1h
Description JBoss Server web Servlet Data (Hourly)
Source dataset opsb_jboss_webservlet
Data Aggregation
Column Name Size Description
Type Type
max_req_processing_time_avg_ms double 24 average The Average maximal time for processing request
max_req_processing_time_min_ms double 24 min The Minimum maximal time for processing request
max_req_processing_time_max_ms double 24 max The Maximum maximal time for processing request
min_req_processing_time_avg_ms double 24 average The Average minimal time for processing request
min_req_processing_time_min_ms double 24 min The Minimum minimal time for processing request
min_req_processing_time_max_ms double 24 max The Maximum minimal time for processing request
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
jboss_srv_instance_name_id string 255 JBOSS instance with server host, server port are uniquely identified
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 689
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
web_app_war_name_id string 255 Name of the deployable war file where the servlet present
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 690
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 691
AI Operations Management - Containerized 24.4
1.4.2.3.1. opsb_ad_availability
Description AD Availability Data
Key columns ad_server_fqdn, dc_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 692
AI Operations Management - Containerized 24.4
1.4.2.3.2. opsb_ad_availability_1d
Description AD Availability Data (Daily)
Source dataset opsb_ad_availability_1h
Data Aggregation
Column Name Size Description
Type Type
dc_uptime_min double sum The time duration (in minutes) in an hour when the DC is available.
dc_uptime_avg_pct double avg The Average percentage of time in an hour when the DC is available.
dc_downtime_min double sum The time duration (in minutes) in an hour when the DC is unavailable.
dc_downtime_avg_pct double avg The Average percentage of time in an hour when the DC is unavailable.
The time duration (in minutes) in an hour when the DC is unavailable due to server
dc_planned_downtime_min double sum
planned outage.
The Average percentage of time in an hour when the DC is unavailable due to server
dc_planned_downtime_avg_pct double avg
planned outage.
The time duration (in minutes) in an hour when the DC is unavailable due to
dc_unknown_time_min double sum
unknown outage.
gc_uptime_min double sum The time duration (in minutes) in an hour when the Global Catalog is available.
gc_uptime_avg_pct double avg The Average percentage of time in an hour when the Global Catalog is available.
gc_downtime_min double sum The time duration (in minutes) in an hour when the Global Catalog is unavailable.
gc_downtime_avg_pct double avg The Average percentage of time in an hour when the Global Catalog is unavailable.
The time duration (in minutes) in an hour when the Global Catalog is unavailable
gc_planned_downtime_min double sum
due to server planned outage.
The Average percentage of time in an hour when the Global Catalog is unavailable
gc_planned_downtime_avg_pct double avg
due to server planned outage.
The time duration (in minutes) in an hour when the Global Catalog availablity is
gc_unknown_time_min double sum
unknown due to unknown outage.
The Average percentage of time in an hour when the Global Catalog availablity is
gc_unknown_time_avg_pct double avg
unknown due to unknown outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 693
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 694
AI Operations Management - Containerized 24.4
1.4.2.3.3. opsb_ad_availability_1h
Description AD Availability Data
Key columns ad_server_fqdn, dc_name, timestamp_utc_s, node_fqdn
null dc_uptime_min double The time duration (in minutes) in an hour when the DC is available.
null dc_uptime_pct double The percentage of time in an hour when the DC is available.
null dc_downtime_min double The time duration (in minutes) in an hour when the DC is unavailable.
null dc_downtime_pct double The percentage of time in an hour when the DC is unavailable.
The time duration (in minutes) in an hour when the Global Catalog is
null gc_uptime_min double
available.
null gc_uptime_pct double The percentage of time in an hour when the Global Catalog is available.
The time duration (in minutes) in an hour when the Global Catalog is
null gc_downtime_min double
unavailable.
The time duration (in minutes) in an hour when the Global Catalog is
null gc_planned_downtime_min double
unavailable due to server planned outage.
The time duration (in minutes) in an hour when the Global Catalog
null gc_unknown_time_min double
availablity is unknown due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 695
AI Operations Management - Containerized 24.4
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 696
AI Operations Management - Containerized 24.4
1.4.2.3.4. opsb_ad_database_cache
Description AD Database Cache Data
Key columns ad_server_fqdn, lsass_instance_name, timestamp_utc_s, node_fqdn
The percentage of database file page requests that were fulfilled by the
DATABASECACHE db_cache_hit_pct integer 24
database cache without causing a file operation
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 697
AI Operations Management - Containerized 24.4
1.4.2.3.5. opsb_ad_database_cache_1d
Description AD Data (Daily)base Cache Data (Daily)
Source dataset opsb_ad_database_cache
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of database file page requests that were fulfilled by the database
db_cache_hit_avg_pct integer 24 average
cache without causing a file operation
The Minimum percentage of database file page requests that were fulfilled by the database
db_cache_hit_min_pct integer 24 min
cache without causing a file operation
The Maximum percentage of database file page requests that were fulfilled by the database
db_cache_hit_max_pct integer 24 max
cache without causing a file operation
The Percentile of the percentage of database file page requests that were fulfilled by the
db_cache_hit_pctl_pct integer 24 10 percentile
database cache without causing a file operation
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 698
AI Operations Management - Containerized 24.4
1.4.2.3.6. opsb_ad_database_cache_1h
Description AD Data (Hourly)base Cache Data (Hourly)
Source dataset opsb_ad_database_cache
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of database file page requests that were fulfilled by the database
db_cache_hit_avg_pct integer 24 average
cache without causing a file operation
The Minimum percentage of database file page requests that were fulfilled by the database
db_cache_hit_min_pct integer 24 min
cache without causing a file operation
The Maximum percentage of database file page requests that were fulfilled by the database
db_cache_hit_max_pct integer 24 max
cache without causing a file operation
The Percentile of the percentage of database file page requests that were fulfilled by the
db_cache_hit_pctl_pct integer 24 10 percentile
database cache without causing a file operation
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 699
AI Operations Management - Containerized 24.4
1.4.2.3.7. opsb_ad_dfs_replicated_folder
Description AD Distributed File System Replicated Folder Monitoring Data
Key columns ad_server_fqdn, dfs_rep_folder_instance_name, timestamp_utc_s, node_fqdn
The compressed size (in bytes) of files received for this replicated
COMPRESSED compressed_size_b string 255
folder.
The number of files and folders in this replicated folder that were
CONFLICT_FILE conflict_file_count string 255 moved to the Conflict and Deleted folder by the DFS Replication
service.
The total size (in bytes) of the conflict loser files and folders currently in
CONFLICT_SPACE conflict_space_b string 255
the Conflict and Deleted folder used by the DFS Replication service.
The number of file installs that are being retried due to sharing
FILE_RETIRED file_installs_retired_count string 255
violations or other errors encountered when installing the files.
TOTAL_FILE_RECV total_files_recvd_count string 255 The number of files that were received by this replicated folder.
RDC rdc_files_recvd_count string 255 The number of files that were received for this replicated folder.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 700
AI Operations Management - Containerized 24.4
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 701
AI Operations Management - Containerized 24.4
1.4.2.3.8. opsb_ad_dfs_replicated_folder_1d
Description AD Distributed File System Replicated Folder Monitoring Data (Daily)
Source dataset opsb_ad_dfs_replicated_folder_1h
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of bandwidth that was saved by the DFS Replication
service for this replicated folder using a combination of remote differential
bandwidth_saving_avg_pct string 255 average
compression (RDC) and other compression technologies that minimize network
bandwidth
The Minimum percentage of bandwidth that was saved by the DFS Replication
service for this replicated folder using a combination of remote differential
bandwidth_saving_min_pct string 255 min
compression (RDC) and other compression technologies that minimize network
bandwidth
The Maximum percentage of bandwidth that was saved by the DFS Replication
service for this replicated folder using a combination of remote differential
bandwidth_saving_max_pct string 255 max
compression (RDC) and other compression technologies that minimize network
bandwidth
compressed_size_avg_b string 255 average The Average compressed size (in bytes) of files received for this replicated folder.
The Minimum compressed size (in bytes) of files received for this replicated
compressed_size_min_b string 255 min
folder.
The Maximum compressed size (in bytes) of files received for this replicated
compressed_size_max_b string 255 max
folder.
The Average number of files and folders in this replicated folder that were moved
conflict_file_avg_count string 255 average
to the Conflict and Deleted folder by the DFS Replication service.
The Minimum number of files and folders in this replicated folder that were
conflict_file_min_count string 255 min
moved to the Conflict and Deleted folder by the DFS Replication service.
The Maximum number of files and folders in this replicated folder that were
conflict_file_max_count string 255 max
moved to the Conflict and Deleted folder by the DFS Replication service.
The number of files and folders in this replicated folder that were moved to the
conflict_file_count string 255 lastval
Conflict and Deleted folder by the DFS Replication service.
The Average total size (in bytes) of the conflict loser files and folders currently in
conflict_space_avg_b string 255 average
the Conflict and Deleted folder used by the DFS Replication service.
The Minimum total size (in bytes) of the conflict loser files and folders currently in
conflict_space_min_b string 255 min
the Conflict and Deleted folder used by the DFS Replication service.
The Maximum total size (in bytes) of the conflict loser files and folders currently in
conflict_space_max_b string 255 max
the Conflict and Deleted folder used by the DFS Replication service.
The Average number of file installs that are being retried due to sharing violations
file_installs_retired_avg_count string 255 average
or other errors encountered when installing the files.
The Minimum number of file installs that are being retried due to sharing
file_installs_retired_min_count string 255 min
violations or other errors encountered when installing the files.
The Maximum number of file installs that are being retried due to sharing
file_installs_retired_max_count string 255 max
violations or other errors encountered when installing the files.
The number of file installs that are being retried due to sharing violations or other
file_installs_retired_count string 255 lastval
errors encountered when installing the files.
The Average number of files that were successfully received from sending
file_installs_succeed_avg_count string 255 average
members and installed locally on this server.
The Minimum number of files that were successfully received from sending
file_installs_succeed_min_count string 255 min
members and installed locally on this server.
The Maximum number of files that were successfully received from sending
file_installs_succeed_max_count string 255 max
members and installed locally on this server.
The number of files that were successfully received from sending members and
file_installs_succeed_count string 255 lastval
installed locally on this server.
total_files_recvd_avg_count string 255 average The Average number of files that were received by this replicated folder.
total_files_recvd_min_count string 255 min The Minimum number of files that were received by this replicated folder.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 702
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
total_files_recvd_max_count string 255 max The Maximum number of files that were received by this replicated folder.
total_files_recvd_count string 255 lastval The number of files that were received by this replicated folder.
rdc_files_recvd_avg_count string 255 average The Average number of files that were received for this replicated folder.
rdc_files_recvd_min_count string 255 min The Minimum number of files that were received for this replicated folder.
rdc_files_recvd_max_count string 255 max The Maximum number of files that were received for this replicated folder.
rdc_files_recvd_count string 255 lastval The number of files that were received for this replicated folder.
The Average number of redundant file replication update records that were
file_rep_updates_drop_avg_count string 255 average ignored by the DFS Replication service because they did not change the
replicated file or folder.
The Minimum number of redundant file replication update records that were
file_rep_updates_drop_min_count string 255 min ignored by the DFS Replication service because they did not change the
replicated file or folder.
The Maximum number of redundant file replication update records that were
file_rep_updates_drop_max_count string 255 max ignored by the DFS Replication service because they did not change the
replicated file or folder.
The number of redundant file replication update records that were ignored by the
file_rep_updates_drop_count string 255 lastval
DFS Replication service because they did not change the replicated file or folder.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 703
AI Operations Management - Containerized 24.4
1.4.2.3.9. opsb_ad_dfs_replicated_folder_1h
Description AD Distributed File System Replicated Folder Monitoring Data (Hourly)
Source dataset opsb_ad_dfs_replicated_folder
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of bandwidth that was saved by the DFS Replication
service for this replicated folder using a combination of remote differential
bandwidth_saving_avg_pct string 255 average
compression (RDC) and other compression technologies that minimize network
bandwidth
The Minimum percentage of bandwidth that was saved by the DFS Replication
service for this replicated folder using a combination of remote differential
bandwidth_saving_min_pct string 255 min
compression (RDC) and other compression technologies that minimize network
bandwidth
The Maximum percentage of bandwidth that was saved by the DFS Replication
service for this replicated folder using a combination of remote differential
bandwidth_saving_max_pct string 255 max
compression (RDC) and other compression technologies that minimize network
bandwidth
compressed_size_avg_b string 255 average The Average compressed size (in bytes) of files received for this replicated folder.
The Minimum compressed size (in bytes) of files received for this replicated
compressed_size_min_b string 255 min
folder.
The Maximum compressed size (in bytes) of files received for this replicated
compressed_size_max_b string 255 max
folder.
The Average number of files and folders in this replicated folder that were moved
conflict_file_avg_count string 255 average
to the Conflict and Deleted folder by the DFS Replication service.
The Minimum number of files and folders in this replicated folder that were
conflict_file_min_count string 255 min
moved to the Conflict and Deleted folder by the DFS Replication service.
The Maximum number of files and folders in this replicated folder that were
conflict_file_max_count string 255 max
moved to the Conflict and Deleted folder by the DFS Replication service.
The number of files and folders in this replicated folder that were moved to the
conflict_file_count string 255 lastval
Conflict and Deleted folder by the DFS Replication service.
The Average total size (in bytes) of the conflict loser files and folders currently in
conflict_space_avg_b string 255 average
the Conflict and Deleted folder used by the DFS Replication service.
The Minimum total size (in bytes) of the conflict loser files and folders currently in
conflict_space_min_b string 255 min
the Conflict and Deleted folder used by the DFS Replication service.
The Maximum total size (in bytes) of the conflict loser files and folders currently in
conflict_space_max_b string 255 max
the Conflict and Deleted folder used by the DFS Replication service.
The Average number of file installs that are being retried due to sharing violations
file_installs_retired_avg_count string 255 average
or other errors encountered when installing the files.
The Minimum number of file installs that are being retried due to sharing
file_installs_retired_min_count string 255 min
violations or other errors encountered when installing the files.
The Maximum number of file installs that are being retried due to sharing
file_installs_retired_max_count string 255 max
violations or other errors encountered when installing the files.
The number of file installs that are being retried due to sharing violations or other
file_installs_retired_count string 255 lastval
errors encountered when installing the files.
The Average number of files that were successfully received from sending
file_installs_succeed_avg_count string 255 average
members and installed locally on this server.
The Minimum number of files that were successfully received from sending
file_installs_succeed_min_count string 255 min
members and installed locally on this server.
The Maximum number of files that were successfully received from sending
file_installs_succeed_max_count string 255 max
members and installed locally on this server.
The number of files that were successfully received from sending members and
file_installs_succeed_count string 255 lastval
installed locally on this server.
total_files_recvd_avg_count string 255 average The Average number of files that were received by this replicated folder.
total_files_recvd_min_count string 255 min The Minimum number of files that were received by this replicated folder.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 704
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
total_files_recvd_max_count string 255 max The Maximum number of files that were received by this replicated folder.
total_files_recvd_count string 255 lastval The number of files that were received by this replicated folder.
rdc_files_recvd_avg_count string 255 average The Average number of files that were received for this replicated folder.
rdc_files_recvd_min_count string 255 min The Minimum number of files that were received for this replicated folder.
rdc_files_recvd_max_count string 255 max The Maximum number of files that were received for this replicated folder.
rdc_files_recvd_count string 255 lastval The number of files that were received for this replicated folder.
The Average number of redundant file replication update records that were
file_rep_updates_drop_avg_count string 255 average ignored by the DFS Replication service because they did not change the
replicated file or folder.
The Minimum number of redundant file replication update records that were
file_rep_updates_drop_min_count string 255 min ignored by the DFS Replication service because they did not change the
replicated file or folder.
The Maximum number of redundant file replication update records that were
file_rep_updates_drop_max_count string 255 max ignored by the DFS Replication service because they did not change the
replicated file or folder.
The number of redundant file replication update records that were ignored by the
file_rep_updates_drop_count string 255 lastval
DFS Replication service because they did not change the replicated file or folder.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 705
AI Operations Management - Containerized 24.4
1.4.2.3.10. opsb_ad_dfs_replication_conn
Description AD Distributed File System Replication Connections Monitoring Data
Key columns ad_server_fqdn, dfs_rep_conn_instance_name, timestamp_utc_s, node_fqdn
BYTES_RECV bytes_recvd_bps string 255 The number of bytes received per second on the connection.
COMPRESSED_FILES compressed_files_b string 255 The compressed size of files (in bytes) received on the connection.
TOTAL_RECV total_bytes_recvd_b string 255 The total number of bytes received on the connection
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 706
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 707
AI Operations Management - Containerized 24.4
1.4.2.3.11. opsb_ad_dfs_replication_conn_1d
Description AD Distributed File System Replication Connections Monitoring Data (Daily)
Source dataset opsb_ad_dfs_replication_conn_1h
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of bandwidth that was saved by the DFS Replication
bandwidth_savings_avg_pct string 255 average service for this connection using a combination of remote differential compression
(RDC) and other compression technologies that minimize network bandwidth use
The Minimum percentage of bandwidth that was saved by the DFS Replication
bandwidth_savings_min_pct string 255 min service for this connection using a combination of remote differential compression
(RDC) and other compression technologies that minimize network bandwidth use
The Maximum percentage of bandwidth that was saved by the DFS Replication
bandwidth_savings_max_pct string 255 max service for this connection using a combination of remote differential compression
(RDC) and other compression technologies that minimize network bandwidth use
bytes_recvd_avg_bps string 255 average The Average number of bytes received per second on the connection.
bytes_recvd_min_bps string 255 min The Minimum number of bytes received per second on the connection.
bytes_recvd_max_bps string 255 max The Maximum number of bytes received per second on the connection.
compressed_files_avg_b string 255 average The Average compressed size of files (in bytes) received on the connection.
compressed_files_min_b string 255 min The Minimum compressed size of files (in bytes) received on the connection.
compressed_files_max_b string 255 max The Maximum compressed size of files (in bytes) received on the connection.
total_bytes_recvd_avg_b string 255 average The Average total number of bytes received on the connection
total_bytes_recvd_min_b string 255 min The Minimum total number of bytes received on the connection
total_bytes_recvd_max_b string 255 max The Maximum total number of bytes received on the connection
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 708
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 709
AI Operations Management - Containerized 24.4
1.4.2.3.12. opsb_ad_dfs_replication_conn_1h
Description AD Distributed File System Replication Connections Monitoring Data (Hourly)
Source dataset opsb_ad_dfs_replication_conn
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of bandwidth that was saved by the DFS Replication
bandwidth_savings_avg_pct string 255 average service for this connection using a combination of remote differential compression
(RDC) and other compression technologies that minimize network bandwidth use
The Minimum percentage of bandwidth that was saved by the DFS Replication
bandwidth_savings_min_pct string 255 min service for this connection using a combination of remote differential compression
(RDC) and other compression technologies that minimize network bandwidth use
The Maximum percentage of bandwidth that was saved by the DFS Replication
bandwidth_savings_max_pct string 255 max service for this connection using a combination of remote differential compression
(RDC) and other compression technologies that minimize network bandwidth use
bytes_recvd_avg_bps string 255 average The Average number of bytes received per second on the connection.
bytes_recvd_min_bps string 255 min The Minimum number of bytes received per second on the connection.
bytes_recvd_max_bps string 255 max The Maximum number of bytes received per second on the connection.
compressed_files_avg_b string 255 average The Average compressed size of files (in bytes) received on the connection.
compressed_files_min_b string 255 min The Minimum compressed size of files (in bytes) received on the connection.
compressed_files_max_b string 255 max The Maximum compressed size of files (in bytes) received on the connection.
total_bytes_recvd_avg_b string 255 average The Average total number of bytes received on the connection
total_bytes_recvd_min_b string 255 min The Minimum total number of bytes received on the connection
total_bytes_recvd_max_b string 255 max The Maximum total number of bytes received on the connection
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 710
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 711
AI Operations Management - Containerized 24.4
1.4.2.3.13. opsb_ad_directory_services
Description AD Directory Services Monitoring Data
Key columns ad_server_fqdn, dir_svc_instance_name, timestamp_utc_s, node_fqdn
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 712
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 713
AI Operations Management - Containerized 24.4
1.4.2.3.14. opsb_ad_directory_services_1d
Description AD Directory Services Monitoring Data (Daily)
Source dataset opsb_ad_directory_services_1h
Data Aggregation
Column Name Size Description
Type Type
outbound_obj_avg_count_per_s integer 24 average The Average number of objects replicated out per second.
outbound_obj_min_count_per_s integer 24 min The Minimum number of objects replicated out per second.
outbound_obj_max_count_per_s integer 24 max The Maximum number of objects replicated out per second.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 714
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
ldap_client_session_avg_count string 255 average The Average number of connected LDAP client sessions.
ldap_client_session_min_count string 255 min The Minimum number of connected LDAP client sessions.
ldap_client_session_max_count string 255 max The Maximum number of connected LDAP client sessions.
dir_writes_avg_count_per_s string 255 average The Average number of directory writes per second.
dir_writes_min_count_per_s string 255 min The Minimum number of directory writes per second.
dir_writes_max_count_per_s string 255 max The Maximum number of directory writes per second.
dir_reads_avg_count_per_s string 255 average The Average number of directory reads per second.
dir_reads_min_count_per_s string 255 min The Minimum number of directory reads per second.
dir_reads_max_count_per_s string 255 max The Maximum number of directory reads per second.
dir_searches_avg_count_per_s string 255 average The Average number of directory searches per second.
dir_searches_min_count_per_s string 255 min The Minimum number of directory searches per second.
dir_searches_max_count_per_s string 255 max The Maximum number of directory searches per second.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 715
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
collection_policy_name string 255 lastval policy. If policies do have versions, the corresponding
version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 716
AI Operations Management - Containerized 24.4
1.4.2.3.15. opsb_ad_directory_services_1h
Description AD Directory Services Monitoring Data (Hourly)
Source dataset opsb_ad_directory_services
Data Aggregation
Column Name Size Description
Type Type
outbound_obj_avg_count_per_s integer 24 average The Average number of objects replicated out per second.
outbound_obj_min_count_per_s integer 24 min The Minimum number of objects replicated out per second.
outbound_obj_max_count_per_s integer 24 max The Maximum number of objects replicated out per second.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 717
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
ldap_client_session_avg_count string 255 average The Average number of connected LDAP client sessions.
ldap_client_session_min_count string 255 min The Minimum number of connected LDAP client sessions.
ldap_client_session_max_count string 255 max The Maximum number of connected LDAP client sessions.
dir_writes_avg_count_per_s string 255 average The Average number of directory writes per second.
dir_writes_min_count_per_s string 255 min The Minimum number of directory writes per second.
dir_writes_max_count_per_s string 255 max The Maximum number of directory writes per second.
dir_reads_avg_count_per_s string 255 average The Average number of directory reads per second.
dir_reads_min_count_per_s string 255 min The Minimum number of directory reads per second.
dir_reads_max_count_per_s string 255 max The Maximum number of directory reads per second.
dir_searches_avg_count_per_s string 255 average The Average number of directory searches per second.
dir_searches_min_count_per_s string 255 min The Minimum number of directory searches per second.
dir_searches_max_count_per_s string 255 max The Maximum number of directory searches per second.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 718
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
collection_policy_name string 255 lastval policy. If policies do have versions, the corresponding
version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 719
AI Operations Management - Containerized 24.4
1.4.2.3.16. opsb_ad_dit_db_disk
Description AD Directory Information Tree(DIT) Database Disk Drive Monitoring Data
Key columns ad_server_fqdn, dit_db_path, timestamp_utc_s, node_fqdn
DITQLNAME dit_db_path string 255 Path of the Directory Information Tree(DIT) database file
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 720
AI Operations Management - Containerized 24.4
1.4.2.3.17. opsb_ad_dit_db_disk_1d
Description AD Directory Information Tree(DIT) Database Disk Drive Monitoring Data (Daily)
Source dataset opsb_ad_dit_db_disk
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_avg_pct integer 24 average
Information Tree(DIT) database
The Minimum percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_min_pct integer 24 min
Information Tree(DIT) database
The Maximum percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_max_pct integer 24 max
Information Tree(DIT) database
The Percentile of the percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_pctl_pct integer 24 90 percentile
Information Tree(DIT) database
The Average disk queue length of the drive hosting Directory Information
dit_db_disk_que_length_avg_count integer 24 average
Tree(DIT) database
The Minimum disk queue length of the drive hosting Directory Information
dit_db_disk_que_length_min_count integer 24 min
Tree(DIT) database
The Maximum disk queue length of the drive hosting Directory Information
dit_db_disk_que_length_max_count integer 24 max
Tree(DIT) database
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
dit_db_path_id string 255 Path of the Directory Information Tree(DIT) database file
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 721
AI Operations Management - Containerized 24.4
1.4.2.3.18. opsb_ad_dit_db_disk_1h
Description AD Directory Information Tree(DIT) Database Disk Drive Monitoring Data (Hourly)
Source dataset opsb_ad_dit_db_disk
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_avg_pct integer 24 average
Information Tree(DIT) database
The Minimum percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_min_pct integer 24 min
Information Tree(DIT) database
The Maximum percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_max_pct integer 24 max
Information Tree(DIT) database
The Percentile of the percentage of the used space of the drive hosting Directory
dit_db_disk_used_space_pctl_pct integer 24 90 percentile
Information Tree(DIT) database
The Average disk queue length of the drive hosting Directory Information
dit_db_disk_que_length_avg_count integer 24 average
Tree(DIT) database
The Minimum disk queue length of the drive hosting Directory Information
dit_db_disk_que_length_min_count integer 24 min
Tree(DIT) database
The Maximum disk queue length of the drive hosting Directory Information
dit_db_disk_que_length_max_count integer 24 max
Tree(DIT) database
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
dit_db_path_id string 255 Path of the Directory Information Tree(DIT) database file
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 722
AI Operations Management - Containerized 24.4
1.4.2.3.19. opsb_ad_dit_db_filesize
Description AD Directory Information Tree(DIT) Database File Size Data
Key columns ad_server_fqdn, dit_db_file_path, timestamp_utc_s, node_fqdn
INSTANCENAME dit_db_file_path string 255 Path of the Directory Information Tree(DIT) database file
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 723
AI Operations Management - Containerized 24.4
1.4.2.3.20. opsb_ad_dit_db_filesize_1d
Description AD Directory Information Tree(DIT) Database File Size Data (Daily)
Source dataset opsb_ad_dit_db_filesize_1h
Data Aggregation
Column Name Size Description
Type Type
dit_db_filesize_avg_mb integer 24 average The Average size of the Directory Information Tree(DIT) file in MB
dit_db_filesize_min_mb integer 24 min The Minimum size of the Directory Information Tree(DIT) file in MB
dit_db_filesize_max_mb integer 24 max The Maximum size of the Directory Information Tree(DIT) file in MB
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
dit_db_file_path_id string 255 Path of the Directory Information Tree(DIT) database file
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 724
AI Operations Management - Containerized 24.4
1.4.2.3.21. opsb_ad_dit_db_filesize_1h
Description AD Directory Information Tree(DIT) Database File Size Data (Hourly)
Source dataset opsb_ad_dit_db_filesize
Data Aggregation
Column Name Size Description
Type Type
dit_db_filesize_avg_mb integer 24 average The Average size of the Directory Information Tree(DIT) file in MB
dit_db_filesize_min_mb integer 24 min The Minimum size of the Directory Information Tree(DIT) file in MB
dit_db_filesize_max_mb integer 24 max The Maximum size of the Directory Information Tree(DIT) file in MB
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
dit_db_file_path_id string 255 Path of the Directory Information Tree(DIT) database file
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 725
AI Operations Management - Containerized 24.4
1.4.2.3.22. opsb_ad_dit_log_disk
Description AD Directory Information Tree(DIT) Log Disk Drive Monitoring Data
Key columns ad_server_fqdn, dit_log_path, timestamp_utc_s, node_fqdn
LGQLENNAME dit_log_path string 255 Directory Information Tree(DIT) log file path
Size of the drive (in MB) containing Directory Information Tree(DIT) log
DISKVALUE dit_log_disk_size_mb integer 24
files
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present
in the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 726
AI Operations Management - Containerized 24.4
1.4.2.3.23. opsb_ad_dit_log_disk_1d
Description AD Directory Information Tree(DIT) Log Disk Drive Monitoring Data (Daily)
Source dataset opsb_ad_dit_log_disk
Data Aggregation
Column Name Size Description
Type Type
The Average size of the drive (in MB) containing Directory Information Tree(DIT)
dit_log_disk_size_avg_mb integer 24 average
log files
The Minimum size of the drive (in MB) containing Directory Information
dit_log_disk_size_min_mb integer 24 min
Tree(DIT) log files
The Maximum size of the drive (in MB) containing Directory Information
dit_log_disk_size_max_mb integer 24 max
Tree(DIT) log files
The Percentile of the percentage of used space of the drive containing Directory
dit_log_disk_used_space_pctl_pct integer 24 90 percentile
Information Tree(DIT) log files
The Average disk queue length of the drive containing the Directory Information
dit_log_disk_que_length_avg_count integer 24 average
Tree(DIT) log files
The Minimum disk queue length of the drive containing the Directory
dit_log_disk_que_length_min_count integer 24 min
Information Tree(DIT) log files
The Maximum disk queue length of the drive containing the Directory
dit_log_disk_que_length_max_count integer 24 max
Information Tree(DIT) log files
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 727
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 728
AI Operations Management - Containerized 24.4
1.4.2.3.24. opsb_ad_dit_log_disk_1h
Description AD Directory Information Tree(DIT) Log Disk Drive Monitoring Data (Hourly)
Source dataset opsb_ad_dit_log_disk
Data Aggregation
Column Name Size Description
Type Type
The Average size of the drive (in MB) containing Directory Information Tree(DIT)
dit_log_disk_size_avg_mb integer 24 average
log files
The Minimum size of the drive (in MB) containing Directory Information
dit_log_disk_size_min_mb integer 24 min
Tree(DIT) log files
The Maximum size of the drive (in MB) containing Directory Information
dit_log_disk_size_max_mb integer 24 max
Tree(DIT) log files
The Percentile of the percentage of used space of the drive containing Directory
dit_log_disk_used_space_pctl_pct integer 24 90 percentile
Information Tree(DIT) log files
The Average disk queue length of the drive containing the Directory Information
dit_log_disk_que_length_avg_count integer 24 average
Tree(DIT) log files
The Minimum disk queue length of the drive containing the Directory
dit_log_disk_que_length_min_count integer 24 min
Information Tree(DIT) log files
The Maximum disk queue length of the drive containing the Directory
dit_log_disk_que_length_max_count integer 24 max
Information Tree(DIT) log files
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 729
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 730
AI Operations Management - Containerized 24.4
1.4.2.3.25. opsb_ad_dns
Description AD Domain Name System Monitoring Data
Key columns ad_server_fqdn, timestamp_utc_s, node_fqdn
ISDOMAINCTRL is_domaincontroller double 24 Set to 1 if the DNS server is a DC and set to 0 if it is not
RESPONSETIME dns_server_resp_time_ms double 24 Domain Name System (DNS) Server Response Time
PAGESPERSEC dns_pages_count_per_s double 24 Domain Name System (DNS) pages per second
RESPTIME dns_query_resp_time_ms double 24 Domain Name System (DNS) Query Response Time
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 731
AI Operations Management - Containerized 24.4
1.4.2.3.26. opsb_ad_dns_1d
Description AD Domain Name System Monitoring Data (Daily)
Source dataset opsb_ad_dns_1h
Data Aggregation
Column Name Size Description
Type Type
dns_server_resp_time_avg_ms double 24 average The Average domain Name System (DNS) Server Response Time
dns_server_resp_time_min_ms double 24 min The Minimum domain Name System (DNS) Server Response Time
dns_server_resp_time_max_ms double 24 max The Maximum domain Name System (DNS) Server Response Time
dns_pages_avg_count_per_s double 24 average The Average domain Name System (DNS) pages per second
dns_pages_min_count_per_s double 24 min The Minimum domain Name System (DNS) pages per second
dns_pages_max_count_per_s double 24 max The Maximum domain Name System (DNS) pages per second
dns_query_resp_time_avg_ms double 24 average The Average domain Name System (DNS) Query Response Time
dns_query_resp_time_min_ms double 24 min The Minimum domain Name System (DNS) Query Response Time
dns_query_resp_time_max_ms double 24 max The Maximum domain Name System (DNS) Query Response Time
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 732
AI Operations Management - Containerized 24.4
1.4.2.3.27. opsb_ad_dns_1h
Description AD Domain Name System Monitoring Data (Hourly)
Source dataset opsb_ad_dns
Data Aggregation
Column Name Size Description
Type Type
dns_server_resp_time_avg_ms double 24 average The Average domain Name System (DNS) Server Response Time
dns_server_resp_time_min_ms double 24 min The Minimum domain Name System (DNS) Server Response Time
dns_server_resp_time_max_ms double 24 max The Maximum domain Name System (DNS) Server Response Time
dns_pages_avg_count_per_s double 24 average The Average domain Name System (DNS) pages per second
dns_pages_min_count_per_s double 24 min The Minimum domain Name System (DNS) pages per second
dns_pages_max_count_per_s double 24 max The Maximum domain Name System (DNS) pages per second
dns_query_resp_time_avg_ms double 24 average The Average domain Name System (DNS) Query Response Time
dns_query_resp_time_min_ms double 24 min The Minimum domain Name System (DNS) Query Response Time
dns_query_resp_time_max_ms double 24 max The Maximum domain Name System (DNS) Query Response Time
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 733
AI Operations Management - Containerized 24.4
1.4.2.3.28. opsb_ad_federation_server
Description AD Federation Server Monitoring Data
Key columns ad_server_fqdn, fs_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 734
AI Operations Management - Containerized 24.4
1.4.2.3.29. opsb_ad_federation_server_1d
Description AD Federation Server Monitoring Data (Daily)
Source dataset opsb_ad_federation_server_1h
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 735
AI Operations Management - Containerized 24.4
1.4.2.3.30. opsb_ad_federation_server_1h
Description AD Federation Server Monitoring Data (Hourly)
Source dataset opsb_ad_federation_server
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 736
AI Operations Management - Containerized 24.4
1.4.2.3.31. opsb_ad_fsmo
Description AD Flexible Single Master Operations Monitoring Data
Key columns ad_server_fqdn, fsmo_role_name, timestamp_utc_s, node_fqdn
FSMORM fsmo_role_name string 255 Name of the Flexible single master operation(FSMO) role
SERVER dc_hosting_fsmo string 255 Name of the server hosting the role
PINGTIME ping_time_s double 24 Ping time experienced by the Domain Controller to the server in seconds
FSMOBINDTIME bind_time_s integer 24 Bind time experienced by the Domain Controller to the server in seconds
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 737
AI Operations Management - Containerized 24.4
1.4.2.3.32. opsb_ad_fsmo_1d
Description AD Flexible Single Master Operations Monitoring Data (Daily)
Source dataset opsb_ad_fsmo_1h
Data Aggregation
Column Name Size Description
Type Type
dc_hosting_fsmo string 255 lastval Name of the server hosting the role
ping_time_avg_s double 24 average The Average ping time experienced by the Domain Controller to the server in seconds
ping_time_min_s double 24 min The Minimum ping time experienced by the Domain Controller to the server in seconds
ping_time_max_s double 24 max The Maximum ping time experienced by the Domain Controller to the server in seconds
bind_time_avg_s integer 24 average The Average bind time experienced by the Domain Controller to the server in seconds
bind_time_min_s integer 24 min The Minimum bind time experienced by the Domain Controller to the server in seconds
bind_time_max_s integer 24 max The Maximum bind time experienced by the Domain Controller to the server in seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
fsmo_role_name_id string 255 Name of the Flexible single master operation(FSMO) role
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 738
AI Operations Management - Containerized 24.4
1.4.2.3.33. opsb_ad_fsmo_1h
Description AD Flexible Single Master Operations Monitoring Data (Hourly)
Source dataset opsb_ad_fsmo
Data Aggregation
Column Name Size Description
Type Type
dc_hosting_fsmo string 255 lastval Name of the server hosting the role
ping_time_avg_s double 24 average The Average ping time experienced by the Domain Controller to the server in seconds
ping_time_min_s double 24 min The Minimum ping time experienced by the Domain Controller to the server in seconds
ping_time_max_s double 24 max The Maximum ping time experienced by the Domain Controller to the server in seconds
bind_time_avg_s integer 24 average The Average bind time experienced by the Domain Controller to the server in seconds
bind_time_min_s integer 24 min The Minimum bind time experienced by the Domain Controller to the server in seconds
bind_time_max_s integer 24 max The Maximum bind time experienced by the Domain Controller to the server in seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
fsmo_role_name_id string 255 Name of the Flexible single master operation(FSMO) role
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 739
AI Operations Management - Containerized 24.4
1.4.2.3.34. opsb_ad_fsmo_role_movement
Description AD Flexible Single Master Operations Role Movement Monitoring Data
Key columns ad_server_fqdn, fsmo_role_name, timestamp_utc_s, node_fqdn
FSMORM fsmo_role_name string 255 Name of the Flexible single master operation(FSMO) role
Indicates 0 if the role has been gained and 1 if it has been lost by the
ISROLEHOLDER is_roleholder double 24
Domain Controller
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 740
AI Operations Management - Containerized 24.4
1.4.2.3.35. opsb_ad_fsmo_role_movement_1d
Description AD Flexible Single Master Operations Role Movement Monitoring Data (Daily)
Source dataset opsb_ad_fsmo_role_movement_1h
Data Aggregation
Column Name Size Description
Type Type
is_roleholder double 24 lastval Indicates 0 if the role has been gained and 1 if it has been lost by the Domain Controller
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
fsmo_role_name_id string 255 Name of the Flexible single master operation(FSMO) role
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 741
AI Operations Management - Containerized 24.4
1.4.2.3.36. opsb_ad_fsmo_role_movement_1h
Description AD Flexible Single Master Operations Role Movement Monitoring Data (Hourly)
Source dataset opsb_ad_fsmo_role_movement
Data Aggregation
Column Name Size Description
Type Type
is_roleholder double 24 lastval Indicates 0 if the role has been gained and 1 if it has been lost by the Domain Controller
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
fsmo_role_name_id string 255 Name of the Flexible single master operation(FSMO) role
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 742
AI Operations Management - Containerized 24.4
1.4.2.3.37. opsb_ad_gc_replication
Description AD Global Catalog Replication Latency Monitoring Data
Key columns ad_server_fqdn, gc_rep_name, timestamp_utc_s, node_fqdn
DNS name of the Domain controller with which the Global Catalog has been
GCREPNAME gc_rep_name string 255
replicated
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 743
AI Operations Management - Containerized 24.4
1.4.2.3.38. opsb_ad_gc_replication_1d
Description AD Global Catalog Replication Latency Monitoring Data (Daily)
Source dataset opsb_ad_gc_replication_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
gc_rep_name_id string 255 DNS name of the Domain controller with which the Global Catalog has been replicated
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 744
AI Operations Management - Containerized 24.4
1.4.2.3.39. opsb_ad_gc_replication_1h
Description AD Global Catalog Replication Latency Monitoring Data (Hourly)
Source dataset opsb_ad_gc_replication
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
gc_rep_name_id string 255 DNS name of the Domain controller with which the Global Catalog has been replicated
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 745
AI Operations Management - Containerized 24.4
1.4.2.3.40. opsb_ad_khi_memory
Description AD DC Memory Usage Health Indicator
Key columns ad_server_fqdn, mem_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 746
AI Operations Management - Containerized 24.4
1.4.2.3.41. opsb_ad_khi_memory_1d
Description AD DC Memory Usage Health Indicator (Daily)
Source dataset opsb_ad_khi_memory_1h
Data Aggregation
Column Name Size Description
Type Type
dc_mem_usage_avg_mb integer 24 average The Average memory usage of the domain controller
dc_mem_usage_min_mb integer 24 min The Minimum memory usage of the domain controller
dc_mem_usage_max_mb integer 24 max The Maximum memory usage of the domain controller
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 747
AI Operations Management - Containerized 24.4
1.4.2.3.42. opsb_ad_khi_memory_1h
Description AD DC Memory Usage Health Indicator (Hourly)
Source dataset opsb_ad_khi_memory
Data Aggregation
Column Name Size Description
Type Type
dc_mem_usage_avg_mb integer 24 average The Average memory usage of the domain controller
dc_mem_usage_min_mb integer 24 min The Minimum memory usage of the domain controller
dc_mem_usage_max_mb integer 24 max The Maximum memory usage of the domain controller
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 748
AI Operations Management - Containerized 24.4
1.4.2.3.43. opsb_ad_khi_network_interface
Description AD DC Network interface Health Indicator
Key columns ad_server_fqdn, network_interface_instance_name, timestamp_utc_s, node_fqdn
PACKETSRECDISCAR packets_recvd_discard_count integer 24 The number of received packets discarded by the domain controller
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If
CollectionConfigName collection_policy_name string 255
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 749
AI Operations Management - Containerized 24.4
1.4.2.3.44. opsb_ad_khi_network_interface_1d
Description AD DC Network interface Health Indicator (Daily)
Source dataset opsb_ad_khi_network_interface_1h
Data Aggregation
Column Name Size Description
Type Type
output_que_length_avg_count integer 24 average The Average output queue length of domain controller
output_que_length_min_count integer 24 min The Minimum output queue length of domain controller
output_que_length_max_count integer 24 max The Maximum output queue length of domain controller
packets_outbound_discard_avg_count integer 24 average The Average number of outbound packets discarded by the domain controller
packets_outbound_discard_count integer 24 lastval The number of outbound packets discarded by the domain controller
packets_recvd_discard_avg_count integer 24 average The Average number of received packets discarded by the domain controller
packets_recvd_discard_min_count integer 24 min The Minimum number of received packets discarded by the domain controller
packets_recvd_discard_count integer 24 lastval The number of received packets discarded by the domain controller
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 750
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 751
AI Operations Management - Containerized 24.4
1.4.2.3.45. opsb_ad_khi_network_interface_1h
Description AD DC Network interface Health Indicator (Hourly)
Source dataset opsb_ad_khi_network_interface
Data Aggregation
Column Name Size Description
Type Type
output_que_length_avg_count integer 24 average The Average output queue length of domain controller
output_que_length_min_count integer 24 min The Minimum output queue length of domain controller
output_que_length_max_count integer 24 max The Maximum output queue length of domain controller
packets_outbound_discard_avg_count integer 24 average The Average number of outbound packets discarded by the domain controller
packets_outbound_discard_count integer 24 lastval The number of outbound packets discarded by the domain controller
packets_recvd_discard_avg_count integer 24 average The Average number of received packets discarded by the domain controller
packets_recvd_discard_min_count integer 24 min The Minimum number of received packets discarded by the domain controller
packets_recvd_discard_count integer 24 lastval The number of received packets discarded by the domain controller
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 752
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 753
AI Operations Management - Containerized 24.4
1.4.2.3.46. opsb_ad_khi_physical_disk
Description AD DC Physical Disk Health Indicator
Key columns ad_server_fqdn, physical_disk_instance_name, timestamp_utc_s, node_fqdn
AVGDISKSREAD disk_reads_avg_s double 24 The average time disk reading took to complete in seconds
AVGDISKSWRITE disk_writes_avg_s double 24 The average time disk writing took to complete in seconds
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 754
AI Operations Management - Containerized 24.4
1.4.2.3.47. opsb_ad_khi_physical_disk_1d
Description AD DC Physical Disk Health Indicator (Daily)
Source dataset opsb_ad_khi_physical_disk_1h
Data Aggregation
Column Name Size Description
Type Type
disk_reads_avg_s average The Average time disk reading took to complete in seconds
disk_reads_avg_min_s min The Minimum average time disk reading took to complete in seconds
disk_reads_avg_max_s max The Maximum average time disk reading took to complete in seconds
disk_writes_avg_avg_s average The Average average time disk writing took to complete in seconds
disk_writes_avg_min_s min The Minimum average time disk writing took to complete in seconds
disk_writes_avg_max_s max The Maximum average time disk writing took to complete in seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 755
AI Operations Management - Containerized 24.4
1.4.2.3.48. opsb_ad_khi_physical_disk_1h
Description AD DC Physical Disk Health Indicator (Hourly)
Source dataset opsb_ad_khi_physical_disk
Data Aggregation
Column Name Size Description
Type Type
disk_reads_avg_s double 24 average The Average time disk reading took to complete in seconds
disk_reads_avg_min_s double 24 min The Minimum average time disk reading took to complete in seconds
disk_reads_avg_max_s double 24 max The Maximum average time disk reading took to complete in seconds
disk_writes_avg_avg_s double 24 average The Average average time disk writing took to complete in seconds
disk_writes_avg_min_s double 24 min The Minimum average time disk writing took to complete in seconds
disk_writes_avg_max_s double 24 max The Maximum average time disk writing took to complete in seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 756
AI Operations Management - Containerized 24.4
1.4.2.3.49. opsb_ad_khi_processor_info
Description AD DC Processor Health Indicator
Key columns ad_server_fqdn, processor_info_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present
in the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 757
AI Operations Management - Containerized 24.4
1.4.2.3.50. opsb_ad_khi_processor_info_1d
Description AD DC Processor Health Indicator (Daily)
Source dataset opsb_ad_khi_processor_info
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of elapsed time that the processor spends to execute a
dc_processor_time_total_avg_pct double 24 average
non-Idle thread and shows the value of total processor utilization
The Minimum percentage of elapsed time that the processor spends to execute a
dc_processor_time_total_min_pct double 24 min
non-Idle thread and shows the value of total processor utilization
The Maximum percentage of elapsed time that the processor spends to execute a
dc_processor_time_total_max_pct double 24 max
non-Idle thread and shows the value of total processor utilization
The Percentile of the percentage of elapsed time that the processor spends to
dc_processor_time_total_pctl_pct double 24 90 percentile
execute a non-Idle thread and shows the value of total processor utilization
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 758
AI Operations Management - Containerized 24.4
1.4.2.3.51. opsb_ad_khi_processor_info_1h
Description AD DC Processor Health Indicator (Hourly)
Source dataset opsb_ad_khi_processor_info
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of elapsed time that the processor spends to execute a
dc_processor_time_total_avg_pct double 24 average
non-Idle thread and shows the value of total processor utilization
The Minimum percentage of elapsed time that the processor spends to execute a
dc_processor_time_total_min_pct double 24 min
non-Idle thread and shows the value of total processor utilization
The Maximum percentage of elapsed time that the processor spends to execute a
dc_processor_time_total_max_pct double 24 max
non-Idle thread and shows the value of total processor utilization
The Percentile of the percentage of elapsed time that the processor spends to
dc_processor_time_total_pctl_pct double 24 90 percentile
execute a non-Idle thread and shows the value of total processor utilization
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 759
AI Operations Management - Containerized 24.4
1.4.2.3.52. opsb_ad_ntds
Description AD NT Directory Services Monitoring Data
Key columns ad_server_fqdn, ntds_instance_name, timestamp_utc_s, node_fqdn
DSTHREADSINUSE ds_threads_inuse_count string 255 Number of threads in use by the directory service
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 760
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 761
AI Operations Management - Containerized 24.4
1.4.2.3.53. opsb_ad_ntds_1d
Description AD NT Directory Services Monitoring Data (Daily)
Source dataset opsb_ad_ntds_1h
Data Aggregation
Column Name Size Description
Type Type
The Average total number of bytes replicated in per second. Sum of the
dra_inbound_bytes_avg_bps string 255 average number of uncompressed bytes (never compressed) and the number of
compressed bytes (after compression).
The Minimum total number of bytes replicated in per second. Sum of the
dra_inbound_bytes_min_bps string 255 min number of uncompressed bytes (never compressed) and the number of
compressed bytes (after compression).
ds_threads_inuse_avg_count string 255 average The Average number of threads in use by the directory service
ds_threads_inuse_min_count string 255 min The Minimum number of threads in use by the directory service
ds_threads_inuse_max_count string 255 max The Maximum number of threads in use by the directory service
The Average total number of bytes replicated out per second. Sum of
dra_outbound_bytes_avg_bps string 255 average the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).
The Minimum total number of bytes replicated out per second. Sum of
dra_outbound_bytes_min_bps string 255 min the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).
The Maximum total number of bytes replicated out per second. Sum of
dra_outbound_bytes_max_bps string 255 max the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).
The Average number of bytes replicated in per second that were not
dra_inbound_noncompressed_avg_bps string 255 average
compressed at the source (i.e., from DSAs in the same site).
The Minimum number of bytes replicated in per second that were not
dra_inbound_noncompressed_min_bps string 255 min
compressed at the source (i.e., from DSAs in the same site).
The Maximum number of bytes replicated in per second that were not
dra_inbound_noncompressed_max_bps string 255 max
compressed at the source (i.e., from DSAs in the same site).
The Average number of bytes replicated out per second that were not
dra_outbound_noncompressed_avg_bps string 255 average
compressed (i.e., from DSAs in the same site).
The Minimum number of bytes replicated out per second that were not
dra_outbound_noncompressed_min_bps string 255 min
compressed (i.e., from DSAs in the same site).
The Maximum number of bytes replicated out per second that were not
dra_outbound_noncompressed_max_bps string 255 max
compressed (i.e., from DSAs in the same site).
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 762
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 763
AI Operations Management - Containerized 24.4
1.4.2.3.54. opsb_ad_ntds_1h
Description AD NT Directory Services Monitoring Data (Hourly)
Source dataset opsb_ad_ntds
Data Aggregation
Column Name Size Description
Type Type
The Average total number of bytes replicated in per second. Sum of the
dra_inbound_bytes_avg_bps string 255 average number of uncompressed bytes (never compressed) and the number of
compressed bytes (after compression).
The Minimum total number of bytes replicated in per second. Sum of the
dra_inbound_bytes_min_bps string 255 min number of uncompressed bytes (never compressed) and the number of
compressed bytes (after compression).
ds_threads_inuse_avg_count string 255 average The Average number of threads in use by the directory service
ds_threads_inuse_min_count string 255 min The Minimum number of threads in use by the directory service
ds_threads_inuse_max_count string 255 max The Maximum number of threads in use by the directory service
The Average total number of bytes replicated out per second. Sum of
dra_outbound_bytes_avg_bps string 255 average the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).
The Minimum total number of bytes replicated out per second. Sum of
dra_outbound_bytes_min_bps string 255 min the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).
The Maximum total number of bytes replicated out per second. Sum of
dra_outbound_bytes_max_bps string 255 max the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).
The Average number of bytes replicated in per second that were not
dra_inbound_noncompressed_avg_bps string 255 average
compressed at the source (i.e., from DSAs in the same site).
The Minimum number of bytes replicated in per second that were not
dra_inbound_noncompressed_min_bps string 255 min
compressed at the source (i.e., from DSAs in the same site).
The Maximum number of bytes replicated in per second that were not
dra_inbound_noncompressed_max_bps string 255 max
compressed at the source (i.e., from DSAs in the same site).
The Average number of bytes replicated out per second that were not
dra_outbound_noncompressed_avg_bps string 255 average
compressed (i.e., from DSAs in the same site).
The Minimum number of bytes replicated out per second that were not
dra_outbound_noncompressed_min_bps string 255 min
compressed (i.e., from DSAs in the same site).
The Maximum number of bytes replicated out per second that were not
dra_outbound_noncompressed_max_bps string 255 max
compressed (i.e., from DSAs in the same site).
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 764
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 765
AI Operations Management - Containerized 24.4
1.4.2.3.55. opsb_ad_ntds_process
Description AD NT Directory Services Process Monitoring Data
Key columns ad_server_fqdn, ntds_process_instance_name, timestamp_utc_s, node_fqdn
The percentage of elapsed time that all of process threads used the
PCTPROCTIME processor_time_pct double 24
processor to execution instructions.
The rate at which page faults by the threads executing in this process
PAGEFAULTSSEC pagefaults_count_per_s double 24
are occurring per second
WORKINGSET workingset_b integer 24 The current size, in bytes, of the Working Set of this process
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 766
AI Operations Management - Containerized 24.4
1.4.2.3.56. opsb_ad_ntds_process_1d
Description AD NT Directory Services Process Monitoring Data (Daily)
Source dataset opsb_ad_ntds_process
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of elapsed time that all of process threads used the
processor_time_avg_pct double 24 average
processor to execution instructions.
The Minimum percentage of elapsed time that all of process threads used the
processor_time_min_pct double 24 min
processor to execution instructions.
The Maximum percentage of elapsed time that all of process threads used the
processor_time_max_pct double 24 max
processor to execution instructions.
The Percentile of the percentage of elapsed time that all of process threads used
processor_time_pctl_pct double 24 90 percentile
the processor to execution instructions.
The Average rate at which page faults by the threads executing in this process are
pagefaults_avg_count_per_s double 24 average
occurring per second
The Minimum rate at which page faults by the threads executing in this process are
pagefaults_min_count_per_s double 24 min
occurring per second
The Maximum rate at which page faults by the threads executing in this process are
pagefaults_max_count_per_s double 24 max
occurring per second
workingset_avg_b integer 24 average The Average current size, in bytes, of the Working Set of this process
workingset_min_b integer 24 min The Minimum current size, in bytes, of the Working Set of this process
workingset_max_b integer 24 max The Maximum current size, in bytes, of the Working Set of this process
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 767
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 768
AI Operations Management - Containerized 24.4
1.4.2.3.57. opsb_ad_ntds_process_1h
Description AD NT Directory Services Process Monitoring Data (Hourly)
Source dataset opsb_ad_ntds_process
Data Aggregation
Column Name Size Description
Type Type
The Average percentage of elapsed time that all of process threads used the
processor_time_avg_pct double 24 average
processor to execution instructions.
The Minimum percentage of elapsed time that all of process threads used the
processor_time_min_pct double 24 min
processor to execution instructions.
The Maximum percentage of elapsed time that all of process threads used the
processor_time_max_pct double 24 max
processor to execution instructions.
The Percentile of the percentage of elapsed time that all of process threads used
processor_time_pctl_pct double 24 90 percentile
the processor to execution instructions.
The Average rate at which page faults by the threads executing in this process are
pagefaults_avg_count_per_s double 24 average
occurring per second
The Minimum rate at which page faults by the threads executing in this process are
pagefaults_min_count_per_s double 24 min
occurring per second
The Maximum rate at which page faults by the threads executing in this process are
pagefaults_max_count_per_s double 24 max
occurring per second
workingset_avg_b integer 24 average The Average current size, in bytes, of the Working Set of this process
workingset_min_b integer 24 min The Minimum current size, in bytes, of the Working Set of this process
workingset_max_b integer 24 max The Maximum current size, in bytes, of the Working Set of this process
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 769
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 770
AI Operations Management - Containerized 24.4
1.4.2.3.58. opsb_ad_process
Description AD Process Monitoring Data
Key columns ad_server_fqdn, process_instance_name, timestamp_utc_s, node_fqdn
The rate at which page faults by the threads executing in this process are
PAGEFAULTSSEC pagefaults_count_per_s string 255
occurring per second
The current size, in bytes, of memory that this process has allocated that
PRIVATEBYTES privatebytes_b string 255
cannot be shared with other processes.
The percentage of elapsed time that all of process threads used the
PCTPROCTIME processor_time_pct string 255
processor to execution instructions.
WORKINGSET workingset_b string 255 The current size, in bytes, of the Working Set of this process
VIRTUALBYTES virtualbytes_b double 24 The current size, in bytes, of the virtual address space the process is using.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 771
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 772
AI Operations Management - Containerized 24.4
1.4.2.3.59. opsb_ad_process_1d
Description AD Process Monitoring Data (Daily)
Source dataset opsb_ad_process_1h
Data Aggregation
Column Name Size Description
Type Type
The Average rate at which page faults by the threads executing in this process are
pagefaults_avg_count_per_s string 255 average
occurring per second
The Minimum rate at which page faults by the threads executing in this process are
pagefaults_min_count_per_s string 255 min
occurring per second
The Maximum rate at which page faults by the threads executing in this process are
pagefaults_max_count_per_s string 255 max
occurring per second
The Average current size, in bytes, of memory that this process has allocated that
privatebytes_avg_b string 255 average
cannot be shared with other processes.
The Minimum current size, in bytes, of memory that this process has allocated that
privatebytes_min_b string 255 min
cannot be shared with other processes.
The Maximum current size, in bytes, of memory that this process has allocated that
privatebytes_max_b string 255 max
cannot be shared with other processes.
The Average percentage of elapsed time that all of process threads used the processor
processor_time_avg_pct string 255 average
to execution instructions.
The Minimum percentage of elapsed time that all of process threads used the
processor_time_min_pct string 255 min
processor to execution instructions.
The Maximum percentage of elapsed time that all of process threads used the
processor_time_max_pct string 255 max
processor to execution instructions.
workingset_avg_b string 255 average The Average current size, in bytes, of the Working Set of this process
workingset_min_b string 255 min The Minimum current size, in bytes, of the Working Set of this process
workingset_max_b string 255 max The Maximum current size, in bytes, of the Working Set of this process
virtualbytes_avg_b double 24 average The Average current size, in bytes, of the virtual address space the process is using.
virtualbytes_min_b double 24 min The Minimum current size, in bytes, of the virtual address space the process is using.
virtualbytes_max_b double 24 max The Maximum current size, in bytes, of the virtual address space the process is using.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 773
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 774
AI Operations Management - Containerized 24.4
1.4.2.3.60. opsb_ad_process_1h
Description AD Process Monitoring Data (Hourly)
Source dataset opsb_ad_process
Data Aggregation
Column Name Size Description
Type Type
The Average rate at which page faults by the threads executing in this process are
pagefaults_avg_count_per_s string 255 average
occurring per second
The Minimum rate at which page faults by the threads executing in this process are
pagefaults_min_count_per_s string 255 min
occurring per second
The Maximum rate at which page faults by the threads executing in this process are
pagefaults_max_count_per_s string 255 max
occurring per second
The Average current size, in bytes, of memory that this process has allocated that
privatebytes_avg_b string 255 average
cannot be shared with other processes.
The Minimum current size, in bytes, of memory that this process has allocated that
privatebytes_min_b string 255 min
cannot be shared with other processes.
The Maximum current size, in bytes, of memory that this process has allocated that
privatebytes_max_b string 255 max
cannot be shared with other processes.
The Average percentage of elapsed time that all of process threads used the processor
processor_time_avg_pct string 255 average
to execution instructions.
The Minimum percentage of elapsed time that all of process threads used the
processor_time_min_pct string 255 min
processor to execution instructions.
The Maximum percentage of elapsed time that all of process threads used the
processor_time_max_pct string 255 max
processor to execution instructions.
workingset_avg_b string 255 average The Average current size, in bytes, of the Working Set of this process
workingset_min_b string 255 min The Minimum current size, in bytes, of the Working Set of this process
workingset_max_b string 255 max The Maximum current size, in bytes, of the Working Set of this process
virtualbytes_avg_b double 24 average The Average current size, in bytes, of the virtual address space the process is using.
virtualbytes_min_b double 24 min The Minimum current size, in bytes, of the virtual address space the process is using.
virtualbytes_max_b double 24 max The Maximum current size, in bytes, of the virtual address space the process is using.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 775
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 776
AI Operations Management - Containerized 24.4
1.4.2.3.61. opsb_ad_replication_latency
Description AD Replication Latency Monitoring Data
Key columns ad_server_fqdn, timestamp_utc_s, node_fqdn
Minimum among time interval between current time and last replication
LASTREPDELTAMIN last_rep_delta_min_min double 24
time in minutes for all the DCs with Connection Objects
Maximum among time interval between current time and last replication
LASTREPDELTAMAX last_rep_delta_max_min double 24
time in minutes for all the DCs with Connection Objects
Average of time interval between current time and last replication time in
LASTREPDELTAAVG last_rep_delta_avg_min double 24
minutes for all the DCs with Connection Objects
Time elapsed, in hours, since the last change to the OvReplication object of
LASTREPTIME last_rep_time_h double 24
the Source DC occured
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 777
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 778
AI Operations Management - Containerized 24.4
1.4.2.3.62. opsb_ad_replication_latency_1d
Description AD Replication Latency Monitoring Data (Daily)
Source dataset opsb_ad_replication_latency_1h
Data Aggregation
Column Name Size Description
Type Type
Minimum latency experienced in minutes during replication from all Dcs to which a
rep_latency_min_min lastval
connection object exists
Maximum latency experienced in minutes during replication from all Dcs to which a
rep_latency_max_min lastval
connection object exists
Average of latencies experienced in minutes during replication from all Dcs to which a
rep_latency_avg_min lastval
connection object exists
Minimum among time interval between current time and last replication time in minutes for
last_rep_delta_min_min lastval
all the DCs with Connection Objects
Maximum among time interval between current time and last replication time in minutes
last_rep_delta_max_min lastval
for all the DCs with Connection Objects
Average of time interval between current time and last replication time in minutes for all
last_rep_delta_avg_min lastval
the DCs with Connection Objects
Time elapsed, in hours, since the last change to the OvReplication object of the Source DC
last_rep_time_h double 24 lastval
occured
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 779
AI Operations Management - Containerized 24.4
1.4.2.3.63. opsb_ad_replication_latency_1h
Description AD Replication Latency Monitoring Data (Hourly)
Source dataset opsb_ad_replication_latency
Data Aggregation
Column Name Size Description
Type Type
Minimum latency experienced in minutes during replication from all Dcs to which a
rep_latency_min_min double 24 lastval
connection object exists
Maximum latency experienced in minutes during replication from all Dcs to which a
rep_latency_max_min double 24 lastval
connection object exists
Average of latencies experienced in minutes during replication from all Dcs to which a
rep_latency_avg_min double 24 lastval
connection object exists
Minimum among time interval between current time and last replication time in minutes for
last_rep_delta_min_min double 24 lastval
all the DCs with Connection Objects
Maximum among time interval between current time and last replication time in minutes
last_rep_delta_max_min double 24 lastval
for all the DCs with Connection Objects
Average of time interval between current time and last replication time in minutes for all
last_rep_delta_avg_min double 24 lastval
the DCs with Connection Objects
Time elapsed, in hours, since the last change to the OvReplication object of the Source DC
last_rep_time_h double 24 lastval
occured
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 780
AI Operations Management - Containerized 24.4
1.4.2.3.64. opsb_ad_response_time
Description AD Response Time Monitoring Data
Key columns ad_server_fqdn, dc_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 781
AI Operations Management - Containerized 24.4
1.4.2.3.65. opsb_ad_response_time_1d
Description AD Response Time Monitoring Data (Daily)
Source dataset opsb_ad_response_time_1h
Data Aggregation
Column Name Size Description
Type Type
The Average time required to bind to the Microsoft Active Directory on domain controller
bind_resp_time_avg_s double 24 average
in seconds.
The Minimum time required to bind to the Microsoft Active Directory on domain controller
bind_resp_time_min_s double 24 min
in seconds.
The Maximum time required to bind to the Microsoft Active Directory on domain controller
bind_resp_time_max_s double 24 max
in seconds.
The Average time required to query the Microsoft Active Directory on domain controller in
qry_resp_time_avg_s double 24 average
seconds.
The Minimum time required to query the Microsoft Active Directory on domain controller
qry_resp_time_min_s double 24 min
in seconds.
The Maximum time required to query the Microsoft Active Directory on domain controller
qry_resp_time_max_s double 24 max
in seconds.
gc_bind_resp_time_avg_s double 24 average The Average time required to bind to Global Catalog in seconds.
gc_bind_resp_time_min_s double 24 min The Minimum time required to bind to Global Catalog in seconds.
gc_bind_resp_time_max_s double 24 max The Maximum time required to bind to Global Catalog in seconds.
gc_qry_resp_time_avg_s double 24 average The Average time required to query Global Catalog in seconds.
gc_qry_resp_time_min_s double 24 min The Minimum time required to query Global Catalog in seconds.
gc_qry_resp_time_max_s double 24 max The Maximum time required to query Global Catalog in seconds.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding
version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 782
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 783
AI Operations Management - Containerized 24.4
1.4.2.3.66. opsb_ad_response_time_1h
Description AD Response Time Monitoring Data (Hourly)
Source dataset opsb_ad_response_time
Data Aggregation
Column Name Size Description
Type Type
The Average time required to bind to the Microsoft Active Directory on domain controller
bind_resp_time_avg_s double 24 average
in seconds.
The Minimum time required to bind to the Microsoft Active Directory on domain controller
bind_resp_time_min_s double 24 min
in seconds.
The Maximum time required to bind to the Microsoft Active Directory on domain controller
bind_resp_time_max_s double 24 max
in seconds.
The Average time required to query the Microsoft Active Directory on domain controller in
qry_resp_time_avg_s double 24 average
seconds.
The Minimum time required to query the Microsoft Active Directory on domain controller
qry_resp_time_min_s double 24 min
in seconds.
The Maximum time required to query the Microsoft Active Directory on domain controller
qry_resp_time_max_s double 24 max
in seconds.
gc_bind_resp_time_avg_s double 24 average The Average time required to bind to Global Catalog in seconds.
gc_bind_resp_time_min_s double 24 min The Minimum time required to bind to Global Catalog in seconds.
gc_bind_resp_time_max_s double 24 max The Maximum time required to bind to Global Catalog in seconds.
gc_qry_resp_time_avg_s double 24 average The Average time required to query Global Catalog in seconds.
gc_qry_resp_time_min_s double 24 min The Minimum time required to query Global Catalog in seconds.
gc_qry_resp_time_max_s double 24 max The Maximum time required to query Global Catalog in seconds.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding
version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 784
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 785
AI Operations Management - Containerized 24.4
1.4.2.3.67. opsb_ad_service_health
Description AD Services Health
Key columns ad_server_fqdn, svc_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 786
AI Operations Management - Containerized 24.4
1.4.2.3.68. opsb_ad_service_health_1d
Description AD Services Health Data (Daily)
Source dataset opsb_ad_service_health_1h
Data Aggregation
Column Name Size Description
Type Type
uptime_min double sum The time duration (in minutes) in an hour when the AD service is in running state.
uptime_avg_pct double avg The Average percentage of time in an hour when the AD service is in running state.
downtime_min double sum The time duration (in minutes) in an hour when the AD service is not in running state.
downtime_avg_pct double avg The Average percentage of time in an hour when the AD service is not in running state.
The time duration (in minutes) in an hour when the AD service not running due to AD
planned_downtime_min double sum
server planned outage.
The Average percentage of time in an hour when the AD service not running due to AD
planned_downtime_avg_pct double avg
server planned outage.
The time duration (in minutes) in an hour when the AD service state information not
unknown_time_min double sum
available due to unknown outage.
The Average percentage of time in an hour when the AD service state information not
unknown_time_avg_pct double avg
available due to unknown outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 787
AI Operations Management - Containerized 24.4
1.4.2.3.69. opsb_ad_service_health_1h
Description AD Services Health Hourly
Key columns ad_server_fqdn, svc_name, timestamp_utc_s, node_fqdn
The time duration (in minutes) in an hour when the AD service is not in
null downtime_min double
running state.
The time duration (in minutes) in an hour when the AD service not
null planned_downtime_min double
running due to AD server planned outage.
The percentage of time in an hour when the AD service not running due
null planned_downtime_pct double
to AD server planned outage.
The time duration (in minutes) in an hour when the AD service state
null unknown_time_min double
information not available due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 788
AI Operations Management - Containerized 24.4
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 789
AI Operations Management - Containerized 24.4
1.4.2.3.70. opsb_ad_smb_conn_status
Description AD SMB Connection Status
Key columns ad_server_fqdn, smb_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 790
AI Operations Management - Containerized 24.4
1.4.2.3.71. opsb_ad_smb_conn_status_1d
Description AD SMB Connection Status (Daily)
Source dataset opsb_ad_smb_conn_status_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 791
AI Operations Management - Containerized 24.4
1.4.2.3.72. opsb_ad_smb_conn_status_1h
Description AD SMB Connection Status
Source dataset opsb_ad_smb_conn_status
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 792
AI Operations Management - Containerized 24.4
1.4.2.3.73. opsb_ad_sysvol
Description AD SYSVOL Monitoring Data
Key columns ad_server_fqdn, sysvol_dir_path, timestamp_utc_s, node_fqdn
SYSPERCVALUE sysvol_disk_used_space_pct integer 24 The percentage of used space of the drive hosting Sysvol
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 793
AI Operations Management - Containerized 24.4
1.4.2.3.74. opsb_ad_sysvol_1d
Description AD SYSVOL Monitoring Data (Daily)
Source dataset opsb_ad_sysvol
Data Aggregation
Column Name Size Description
Type Type
sysvol_disk_used_space_avg_pct integer 24 average The Average percentage of used space of the drive hosting Sysvol
sysvol_disk_used_space_min_pct integer 24 min The Minimum percentage of used space of the drive hosting Sysvol
sysvol_disk_used_space_max_pct integer 24 max The Maximum percentage of used space of the drive hosting Sysvol
sysvol_disk_used_space_pctl_pct integer 24 90 percentile The Percentile of the percentage of used space of the drive hosting Sysvol
sysvol_disk_que_length_avg_count integer 24 average The Average queue length on the SYSVOL disk drive
sysvol_disk_que_length_min_count integer 24 min The Minimum queue length on the SYSVOL disk drive
sysvol_disk_que_length_max_count integer 24 max The Maximum queue length on the SYSVOL disk drive
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 794
AI Operations Management - Containerized 24.4
1.4.2.3.75. opsb_ad_sysvol_1h
Description AD SYSVOL Monitoring Data (Hourly)
Source dataset opsb_ad_sysvol
Data Aggregation
Column Name Size Description
Type Type
sysvol_disk_used_space_avg_pct integer 24 average The Average percentage of used space of the drive hosting Sysvol
sysvol_disk_used_space_min_pct integer 24 min The Minimum percentage of used space of the drive hosting Sysvol
sysvol_disk_used_space_max_pct integer 24 max The Maximum percentage of used space of the drive hosting Sysvol
sysvol_disk_used_space_pctl_pct integer 24 90 percentile The Percentile of the percentage of used space of the drive hosting Sysvol
sysvol_disk_que_length_avg_count integer 24 average The Average queue length on the SYSVOL disk drive
sysvol_disk_que_length_min_count integer 24 min The Minimum queue length on the SYSVOL disk drive
sysvol_disk_que_length_max_count integer 24 max The Maximum queue length on the SYSVOL disk drive
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 795
AI Operations Management - Containerized 24.4
1.4.2.3.76. opsb_ad_trust
Description AD Trust Data
Key columns ad_server_fqdn, timestamp_utc_s, node_fqdn
Trust change type can have one of the following values, 0 - addition of
CHANGETYPE change_type integer 24
trust, 1 - deletion of trust, and 2 - modification of a trust
Trust status can have one of the following values: 0 - no trust failure, else it
TRUSTSTATUS trust_status integer 24
contains the error code
Trust type can have one of the following values: 1 - an uplevel trust, 2 -
TRUSTTYPE trust_type integer 24
downlevel trust, 3 - Kerberos realm trust, and 4 - DCE
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 796
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 797
AI Operations Management - Containerized 24.4
1.4.2.3.77. opsb_ad_trust_1d
Description AD Trust Data (Daily)
Source dataset opsb_ad_trust_1h
Data Aggregation
Column Name Size Description
Type Type
Trust change type can have one of the following values, 0 - addition of trust, 1 - deletion of
change_type integer 24 lastval
trust, and 2 - modification of a trust
Trust direction can have one of the following values: 1 - inbound, 2 - outbound, and 3 - bi-
trust_direction integer 24 lastval
directional trust relationship
Trust status can have one of the following values: 0 - no trust failure, else it contains the
trust_status integer 24 lastval
error code
Trust type can have one of the following values: 1 - an uplevel trust, 2 - downlevel trust, 3 -
trust_type integer 24 lastval
Kerberos realm trust, and 4 - DCE
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 798
AI Operations Management - Containerized 24.4
1.4.2.3.78. opsb_ad_trust_1h
Description AD Trust Data (Hourly)
Source dataset opsb_ad_trust
Data Aggregation
Column Name Size Description
Type Type
Trust change type can have one of the following values, 0 - addition of trust, 1 - deletion of
change_type integer 24 lastval
trust, and 2 - modification of a trust
Trust direction can have one of the following values: 1 - inbound, 2 - outbound, and 3 - bi-
trust_direction integer 24 lastval
directional trust relationship
Trust status can have one of the following values: 0 - no trust failure, else it contains the
trust_status integer 24 lastval
error code
Trust type can have one of the following values: 1 - an uplevel trust, 2 - downlevel trust, 3 -
trust_type integer 24 lastval
Kerberos realm trust, and 4 - DCE
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 799
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 800
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 801
AI Operations Management - Containerized 24.4
1.4.2.4.1. opsb_exch_active_manager
Description Collects metrics for Exchange server Active Manager
Key columns exchange_server_fqdn, db_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 802
AI Operations Management - Containerized 24.4
1.4.2.4.2. opsb_exch_active_manager_1d
Description Collects metrics for Exchange server Active Manager (Daily)
Source dataset opsb_exch_active_manager_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 803
AI Operations Management - Containerized 24.4
1.4.2.4.3. opsb_exch_active_manager_1h
Description Collects metrics for Exchange server Active Manager (Hourly)
Source dataset opsb_exch_active_manager
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 804
AI Operations Management - Containerized 24.4
1.4.2.4.4. opsb_exch_activesync_connection
Description Collects the ActiveSync connection test results
Key columns exchange_server_fqdn, activesync_conn_key, timestamp_utc_s, node_fqdn
EXSPI_ACTKEY activesync_conn_key string 255 ActiveSync Connection Key to identify each test
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy. If
CollectionConfigName collection_policy_name string 255
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 805
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 806
AI Operations Management - Containerized 24.4
1.4.2.4.5. opsb_exch_activesync_connection_1d
Description Collects the ActiveSync connection test results (Daily)
Source dataset opsb_exch_activesync_connection_1h
Data Aggregation
Column Name Size Description
Type Type
activesync_latency_avg_ms integer 24 average The Average ActiveSync latency for the Client Access Server in milliseconds
activesync_latency_min_ms integer 24 min The Minimum ActiveSync latency for the Client Access Server in milliseconds
activesync_latency_max_ms integer 24 max The Maximum ActiveSync latency for the Client Access Server in milliseconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 807
AI Operations Management - Containerized 24.4
1.4.2.4.6. opsb_exch_activesync_connection_1h
Description Collects the ActiveSync connection test results (Hourly)
Source dataset opsb_exch_activesync_connection
Data Aggregation
Column Name Size Description
Type Type
activesync_latency_avg_ms integer 24 average The Average ActiveSync latency for the Client Access Server in milliseconds
activesync_latency_min_ms integer 24 min The Minimum ActiveSync latency for the Client Access Server in milliseconds
activesync_latency_max_ms integer 24 max The Maximum ActiveSync latency for the Client Access Server in milliseconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 808
AI Operations Management - Containerized 24.4
1.4.2.4.7. opsb_exch_activesync_perf
Description Collects performance counters for MS Exchange ActiveSync
Key columns exchange_server_fqdn, activesync_instance_name, timestamp_utc_s, node_fqdn
The average time (in milliseconds) that elapsed waiting for Ping and
ASYAVGHGTM hang_time_avg_ms double 24
Hanging Sync requests to complete
ASYPCMDPD ping_cmd_pending_count double 24 Number of Ping commands that are currently pending on the server
Number of HTTP requests that are received from the client via
ASYREQPSEC http_req_recvd_count_per_s double 24
ASP.NET per second
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 809
AI Operations Management - Containerized 24.4
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If
CollectionConfigName collection_policy_name string 255
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 810
AI Operations Management - Containerized 24.4
1.4.2.4.8. opsb_exch_activesync_perf_1d
Description Collects performance counters for MS Exchange ActiveSync (Daily)
Source dataset opsb_exch_activesync_perf_1h
Data Aggregation
Column Name Size Description
Type Type
The Average time (in milliseconds) that elapsed waiting for Ping and
hang_time_avg_ms average
Hanging Sync requests to complete
The Minimum average time (in milliseconds) that elapsed waiting for Ping
hang_time_avg_min_ms min
and Hanging Sync requests to complete
The Maximum average time (in milliseconds) that elapsed waiting for Ping
hang_time_avg_max_ms max
and Hanging Sync requests to complete
The Average time (in milliseconds) that it takes for a remote procedure call
activesync_rpc_latency_avg_ms average to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Minimum average time (in milliseconds) that it takes for a remote
activesync_rpc_latency_avg_min_ms min procedure call to return results from a Mailbox server, averaged over RPC
calls in the last minute
The Maximum average time (in milliseconds) that it takes for a remote
activesync_rpc_latency_avg_max_ms max procedure call to return results from a Mailbox server, averaged over RPC
calls in the last minute
The Average number of Ping commands per second whose connection to the
ping_cmd_dropped_avg_count_per_s double 24 average
client was dropped before a response could be issued
ping_cmd_pending_count double 24 lastval Number of Ping commands that are currently pending on the server
The Average number of Ping commands that are currently pending on the
ping_cmd_pending_avg_count double 24 average
server
The Minimum number of Ping commands that are currently pending on the
ping_cmd_pending_min_count double 24 min
server
The Maximum number of Ping commands that are currently pending on the
ping_cmd_pending_max_count double 24 max
server
The Average number of Ping commands that are processed by the server
ping_cmd_processed_avg_count_per_s double 24 average each second,This command is used to send clients notifications about new
e-mail messages or changed items.
The Minimum number of Ping commands that are processed by the server
ping_cmd_processed_min_count_per_s double 24 min each second,This command is used to send clients notifications about new
e-mail messages or changed items.
The Maximum number of Ping commands that are processed by the server
ping_cmd_processed_max_count_per_s double 24 max each second,This command is used to send clients notifications about new
e-mail messages or changed items.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 811
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Average number of HTTP requests that are received from the client via
http_req_recvd_avg_count_per_s double 24 average
ASP.NET per second
The Minimum number of HTTP requests that are received from the client via
http_req_recvd_min_count_per_s double 24 min
ASP.NET per second
The Maximum number of HTTP requests that are received from the client via
http_req_recvd_max_count_per_s double 24 max
ASP.NET per second
sync_cmd_pending_count double 24 lastval Number of Sync commands that are currently pending on the server.
The Average number of Sync commands that are currently pending on the
sync_cmd_pending_avg_count double 24 average
server.
The Minimum number of Sync commands that are currently pending on the
sync_cmd_pending_min_count double 24 min
server.
The Maximum number of Sync commands that are currently pending on the
sync_cmd_pending_max_count double 24 max
server.
The Average number of Sync commands that are processed per second.
sync_cmd_processed_avg_count_per_s double 24 average
Clients use this command to synchronize items within a folder
The Minimum number of Sync commands that are processed per second.
sync_cmd_processed_min_count_per_s double 24 min
Clients use this command to synchronize items within a folder
The Maximum number of Sync commands that are processed per second.
sync_cmd_processed_max_count_per_s double 24 max
Clients use this command to synchronize items within a folder
curr_http_req_avg_count double 24 average The Average number of HTTP requests received from ASP.NET
curr_http_req_min_count double 24 min The Minimum number of HTTP requests received from ASP.NET
curr_http_req_max_count double 24 max The Maximum number of HTTP requests received from ASP.NET
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 812
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
activesync_instance_name_id string 255 Instance Name of Exchange Server against which ActiveSync is performed
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 813
AI Operations Management - Containerized 24.4
1.4.2.4.9. opsb_exch_activesync_perf_1h
Description Collects performance counters for MS Exchange ActiveSync (Hourly)
Source dataset opsb_exch_activesync_perf
Data Aggregation
Column Name Size Description
Type Type
The Average time (in milliseconds) that elapsed waiting for Ping and
hang_time_avg_ms double 24 average
Hanging Sync requests to complete
The Minimum average time (in milliseconds) that elapsed waiting for Ping
hang_time_avg_min_ms double 24 min
and Hanging Sync requests to complete
The Maximum average time (in milliseconds) that elapsed waiting for Ping
hang_time_avg_max_ms double 24 max
and Hanging Sync requests to complete
The Average time (in milliseconds) that it takes for a remote procedure call
activesync_rpc_latency_avg_ms double 24 average to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Minimum average time (in milliseconds) that it takes for a remote
activesync_rpc_latency_avg_min_ms double 24 min procedure call to return results from a Mailbox server, averaged over RPC
calls in the last minute
The Maximum average time (in milliseconds) that it takes for a remote
activesync_rpc_latency_avg_max_ms double 24 max procedure call to return results from a Mailbox server, averaged over RPC
calls in the last minute
The Average number of Ping commands per second whose connection to the
ping_cmd_dropped_avg_count_per_s double 24 average
client was dropped before a response could be issued
ping_cmd_pending_count double 24 lastval Number of Ping commands that are currently pending on the server
The Average number of Ping commands that are currently pending on the
ping_cmd_pending_avg_count double 24 average
server
The Minimum number of Ping commands that are currently pending on the
ping_cmd_pending_min_count double 24 min
server
The Maximum number of Ping commands that are currently pending on the
ping_cmd_pending_max_count double 24 max
server
The Average number of Ping commands that are processed by the server
ping_cmd_processed_avg_count_per_s double 24 average each second,This command is used to send clients notifications about new
e-mail messages or changed items.
The Minimum number of Ping commands that are processed by the server
ping_cmd_processed_min_count_per_s double 24 min each second,This command is used to send clients notifications about new
e-mail messages or changed items.
The Maximum number of Ping commands that are processed by the server
ping_cmd_processed_max_count_per_s double 24 max each second,This command is used to send clients notifications about new
e-mail messages or changed items.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 814
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Average number of HTTP requests that are received from the client via
http_req_recvd_avg_count_per_s double 24 average
ASP.NET per second
The Minimum number of HTTP requests that are received from the client via
http_req_recvd_min_count_per_s double 24 min
ASP.NET per second
The Maximum number of HTTP requests that are received from the client via
http_req_recvd_max_count_per_s double 24 max
ASP.NET per second
sync_cmd_pending_count double 24 lastval Number of Sync commands that are currently pending on the server.
The Average number of Sync commands that are currently pending on the
sync_cmd_pending_avg_count double 24 average
server.
The Minimum number of Sync commands that are currently pending on the
sync_cmd_pending_min_count double 24 min
server.
The Maximum number of Sync commands that are currently pending on the
sync_cmd_pending_max_count double 24 max
server.
The Average number of Sync commands that are processed per second.
sync_cmd_processed_avg_count_per_s double 24 average
Clients use this command to synchronize items within a folder
The Minimum number of Sync commands that are processed per second.
sync_cmd_processed_min_count_per_s double 24 min
Clients use this command to synchronize items within a folder
The Maximum number of Sync commands that are processed per second.
sync_cmd_processed_max_count_per_s double 24 max
Clients use this command to synchronize items within a folder
curr_http_req_avg_count double 24 average The Average number of HTTP requests received from ASP.NET
curr_http_req_min_count double 24 min The Minimum number of HTTP requests received from ASP.NET
curr_http_req_max_count double 24 max The Maximum number of HTTP requests received from ASP.NET
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 815
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
activesync_instance_name_id string 255 Instance Name of Exchange Server against which ActiveSync is performed
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 816
AI Operations Management - Containerized 24.4
1.4.2.4.10. opsb_exch_asp_dotnet
Description Collects metrics for Active Server Pages
Key columns exchange_server_fqdn, asp_dotnet_instance_name, timestamp_utc_s, node_fqdn
APPRESTARTS app_restarts_count integer 24 Number of Application Restarts for Active Server Pages
WORKPROCRESTART worker_process_restarts_count integer 24 Number of Worker Process Restarts for Active Server Pages
REQWAITTIME req_wait_time_s integer 24 Request wait time in seconds for Active Server Pages
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 817
AI Operations Management - Containerized 24.4
1.4.2.4.11. opsb_exch_asp_dotnet_1d
Description Collects metrics for Active Server Pages (Daily)
Source dataset opsb_exch_asp_dotnet_1h
Data Aggregation
Column Name Size Description
Type Type
app_restarts_avg_count integer 24 average The Average number of Application Restarts for Active Server Pages
app_restarts_min_count integer 24 min The Minimum number of Application Restarts for Active Server Pages
app_restarts_max_count integer 24 max The Maximum number of Application Restarts for Active Server Pages
app_restarts_count integer 24 lastval Number of Application Restarts for Active Server Pages
worker_process_restarts_avg_count integer 24 average The Average number of Worker Process Restarts for Active Server Pages
worker_process_restarts_min_count integer 24 min The Minimum number of Worker Process Restarts for Active Server Pages
worker_process_restarts_max_count integer 24 max The Maximum number of Worker Process Restarts for Active Server Pages
worker_process_restarts_count integer 24 lastval Number of Worker Process Restarts for Active Server Pages
req_wait_time_avg_s integer 24 average The Average request wait time in seconds for Active Server Pages
req_wait_time_min_s integer 24 min The Minimum request wait time in seconds for Active Server Pages
req_wait_time_max_s integer 24 max The Maximum request wait time in seconds for Active Server Pages
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 818
AI Operations Management - Containerized 24.4
1.4.2.4.12. opsb_exch_asp_dotnet_1h
Description Collects metrics for Active Server Pages (Hourly)
Source dataset opsb_exch_asp_dotnet
Data Aggregation
Column Name Size Description
Type Type
app_restarts_avg_count integer 24 average The Average number of Application Restarts for Active Server Pages
app_restarts_min_count integer 24 min The Minimum number of Application Restarts for Active Server Pages
app_restarts_max_count integer 24 max The Maximum number of Application Restarts for Active Server Pages
app_restarts_count integer 24 lastval Number of Application Restarts for Active Server Pages
worker_process_restarts_avg_count integer 24 average The Average number of Worker Process Restarts for Active Server Pages
worker_process_restarts_min_count integer 24 min The Minimum number of Worker Process Restarts for Active Server Pages
worker_process_restarts_max_count integer 24 max The Maximum number of Worker Process Restarts for Active Server Pages
worker_process_restarts_count integer 24 lastval Number of Worker Process Restarts for Active Server Pages
req_wait_time_avg_s integer 24 average The Average request wait time in seconds for Active Server Pages
req_wait_time_min_s integer 24 min The Minimum request wait time in seconds for Active Server Pages
req_wait_time_max_s integer 24 max The Maximum request wait time in seconds for Active Server Pages
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 819
AI Operations Management - Containerized 24.4
1.4.2.4.13. opsb_exch_availability
Description Collects the details about Exchange Server availability
Key columns exchange_server_fqdn, exch_srv_role, timestamp_utc_s, node_fqdn
ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Exchange Server is a member
AVAILABILITY exch_srv_availability integer 24 Availability of the Exchange Server, 1 - available, 0 - not available
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 820
AI Operations Management - Containerized 24.4
1.4.2.4.14. opsb_exch_availability_1d
Description Collects the details about Exchange Server availability (Daily)
Source dataset opsb_exch_availability_1h
Data Aggregation
Column Name Size Description
Type Type
uptime_min double sum The time duration (in minutes) in a day when the Exchange server is in running state.
uptime_avg_pct double avg The Average percentage of time in a day when the Exchange server is in running state.
The time duration (in minutes) in a day when the Exchange server is not in running
downtime_min double sum
state.
The Average percentage of time in a day when the Exchange server is not in running
downtime_avg_pct double avg
state.
The time duration (in minutes) in a day when the Exchange server is not running due to
planned_downtime_min double sum
planned outage.
The Average percentage of time in a day when the Exchange server is not running due
planned_downtime_avg_pct double avg
to planned outage.
The time duration (in minutes) in a day when the Exchange server is not running due to
unknown_time_min double sum
unknown outage.
The Average percentage of time in a day when the Exchange server is not running due
unknown_time_avg_pct double avg
to unknown outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 821
AI Operations Management - Containerized 24.4
1.4.2.4.15. opsb_exch_availability_1h
Description Collects the details about Exchange Server availability (Hourly)
Key columns exchange_server_fqdn, exch_srv_role, timestamp_utc_s, node_fqdn
The time duration (in minutes) in a hour when the Exchange server is in
null uptime_min double
running state.
The time duration (in minutes) in a hour when the Exchange server is not
null downtime_min double
in running state.
The time duration (in minutes) in a hour when the Exchange server is not
null planned_downtime_min double
running due to planned outage.
The percentage of time in a hour when the Exchange server is not running
null planned_downtime_pct double
due to planned outage.
The time duration (in minutes) in a hour when the Exchange server is not
null unknown_time_min double
running due to unknown outage.
The percentage of time in a hour when the Exchange server is not running
null unknown_time_pct double
due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 822
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 823
AI Operations Management - Containerized 24.4
1.4.2.4.16. opsb_exch_blocked_emails
Description Collects details about blocked sender mails data
Key columns exchange_server_fqdn, blocked_email_msg_id, timestamp_utc_s, node_fqdn
SENDERADDRESS sender_address string 255 Sender email address of the blocked email
REASONDATA sender_reason_data string 255 Reason data for blocking the email.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 824
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 825
AI Operations Management - Containerized 24.4
1.4.2.4.17. opsb_exch_blocked_emails_1d
Description Collects details about blocked sender mails data (Daily)
Source dataset opsb_exch_blocked_emails_1h
Data Aggregation
Column Name Size Description
Type Type
sender_address string 255 lastval Sender email address of the blocked email
sender_reason_data string 255 lastval Reason data for blocking the email.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 826
AI Operations Management - Containerized 24.4
1.4.2.4.18. opsb_exch_blocked_emails_1h
Description Collects details about blocked sender mails data (Hourly)
Source dataset opsb_exch_blocked_emails
Data Aggregation
Column Name Size Description
Type Type
sender_address string 255 lastval Sender email address of the blocked email
sender_reason_data string 255 lastval Reason data for blocking the email.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 827
AI Operations Management - Containerized 24.4
1.4.2.4.19. opsb_exch_blocked_recipient
Description Collects details about blocked recipient mails data
Key columns exchange_server_fqdn, timestamp_utc_s, node_fqdn
REASONDATA recipient_reason_data string 255 Reason data for blocking the recipient
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 828
AI Operations Management - Containerized 24.4
1.4.2.4.20. opsb_exch_blocked_recipient_1d
Description Collects details about blocked recipient mails data (Daily)
Source dataset opsb_exch_blocked_recipient_1h
Data Aggregation
Column Name Size Description
Type Type
recipient_reason_data string 255 lastval Reason data for blocking the recipient
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 829
AI Operations Management - Containerized 24.4
1.4.2.4.21. opsb_exch_blocked_recipient_1h
Description Collects details about blocked recipient mails data (Hourly)
Source dataset opsb_exch_blocked_recipient
Data Aggregation
Column Name Size Description
Type Type
recipient_reason_data string 255 lastval Reason data for blocking the recipient
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 830
AI Operations Management - Containerized 24.4
1.4.2.4.22. opsb_exch_content_filter_agent
Description Collects performance counters for the Content Filter Agent
Key columns exchange_server_fqdn, content_filter_agent_instance_name, timestamp_utc_s, node_fqdn
SCANNED scanned_msg_count integer 24 The total number of messages scanned by Content Filter Agent
MSGBYPASSED scanning_bypassed_msg_count integer 24 The total number of messages that bypass scanning
MSGSCL0 scl_0_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 0
MSGSCL1 scl_1_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 1
MSGSCL2 scl_2_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 2
MSGSCL3 scl_3_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 3
MSGSCL4 scl_4_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 4
MSGSCL5 scl_5_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 5
MSGSCL6 scl_6_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 6
MSGSCL7 scl_7_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 7
MSGSCL8 scl_8_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 8
MSGSCL9 scl_9_rating_msg_count integer 24 The total number of messages assigned an SCL rating of 9
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 831
AI Operations Management - Containerized 24.4
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 832
AI Operations Management - Containerized 24.4
1.4.2.4.23. opsb_exch_content_filter_agent_1d
Description Collects performance counters for the Content Filter Agent (Daily)
Source dataset opsb_exch_content_filter_agent_1h
Data Aggregation
Column Name Size Description
Type Type
The total number of messages that were deleted using the Content Filter
del_msg_count integer 24 lastval
Agent
The Average total number of messages that were deleted using the Content
del_msg_avg_count integer 24 average
Filter Agent
The Minimum total number of messages that were deleted using the Content
del_msg_min_count integer 24 min
Filter Agent
The Maximum total number of messages that were deleted using the
del_msg_max_count integer 24 max
Content Filter Agent
The total number of messages that were quarantined using the Content
quarantined_msg_count integer 24 lastval
Filter Agent
The Average total number of messages that were quarantined using the
quarantined_msg_avg_count integer 24 average
Content Filter Agent
The Minimum total number of messages that were quarantined using the
quarantined_msg_min_count integer 24 min
Content Filter Agent
The Maximum total number of messages that were quarantined using the
quarantined_msg_max_count integer 24 max
Content Filter Agent
rejected_msg_count integer 24 lastval The total number of messages that were rejected by Content Filter Agent
The Average total number of messages that were rejected by Content Filter
rejected_msg_avg_count integer 24 average
Agent
The Minimum total number of messages that were rejected by Content Filter
rejected_msg_min_count integer 24 min
Agent
The Maximum total number of messages that were rejected by Content Filter
rejected_msg_max_count integer 24 max
Agent
scanned_msg_count integer 24 lastval The total number of messages scanned by Content Filter Agent
scanned_msg_avg_count integer 24 average The Average total number of messages scanned by Content Filter Agent
scanned_msg_min_count integer 24 min The Minimum total number of messages scanned by Content Filter Agent
scanned_msg_max_count integer 24 max The Maximum total number of messages scanned by Content Filter Agent
scanning_bypassed_msg_count integer 24 lastval The total number of messages that bypass scanning
scanning_bypassed_msg_avg_count integer 24 average The Average total number of messages that bypass scanning
scanning_bypassed_msg_min_count integer 24 min The Minimum total number of messages that bypass scanning
scanning_bypassed_msg_max_count integer 24 max The Maximum total number of messages that bypass scanning
scl_0_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 0
scl_0_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 0
scl_0_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 0
scl_0_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 0
scl_1_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 1
scl_1_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 1
scl_1_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 1
scl_1_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 1
scl_2_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 2
scl_2_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 2
scl_2_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 2
scl_2_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 2
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 833
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
scl_3_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 3
scl_3_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 3
scl_3_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 3
scl_3_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 3
scl_4_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 4
scl_4_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 4
scl_4_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 4
scl_4_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 4
scl_5_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 5
scl_5_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 5
scl_5_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 5
scl_5_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 5
scl_6_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 6
scl_6_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 6
scl_6_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 6
scl_6_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 6
scl_7_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 7
scl_7_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 7
scl_7_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 7
scl_7_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 7
scl_8_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 8
scl_8_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 8
scl_8_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 8
scl_8_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 8
scl_9_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 9
scl_9_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 9
scl_9_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 9
scl_9_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 9
scl_unknown_msg_count integer 24 lastval The total number of messages that could not be scanned by the filter
The Average total number of messages that could not be scanned by the
scl_unknown_msg_avg_count integer 24 average
filter
The Minimum total number of messages that could not be scanned by the
scl_unknown_msg_min_count integer 24 min
filter
The Maximum total number of messages that could not be scanned by the
scl_unknown_msg_max_count integer 24 max
filter
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 834
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 835
AI Operations Management - Containerized 24.4
1.4.2.4.24. opsb_exch_content_filter_agent_1h
Description Collects performance counters for the Content Filter Agent (Hourly)
Source dataset opsb_exch_content_filter_agent
Data Aggregation
Column Name Size Description
Type Type
The total number of messages that were deleted using the Content Filter
del_msg_count integer 24 lastval
Agent
The Average total number of messages that were deleted using the Content
del_msg_avg_count integer 24 average
Filter Agent
The Minimum total number of messages that were deleted using the Content
del_msg_min_count integer 24 min
Filter Agent
The Maximum total number of messages that were deleted using the
del_msg_max_count integer 24 max
Content Filter Agent
The total number of messages that were quarantined using the Content
quarantined_msg_count integer 24 lastval
Filter Agent
The Average total number of messages that were quarantined using the
quarantined_msg_avg_count integer 24 average
Content Filter Agent
The Minimum total number of messages that were quarantined using the
quarantined_msg_min_count integer 24 min
Content Filter Agent
The Maximum total number of messages that were quarantined using the
quarantined_msg_max_count integer 24 max
Content Filter Agent
rejected_msg_count integer 24 lastval The total number of messages that were rejected by Content Filter Agent
The Average total number of messages that were rejected by Content Filter
rejected_msg_avg_count integer 24 average
Agent
The Minimum total number of messages that were rejected by Content Filter
rejected_msg_min_count integer 24 min
Agent
The Maximum total number of messages that were rejected by Content Filter
rejected_msg_max_count integer 24 max
Agent
scanned_msg_count integer 24 lastval The total number of messages scanned by Content Filter Agent
scanned_msg_avg_count integer 24 average The Average total number of messages scanned by Content Filter Agent
scanned_msg_min_count integer 24 min The Minimum total number of messages scanned by Content Filter Agent
scanned_msg_max_count integer 24 max The Maximum total number of messages scanned by Content Filter Agent
scanning_bypassed_msg_count integer 24 lastval The total number of messages that bypass scanning
scanning_bypassed_msg_avg_count integer 24 average The Average total number of messages that bypass scanning
scanning_bypassed_msg_min_count integer 24 min The Minimum total number of messages that bypass scanning
scanning_bypassed_msg_max_count integer 24 max The Maximum total number of messages that bypass scanning
scl_0_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 0
scl_0_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 0
scl_0_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 0
scl_0_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 0
scl_1_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 1
scl_1_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 1
scl_1_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 1
scl_1_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 1
scl_2_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 2
scl_2_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 2
scl_2_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 2
scl_2_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 2
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 836
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
scl_3_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 3
scl_3_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 3
scl_3_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 3
scl_3_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 3
scl_4_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 4
scl_4_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 4
scl_4_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 4
scl_4_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 4
scl_5_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 5
scl_5_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 5
scl_5_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 5
scl_5_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 5
scl_6_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 6
scl_6_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 6
scl_6_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 6
scl_6_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 6
scl_7_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 7
scl_7_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 7
scl_7_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 7
scl_7_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 7
scl_8_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 8
scl_8_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 8
scl_8_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 8
scl_8_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 8
scl_9_rating_msg_count integer 24 lastval The total number of messages assigned an SCL rating of 9
scl_9_rating_msg_avg_count integer 24 average The Average total number of messages assigned an SCL rating of 9
scl_9_rating_msg_min_count integer 24 min The Minimum total number of messages assigned an SCL rating of 9
scl_9_rating_msg_max_count integer 24 max The Maximum total number of messages assigned an SCL rating of 9
scl_unknown_msg_count integer 24 lastval The total number of messages that could not be scanned by the filter
The Average total number of messages that could not be scanned by the
scl_unknown_msg_avg_count integer 24 average
filter
The Minimum total number of messages that could not be scanned by the
scl_unknown_msg_min_count integer 24 min
filter
The Maximum total number of messages that could not be scanned by the
scl_unknown_msg_max_count integer 24 max
filter
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 837
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 838
AI Operations Management - Containerized 24.4
1.4.2.4.25. opsb_exch_eac
Description Monitors Exchange Admin Center metrics
Key columns exchange_server_fqdn, access_to_eac_url_srvname, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 839
AI Operations Management - Containerized 24.4
1.4.2.4.26. opsb_exch_hub_transport_dsn
Description Collects performance counters for DSNs generated from the Edge Transport server
Key columns exchange_server_fqdn, dsn_instance_name, timestamp_utc_s, node_fqdn
DELAY_DSNS delay_dsn_count integer 24 Number of delay delivery status notifications that have been generated
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 840
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 841
AI Operations Management - Containerized 24.4
1.4.2.4.27. opsb_exch_hub_transport_dsn_1d
Description Collects performance counters for DSNs generated from the Edge Transport server (Daily)
Source dataset opsb_exch_hub_transport_dsn_1h
Data Aggregation
Column Name Size Description
Type Type
failure_dsn_count integer 24 lastval Number of failure delivery status notifications (DSNs) that have been generated
The Average number of failure delivery status notifications (DSNs) that have been
failure_dsn_avg_count integer 24 average
generated
The Minimum number of failure delivery status notifications (DSNs) that have been
failure_dsn_min_count integer 24 min
generated
The Maximum number of failure delivery status notifications (DSNs) that have been
failure_dsn_max_count integer 24 max
generated
delay_dsn_count integer 24 lastval Number of delay delivery status notifications that have been generated
delay_dsn_avg_count integer 24 average The Average number of delay delivery status notifications that have been generated
The Minimum number of delay delivery status notifications that have been
delay_dsn_min_count integer 24 min
generated
The Maximum number of delay delivery status notifications that have been
delay_dsn_max_count integer 24 max
generated
relay_dsn_avg_count integer 24 average The Average number of relay delivery status notifications generated
relay_dsn_min_count integer 24 min The Minimum number of relay delivery status notifications generated
relay_dsn_max_count integer 24 max The Maximum number of relay delivery status notifications generated
delivered_dsn_avg_count integer 24 average The Average number of delivered DSNs(delivery status notification) generated.
delivered_dsn_min_count integer 24 min The Minimum number of delivered DSNs(delivery status notification) generated.
delivered_dsn_max_count integer 24 max The Maximum number of delivered DSNs(delivery status notification) generated.
expanded_dsn_avg_count integer 24 average The Average number of expanded delivery status notifications generated
expanded_dsn_min_count integer 24 min The Minimum number of expanded delivery status notifications generated
expanded_dsn_max_count integer 24 max The Maximum number of expanded delivery status notifications generated
The Average number of failure delivery status notifications (DSNs) that have been
failure_dsn_avg_count_per_h double 24 average
generated within the last hour
The Minimum number of failure delivery status notifications (DSNs) that have been
failure_dsn_min_count_per_h double 24 min
generated within the last hour
The Maximum number of failure delivery status notifications (DSNs) that have been
failure_dsn_max_count_per_h double 24 max
generated within the last hour
The Average number of delayed delivery status notifications (DSNs) that have been
delayed_dsn_avg_count_per_h double 24 average
generated within the last hour
The Minimum number of delayed delivery status notifications (DSNs) that have been
delayed_dsn_min_count_per_h double 24 min
generated within the last hour
The Maximum number of delayed delivery status notifications (DSNs) that have been
delayed_dsn_max_count_per_h double 24 max
generated within the last hour
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 842
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 843
AI Operations Management - Containerized 24.4
1.4.2.4.28. opsb_exch_hub_transport_dsn_1h
Description Collects performance counters for DSNs generated from the Edge Transport server (Hourly)
Source dataset opsb_exch_hub_transport_dsn
Data Aggregation
Column Name Size Description
Type Type
failure_dsn_count integer 24 lastval Number of failure delivery status notifications (DSNs) that have been generated
The Average number of failure delivery status notifications (DSNs) that have been
failure_dsn_avg_count integer 24 average
generated
The Minimum number of failure delivery status notifications (DSNs) that have been
failure_dsn_min_count integer 24 min
generated
The Maximum number of failure delivery status notifications (DSNs) that have been
failure_dsn_max_count integer 24 max
generated
delay_dsn_count integer 24 lastval Number of delay delivery status notifications that have been generated
delay_dsn_avg_count integer 24 average The Average number of delay delivery status notifications that have been generated
The Minimum number of delay delivery status notifications that have been
delay_dsn_min_count integer 24 min
generated
The Maximum number of delay delivery status notifications that have been
delay_dsn_max_count integer 24 max
generated
relay_dsn_avg_count integer 24 average The Average number of relay delivery status notifications generated
relay_dsn_min_count integer 24 min The Minimum number of relay delivery status notifications generated
relay_dsn_max_count integer 24 max The Maximum number of relay delivery status notifications generated
delivered_dsn_avg_count integer 24 average The Average number of delivered DSNs(delivery status notification) generated.
delivered_dsn_min_count integer 24 min The Minimum number of delivered DSNs(delivery status notification) generated.
delivered_dsn_max_count integer 24 max The Maximum number of delivered DSNs(delivery status notification) generated.
expanded_dsn_avg_count integer 24 average The Average number of expanded delivery status notifications generated
expanded_dsn_min_count integer 24 min The Minimum number of expanded delivery status notifications generated
expanded_dsn_max_count integer 24 max The Maximum number of expanded delivery status notifications generated
The Average number of failure delivery status notifications (DSNs) that have been
failure_dsn_avg_count_per_h double 24 average
generated within the last hour
The Minimum number of failure delivery status notifications (DSNs) that have been
failure_dsn_min_count_per_h double 24 min
generated within the last hour
The Maximum number of failure delivery status notifications (DSNs) that have been
failure_dsn_max_count_per_h double 24 max
generated within the last hour
The Average number of delayed delivery status notifications (DSNs) that have been
delayed_dsn_avg_count_per_h double 24 average
generated within the last hour
The Minimum number of delayed delivery status notifications (DSNs) that have been
delayed_dsn_min_count_per_h double 24 min
generated within the last hour
The Maximum number of delayed delivery status notifications (DSNs) that have been
delayed_dsn_max_count_per_h double 24 max
generated within the last hour
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 844
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 845
AI Operations Management - Containerized 24.4
1.4.2.4.29. opsb_exch_imap4_perf
Description Collects performance counters for IMAP4 services
Key columns exchange_server_fqdn, imap4_instance_name, timestamp_utc_s, node_fqdn
IMAP4REJECTEDCON rejected_conn_count integer 24 Total number of IMAP4 Connections that are Rejected
POP3CONCUR curr_open_conn_count integer 24 Number of connections that are currently open on the IMAP4 service
POP3UATHCN unauth_conn_count_per_s double 24 Number of unauthenticated connections that occur per second
IMAP4CURCN curr_proxy_conn_count integer 24 Number of proxy connections that are currently open on the POP service
Number of proxy connections that have failed since the POP service was
POP3CNFAIL failed_proxy_conn_count integer 24
started
The total number of proxy connections that have been opened since the
POP3TTLCN total_proxy_conn_count integer 24
POP service was started
Number of SSL or TLS connections that are currently open on the IMAP4
POP3ACTSSL active_ssl_conn_count integer 24
service
The total number of SSL or TLS connections that have been opened
IMAP4SSLCN total_opened_ssl_conn_count integer 24
since the IMAP4 service was started
The number of AUTH commands that have failed since the IMAP4 service
IMAP4ATHFL auth_cmds_fail_count integer 24
was started
The total number of AUTH commands that have been received since the
IMAP4ATHTTL auth_cmds_recvd_count integer 24
IMAP4 service was started
The number of DELE commands that have failed since the IMAP4 service
IMAP4DELFL del_cmds_fail_count integer 24
was started
The total number of DELE commands that have been received since the
IMAP4DELTTL del_cmd_count integer 24
IMAP4 service was started
The number of requests that have failed since the IMAP4 service was
IMAP4REQFL failed_req_count integer 24
started
Total number of requests that have been received since the IMAP4
IMAP4REQTTL received_request_count integer 24
service was started
The average time, in milliseconds, that it takes for an LDAP call to return
POP3LDPLAT ldap_latency_avg_ms double 24 results from a domain controller, averaged over LDAP calls in the last
minute
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 846
AI Operations Management - Containerized 24.4
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 847
AI Operations Management - Containerized 24.4
1.4.2.4.30. opsb_exch_imap4_perf_1d
Description Collects performance counters for IMAP4 services (Daily)
Source dataset opsb_exch_imap4_perf_1h
Data Aggregation
Column Name Size Description
Type Type
rejected_conn_count integer 24 lastval Total number of IMAP4 Connections that are Rejected
rejected_conn_avg_count integer 24 average The Average total number of IMAP4 Connections that are Rejected
rejected_conn_min_count integer 24 min The Minimum total number of IMAP4 Connections that are Rejected
rejected_conn_max_count integer 24 max The Maximum total number of IMAP4 Connections that are Rejected
The Average connections rate is the number of IMAP4 connections that occur per
conns_avg_count_per_s double 24 average
second
The Minimum connections rate is the number of IMAP4 connections that occur
conns_min_count_per_s double 24 min
per second
The Maximum connections rate is the number of IMAP4 connections that occur
conns_max_count_per_s double 24 max
per second
curr_open_conn_count integer 24 lastval Number of connections that are currently open on the IMAP4 service
curr_open_conn_avg_count integer 24 average The Average number of connections that are currently open on the IMAP4 service
The Minimum number of connections that are currently open on the IMAP4
curr_open_conn_min_count integer 24 min
service
The Maximum number of connections that are currently open on the IMAP4
curr_open_conn_max_count integer 24 max
service
unauth_conn_avg_count_per_s double 24 average The Average number of unauthenticated connections that occur per second
unauth_conn_min_count_per_s double 24 min The Minimum number of unauthenticated connections that occur per second
unauth_conn_max_count_per_s double 24 max The Maximum number of unauthenticated connections that occur per second
curr_proxy_conn_count integer 24 lastval Number of proxy connections that are currently open on the POP service
The Average number of proxy connections that are currently open on the POP
curr_proxy_conn_avg_count integer 24 average
service
The Minimum number of proxy connections that are currently open on the POP
curr_proxy_conn_min_count integer 24 min
service
The Maximum number of proxy connections that are currently open on the POP
curr_proxy_conn_max_count integer 24 max
service
failed_proxy_conn_count integer 24 lastval Number of proxy connections that have failed since the POP service was started
The Average number of proxy connections that have failed since the POP service
failed_proxy_conn_avg_count integer 24 average
was started
The Minimum number of proxy connections that have failed since the POP service
failed_proxy_conn_min_count integer 24 min
was started
The Maximum number of proxy connections that have failed since the POP
failed_proxy_conn_max_count integer 24 max
service was started
The total number of proxy connections that have been opened since the POP
total_proxy_conn_count integer 24 lastval
service was started
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 848
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Average total number of proxy connections that have been opened since the
total_proxy_conn_avg_count integer 24 average
POP service was started
The Minimum total number of proxy connections that have been opened since
total_proxy_conn_min_count integer 24 min
the POP service was started
The Maximum total number of proxy connections that have been opened since
total_proxy_conn_max_count integer 24 max
the POP service was started
active_ssl_conn_count integer 24 lastval Number of SSL or TLS connections that are currently open on the IMAP4 service
The Average number of SSL or TLS connections that are currently open on the
active_ssl_conn_avg_count integer 24 average
IMAP4 service
The Minimum number of SSL or TLS connections that are currently open on the
active_ssl_conn_min_count integer 24 min
IMAP4 service
The Maximum number of SSL or TLS connections that are currently open on the
active_ssl_conn_max_count integer 24 max
IMAP4 service
The total number of SSL or TLS connections that have been opened since the
total_opened_ssl_conn_count integer 24 lastval
IMAP4 service was started
The Average total number of SSL or TLS connections that have been opened
total_opened_ssl_conn_avg_count integer 24 average
since the IMAP4 service was started
The Minimum total number of SSL or TLS connections that have been opened
total_opened_ssl_conn_min_count integer 24 min
since the IMAP4 service was started
The Maximum total number of SSL or TLS connections that have been opened
total_opened_ssl_conn_max_count integer 24 max
since the IMAP4 service was started
The number of AUTH commands that have failed since the IMAP4 service was
auth_cmds_fail_count integer 24 lastval
started
The Average number of AUTH commands that have failed since the IMAP4
auth_cmds_fail_avg_count integer 24 average
service was started
The Minimum number of AUTH commands that have failed since the IMAP4
auth_cmds_fail_min_count integer 24 min
service was started
The Maximum number of AUTH commands that have failed since the IMAP4
auth_cmds_fail_max_count integer 24 max
service was started
auth_cmds_avg_count_per_s double 24 average The Average number of AUTH commands per second
auth_cmds_min_count_per_s double 24 min The Minimum number of AUTH commands per second
auth_cmds_max_count_per_s double 24 max The Maximum number of AUTH commands per second
The total number of AUTH commands that have been received since the IMAP4
auth_cmds_recvd_count integer 24 lastval
service was started
The Average total number of AUTH commands that have been received since the
auth_cmds_recvd_avg_count integer 24 average
IMAP4 service was started
The Minimum total number of AUTH commands that have been received since
auth_cmds_recvd_min_count integer 24 min
the IMAP4 service was started
The Maximum total number of AUTH commands that have been received since
auth_cmds_recvd_max_count integer 24 max
the IMAP4 service was started
The number of DELE commands that have failed since the IMAP4 service was
del_cmds_fail_count integer 24 lastval
started
The Average number of DELE commands that have failed since the IMAP4 service
del_cmds_fail_avg_count integer 24 average
was started
The Minimum number of DELE commands that have failed since the IMAP4
del_cmds_fail_min_count integer 24 min
service was started
The Maximum number of DELE commands that have failed since the IMAP4
del_cmds_fail_max_count integer 24 max
service was started
del_cmds_fail_avg_count_per_s double 24 average The Average number of DELE commands per second
del_cmds_fail_min_count_per_s double 24 min The Minimum number of DELE commands per second
del_cmds_fail_max_count_per_s double 24 max The Maximum number of DELE commands per second
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 849
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The total number of DELE commands that have been received since the IMAP4
del_cmd_count integer 24 lastval
service was started
The Average total number of DELE commands that have been received since the
del_cmd_avg_count integer 24 average
IMAP4 service was started
The Minimum total number of DELE commands that have been received since the
del_cmd_min_count integer 24 min
IMAP4 service was started
The Maximum total number of DELE commands that have been received since
del_cmd_max_count integer 24 max
the IMAP4 service was started
failed_req_count integer 24 lastval The number of requests that have failed since the IMAP4 service was started
The Average number of requests that have failed since the IMAP4 service was
failed_req_avg_count integer 24 average
started
The Minimum number of requests that have failed since the IMAP4 service was
failed_req_min_count integer 24 min
started
The Maximum number of requests that have failed since the IMAP4 service was
failed_req_max_count integer 24 max
started
Total number of requests that have been received since the IMAP4 service was
received_request_count integer 24 lastval
started
The Average total number of requests that have been received since the IMAP4
received_request_avg_count integer 24 average
service was started
The Minimum total number of requests that have been received since the IMAP4
received_request_min_count integer 24 min
service was started
The Maximum total number of requests that have been received since the IMAP4
received_request_max_count integer 24 max
service was started
The Average time, in milliseconds, that it takes for a remote procedure call to
imap4_rpc_latency_avg_ms average
return results from a Mailbox server, averaged over RPC calls in the last minute
The Minimum average time, in milliseconds, that it takes for a remote procedure
imap4_rpc_latency_avg_min_ms min call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Maximum average time, in milliseconds, that it takes for a remote procedure
imap4_rpc_latency_avg_max_ms max call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Average time, in milliseconds, that it takes for an LDAP call to return results
ldap_latency_avg_ms average
from a domain controller, averaged over LDAP calls in the last minute
The Minimum average time, in milliseconds, that it takes for an LDAP call to
ldap_latency_avg_min_ms min return results from a domain controller, averaged over LDAP calls in the last
minute
The Maximum average time, in milliseconds, that it takes for an LDAP call to
ldap_latency_avg_max_ms max return results from a domain controller, averaged over LDAP calls in the last
minute
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 850
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 851
AI Operations Management - Containerized 24.4
1.4.2.4.31. opsb_exch_imap4_perf_1h
Description Collects performance counters for IMAP4 services (Hourly)
Source dataset opsb_exch_imap4_perf
Data Aggregation
Column Name Size Description
Type Type
rejected_conn_count integer 24 lastval Total number of IMAP4 Connections that are Rejected
rejected_conn_avg_count integer 24 average The Average total number of IMAP4 Connections that are Rejected
rejected_conn_min_count integer 24 min The Minimum total number of IMAP4 Connections that are Rejected
rejected_conn_max_count integer 24 max The Maximum total number of IMAP4 Connections that are Rejected
The Average connections rate is the number of IMAP4 connections that occur per
conns_avg_count_per_s double 24 average
second
The Minimum connections rate is the number of IMAP4 connections that occur
conns_min_count_per_s double 24 min
per second
The Maximum connections rate is the number of IMAP4 connections that occur
conns_max_count_per_s double 24 max
per second
curr_open_conn_count integer 24 lastval Number of connections that are currently open on the IMAP4 service
curr_open_conn_avg_count integer 24 average The Average number of connections that are currently open on the IMAP4 service
The Minimum number of connections that are currently open on the IMAP4
curr_open_conn_min_count integer 24 min
service
The Maximum number of connections that are currently open on the IMAP4
curr_open_conn_max_count integer 24 max
service
unauth_conn_avg_count_per_s double 24 average The Average number of unauthenticated connections that occur per second
unauth_conn_min_count_per_s double 24 min The Minimum number of unauthenticated connections that occur per second
unauth_conn_max_count_per_s double 24 max The Maximum number of unauthenticated connections that occur per second
curr_proxy_conn_count integer 24 lastval Number of proxy connections that are currently open on the POP service
The Average number of proxy connections that are currently open on the POP
curr_proxy_conn_avg_count integer 24 average
service
The Minimum number of proxy connections that are currently open on the POP
curr_proxy_conn_min_count integer 24 min
service
The Maximum number of proxy connections that are currently open on the POP
curr_proxy_conn_max_count integer 24 max
service
failed_proxy_conn_count integer 24 lastval Number of proxy connections that have failed since the POP service was started
The Average number of proxy connections that have failed since the POP service
failed_proxy_conn_avg_count integer 24 average
was started
The Minimum number of proxy connections that have failed since the POP service
failed_proxy_conn_min_count integer 24 min
was started
The Maximum number of proxy connections that have failed since the POP
failed_proxy_conn_max_count integer 24 max
service was started
The total number of proxy connections that have been opened since the POP
total_proxy_conn_count integer 24 lastval
service was started
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 852
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Average total number of proxy connections that have been opened since the
total_proxy_conn_avg_count integer 24 average
POP service was started
The Minimum total number of proxy connections that have been opened since
total_proxy_conn_min_count integer 24 min
the POP service was started
The Maximum total number of proxy connections that have been opened since
total_proxy_conn_max_count integer 24 max
the POP service was started
active_ssl_conn_count integer 24 lastval Number of SSL or TLS connections that are currently open on the IMAP4 service
The Average number of SSL or TLS connections that are currently open on the
active_ssl_conn_avg_count integer 24 average
IMAP4 service
The Minimum number of SSL or TLS connections that are currently open on the
active_ssl_conn_min_count integer 24 min
IMAP4 service
The Maximum number of SSL or TLS connections that are currently open on the
active_ssl_conn_max_count integer 24 max
IMAP4 service
The total number of SSL or TLS connections that have been opened since the
total_opened_ssl_conn_count integer 24 lastval
IMAP4 service was started
The Average total number of SSL or TLS connections that have been opened
total_opened_ssl_conn_avg_count integer 24 average
since the IMAP4 service was started
The Minimum total number of SSL or TLS connections that have been opened
total_opened_ssl_conn_min_count integer 24 min
since the IMAP4 service was started
The Maximum total number of SSL or TLS connections that have been opened
total_opened_ssl_conn_max_count integer 24 max
since the IMAP4 service was started
The number of AUTH commands that have failed since the IMAP4 service was
auth_cmds_fail_count integer 24 lastval
started
The Average number of AUTH commands that have failed since the IMAP4
auth_cmds_fail_avg_count integer 24 average
service was started
The Minimum number of AUTH commands that have failed since the IMAP4
auth_cmds_fail_min_count integer 24 min
service was started
The Maximum number of AUTH commands that have failed since the IMAP4
auth_cmds_fail_max_count integer 24 max
service was started
auth_cmds_avg_count_per_s double 24 average The Average number of AUTH commands per second
auth_cmds_min_count_per_s double 24 min The Minimum number of AUTH commands per second
auth_cmds_max_count_per_s double 24 max The Maximum number of AUTH commands per second
The total number of AUTH commands that have been received since the IMAP4
auth_cmds_recvd_count integer 24 lastval
service was started
The Average total number of AUTH commands that have been received since the
auth_cmds_recvd_avg_count integer 24 average
IMAP4 service was started
The Minimum total number of AUTH commands that have been received since
auth_cmds_recvd_min_count integer 24 min
the IMAP4 service was started
The Maximum total number of AUTH commands that have been received since
auth_cmds_recvd_max_count integer 24 max
the IMAP4 service was started
The number of DELE commands that have failed since the IMAP4 service was
del_cmds_fail_count integer 24 lastval
started
The Average number of DELE commands that have failed since the IMAP4 service
del_cmds_fail_avg_count integer 24 average
was started
The Minimum number of DELE commands that have failed since the IMAP4
del_cmds_fail_min_count integer 24 min
service was started
The Maximum number of DELE commands that have failed since the IMAP4
del_cmds_fail_max_count integer 24 max
service was started
del_cmds_fail_avg_count_per_s double 24 average The Average number of DELE commands per second
del_cmds_fail_min_count_per_s double 24 min The Minimum number of DELE commands per second
del_cmds_fail_max_count_per_s double 24 max The Maximum number of DELE commands per second
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 853
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The total number of DELE commands that have been received since the IMAP4
del_cmd_count integer 24 lastval
service was started
The Average total number of DELE commands that have been received since the
del_cmd_avg_count integer 24 average
IMAP4 service was started
The Minimum total number of DELE commands that have been received since the
del_cmd_min_count integer 24 min
IMAP4 service was started
The Maximum total number of DELE commands that have been received since
del_cmd_max_count integer 24 max
the IMAP4 service was started
failed_req_count integer 24 lastval The number of requests that have failed since the IMAP4 service was started
The Average number of requests that have failed since the IMAP4 service was
failed_req_avg_count integer 24 average
started
The Minimum number of requests that have failed since the IMAP4 service was
failed_req_min_count integer 24 min
started
The Maximum number of requests that have failed since the IMAP4 service was
failed_req_max_count integer 24 max
started
Total number of requests that have been received since the IMAP4 service was
received_request_count integer 24 lastval
started
The Average total number of requests that have been received since the IMAP4
received_request_avg_count integer 24 average
service was started
The Minimum total number of requests that have been received since the IMAP4
received_request_min_count integer 24 min
service was started
The Maximum total number of requests that have been received since the IMAP4
received_request_max_count integer 24 max
service was started
The Average time, in milliseconds, that it takes for a remote procedure call to
imap4_rpc_latency_avg_ms double 24 average
return results from a Mailbox server, averaged over RPC calls in the last minute
The Minimum average time, in milliseconds, that it takes for a remote procedure
imap4_rpc_latency_avg_min_ms double 24 min call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Maximum average time, in milliseconds, that it takes for a remote procedure
imap4_rpc_latency_avg_max_ms double 24 max call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Average time, in milliseconds, that it takes for an LDAP call to return results
ldap_latency_avg_ms double 24 average
from a domain controller, averaged over LDAP calls in the last minute
The Minimum average time, in milliseconds, that it takes for an LDAP call to
ldap_latency_avg_min_ms double 24 min return results from a domain controller, averaged over LDAP calls in the last
minute
The Maximum average time, in milliseconds, that it takes for an LDAP call to
ldap_latency_avg_max_ms double 24 max return results from a domain controller, averaged over LDAP calls in the last
minute
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 854
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 855
AI Operations Management - Containerized 24.4
1.4.2.4.32. opsb_exch_info_store_client
Description Collects metrics for Information Store Client
Key columns exchange_server_fqdn, is_client_instance_name, timestamp_utc_s, node_fqdn
RPCREQUESTS info_store_rpc_req_count integer 24 Number of RPC Requests for Information Store Client Type
INSTANCE_NAME is_client_instance_name string 255 Information Store Client type Instance Name
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 856
AI Operations Management - Containerized 24.4
1.4.2.4.33. opsb_exch_info_store_client_1d
Description Collects metrics for Information Store Client (Daily)
Source dataset opsb_exch_info_store_client_1h
Data Aggregation
Column Name Size Description
Type Type
info_store_rpc_req_avg_count integer 24 average The Average number of RPC Requests for Information Store Client Type
info_store_rpc_req_min_count integer 24 min The Minimum number of RPC Requests for Information Store Client Type
info_store_rpc_req_max_count integer 24 max The Maximum number of RPC Requests for Information Store Client Type
info_store_rpc_req_count integer 24 lastval Number of RPC Requests for Information Store Client Type
The Average latency (milli seconds) of RPC Requests for Information Store
info_store_rpc_avg_latency_avg_ms average
Client Type
The Minimum average latency (milli seconds) of RPC Requests for Information
info_store_rpc_avg_latency_min_ms min
Store Client Type
The Maximum average latency (milli seconds) of RPC Requests for Information
info_store_rpc_avg_latency_max_ms max
Store Client Type
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 857
AI Operations Management - Containerized 24.4
1.4.2.4.34. opsb_exch_info_store_client_1h
Description Collects metrics for Information Store Client (Hourly)
Source dataset opsb_exch_info_store_client
Data Aggregation
Column Name Size Description
Type Type
info_store_rpc_req_avg_count integer 24 average The Average number of RPC Requests for Information Store Client Type
info_store_rpc_req_min_count integer 24 min The Minimum number of RPC Requests for Information Store Client Type
info_store_rpc_req_max_count integer 24 max The Maximum number of RPC Requests for Information Store Client Type
info_store_rpc_req_count integer 24 lastval Number of RPC Requests for Information Store Client Type
The Average latency (milli seconds) of RPC Requests for Information Store
info_store_rpc_avg_latency_avg_ms integer 24 average
Client Type
The Minimum average latency (milli seconds) of RPC Requests for Information
info_store_rpc_avg_latency_min_ms integer 24 min
Store Client Type
The Maximum average latency (milli seconds) of RPC Requests for Information
info_store_rpc_avg_latency_max_ms integer 24 max
Store Client Type
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 858
AI Operations Management - Containerized 24.4
1.4.2.4.35. opsb_exch_mail_flow_check
Description Collects the mail flow check metric information
Key columns exchange_server_fqdn, destination_srv, timestamp_utc_s, node_fqdn
ORIGIN_SERVER origin_srv string 255 Originating Server for the Mail Flow test
ORIGIN_SITE origin_site string 255 Originating Site of the Mail Flow test
DESTIN_SERVER destination_srv string 255 Destination Server of the Mail Flow test
DESTIN_SITE destination_site string 255 Destination Site of the Mail Flow Test
ISREMOTETEST is_remote_test string 255 Identifies if the Mail Flow test is remote or local
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 859
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 860
AI Operations Management - Containerized 24.4
1.4.2.4.36. opsb_exch_mail_flow_check_1d
Description Monitors the mail flow check metric information (Daily)
Source dataset opsb_exch_mail_flow_check_1h
Data Aggregation
Column Name Size Description
Type Type
origin_srv string 255 lastval Originating Server for the Mail Flow test
origin_site string 255 lastval Originating Site of the Mail Flow test
destination_site string 255 lastval Destination Site of the Mail Flow Test
is_remote_test string 255 lastval Identifies if the Mail Flow test is remote or local
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 861
AI Operations Management - Containerized 24.4
1.4.2.4.37. opsb_exch_mail_flow_check_1h
Description Monitors the mail flow check metric information (Hourly)
Source dataset opsb_exch_mail_flow_check
Data Aggregation
Column Name Size Description
Type Type
origin_srv string 255 lastval Originating Server for the Mail Flow test
origin_site string 255 lastval Originating Site of the Mail Flow test
destination_site string 255 lastval Destination Site of the Mail Flow Test
is_remote_test string 255 lastval Identifies if the Mail Flow test is remote or local
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 862
AI Operations Management - Containerized 24.4
1.4.2.4.38. opsb_exch_mailbox_database_perf
Description Collects performance counters for Exchange Server Mailbox
Key columns exchange_server_fqdn, mailbox_db_instance_name, timestamp_utc_s, node_fqdn
MDBTBOPEN opened_tables_count_per_s double 24 The number of database tables opened per second
MDBTBCLS closed_tables_count_per_s double 24 The number of database tables closed per second
MDBLGBYWR log_written_bytes_count_per_s double 24 The rate at which the number of bytes are written to the log
The rate at which data is added to the log. This is different from
MDBLGBYGEN log_generated_bytes_count_per_s double 24 Log Bytes Write per second in that each byte is generated only
once whereas each byte may be written many times
The number of threads waiting for their data to be written into the
MDBLGTHWT data_log_waiting_threads_count integer 24
log in order to complete an update of the database
The number of log records that cannot be added to the log buffers
MDBLGRECSTL log_recrd_stalls_count_per_s double 24 per second because they are full. If this counter is non-zero most
of the time, the log buffer size may be a bottleneck
The rate at which database file page requests were fulfilled by the
MDBCHMISS db_cache_miss_count_per_s double 24
database cache by causing a file operation
The rate of page faults that cannot be serviced because there are
no pages available for allocation from the database cache. If this
MDBPFLTST page_fault_stall_count_per_s double 24
counter is nonzero most of the time, the clean threshold may be
too low
MDBIOARAL io_reads_attached_avg_latency_ms double 24 The average latency, in milliseconds, per database read operation
MDBIORAL io_reads_latency_avg_ms double 24 The average latency, in milliseconds, per database read operation
MDBIOLRD logfile_io_reads_count_per_s double 24 The rate of log file read operations completed
MDBIOLWR logfile_io_writes_count_per_s double 24 The rate of log file write operations completed
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 863
AI Operations Management - Containerized 24.4
MDBIOLWAL logfile_io_writes_latency_avg_ms double 24 The averagelatency, in milliseconds, per log file write operation
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 864
AI Operations Management - Containerized 24.4
1.4.2.4.39. opsb_exch_mailbox_database_perf_1d
Description Collects performance counters for Exchange Server Mailbox (Daily)
Source dataset opsb_exch_mailbox_database_perf
Data Aggregation
Column Name Size Description
Type Type
opened_tables_avg_count_per_s double 24 average The Average number of database tables opened per second
opened_tables_min_count_per_s double 24 min The Minimum number of database tables opened per second
opened_tables_max_count_per_s double 24 max The Maximum number of database tables opened per second
closed_tables_avg_count_per_s double 24 average The Average number of database tables closed per second
closed_tables_min_count_per_s double 24 min The Minimum number of database tables closed per second
closed_tables_max_count_per_s double 24 max The Maximum number of database tables closed per second
log_written_bytes_avg_count_per_s double 24 average The Average rate at which the number of bytes are written to the log
log_written_bytes_min_count_per_s double 24 min The Minimum rate at which the number of bytes are written to the log
log_written_bytes_max_count_per_s double 24 max The Maximum rate at which the number of bytes are written to the log
The Average rate at which data is added to the log. This is different from
log_generated_bytes_avg_count_per_s double 24 average Log Bytes Write per second in that each byte is generated only once
whereas each byte may be written many times
The Minimum rate at which data is added to the log. This is different from
log_generated_bytes_min_count_per_s double 24 min Log Bytes Write per second in that each byte is generated only once
whereas each byte may be written many times
The Maximum rate at which data is added to the log. This is different from
log_generated_bytes_max_count_per_s double 24 max Log Bytes Write per second in that each byte is generated only once
whereas each byte may be written many times
The number of threads waiting for their data to be written into the log in
data_log_waiting_threads_count integer 24 lastval
order to complete an update of the database
The Average number of threads waiting for their data to be written into the
data_log_waiting_threads_avg_count integer 24 average
log in order to complete an update of the database
The Minimum number of threads waiting for their data to be written into
data_log_waiting_threads_min_count integer 24 min
the log in order to complete an update of the database
The Maximum number of threads waiting for their data to be written into
data_log_waiting_threads_max_count integer 24 max
the log in order to complete an update of the database
The Average number of log records that cannot be added to the log buffers
log_recrd_stalls_avg_count_per_s double 24 average per second because they are full. If this counter is non-zero most of the
time, the log buffer size may be a bottleneck
The Minimum number of log records that cannot be added to the log
log_recrd_stalls_min_count_per_s double 24 min buffers per second because they are full. If this counter is non-zero most of
the time, the log buffer size may be a bottleneck
The Maximum number of log records that cannot be added to the log
log_recrd_stalls_max_count_per_s double 24 max buffers per second because they are full. If this counter is non-zero most of
the time, the log buffer size may be a bottleneck
ver_buckets_allocated_avg_count integer 24 average The Average total number of version buckets allocated
ver_buckets_allocated_min_count integer 24 min The Minimum total number of version buckets allocated
ver_buckets_allocated_max_count integer 24 max The Maximum total number of version buckets allocated
The Average rate at which database file page requests were fulfilled by the
db_cache_miss_avg_count_per_s double 24 average
database cache by causing a file operation
The Minimum rate at which database file page requests were fulfilled by
db_cache_miss_min_count_per_s double 24 min
the database cache by causing a file operation
The Maximum rate at which database file page requests were fulfilled by
db_cache_miss_max_count_per_s double 24 max
the database cache by causing a file operation
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 865
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Average database file page requests that were fulfilled by the
db_cache_hit_avg_pct double 24 average
database cache without causing a file operation in percentage.
The Minimum database file page requests that were fulfilled by the
db_cache_hit_min_pct double 24 min
database cache without causing a file operation in percentage.
The Maximum database file page requests that were fulfilled by the
db_cache_hit_max_pct double 24 max
database cache without causing a file operation in percentage.
The Percentile of the database file page requests that were fulfilled by the
db_cache_hit_pctl_pct double 24 90 percentile
database cache without causing a file operation in percentage.
The Average rate of page faults that cannot be serviced because there are
page_fault_stall_avg_count_per_s double 24 average no pages available for allocation from the database cache. If this counter is
nonzero most of the time, the clean threshold may be too low
The Minimum rate of page faults that cannot be serviced because there
page_fault_stall_min_count_per_s double 24 min are no pages available for allocation from the database cache. If this
counter is nonzero most of the time, the clean threshold may be too low
The Maximum rate of page faults that cannot be serviced because there
page_fault_stall_max_count_per_s double 24 max are no pages available for allocation from the database cache. If this
counter is nonzero most of the time, the clean threshold may be too low
io_reads_attached_avg_count_per_s double 24 average The Average rate of database read operations completed
io_reads_attached_min_count_per_s double 24 min The Minimum rate of database read operations completed
io_reads_attached_max_count_per_s double 24 max The Maximum rate of database read operations completed
io_reads_attached_avg_latency_avg_ms double 24 average The Average latency, in milliseconds, per database read operation
io_reads_recovery_avg_count_per_s double 24 average The Average rate of database read(Recovery) operations completed.
io_reads_recovery_min_count_per_s double 24 min The Minimum rate of database read(Recovery) operations completed.
io_reads_recovery_max_count_per_s double 24 max The Maximum rate of database read(Recovery) operations completed.
io_reads_avg_count_per_s double 24 average The Average rate of database read operations completed
io_reads_min_count_per_s double 24 min The Minimum rate of database read operations completed
io_reads_max_count_per_s double 24 max The Maximum rate of database read operations completed
io_reads_latency_avg_ms double 24 average The Average latency, in milliseconds, per database read operation
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 866
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
logfile_io_reads_avg_count_per_s double 24 average The Average rate of log file read operations completed
logfile_io_reads_min_count_per_s double 24 min The Minimum rate of log file read operations completed
logfile_io_reads_max_count_per_s double 24 max The Maximum rate of log file read operations completed
logfile_io_reads_latency_avg_ms double 24 average The Average length of time, in milliseconds, per logfile read operation
io_writes_attached_avg_count_per_s double 24 average The Average rate of database write operations completed
io_writes_attached_min_count_per_s double 24 min The Minimum rate of database write operations completed
io_writes_attached_max_count_per_s double 24 max The Maximum rate of database write operations completed
io_writes_attached_latency_avg_ms double 24 average The Average latency, in milliseconds, per database write operation
io_writes_recovery_avg_count_per_s double 24 average The Average rate of database write operations completed
io_writes_recovery_min_count_per_s double 24 min The Minimum rate of database write operations completed
io_writes_recovery_max_count_per_s double 24 max The Maximum rate of database write operations completed
io_writes_recovery_latency_avg_ms double 24 average The Average latency, in milliseconds, per database write operation
io_writes_avg_count_per_s double 24 average The Average rate of database write operations completed
io_writes_min_count_per_s double 24 min The Minimum rate of database write operations completed
io_writes_max_count_per_s double 24 max The Maximum rate of database write operations completed
io_writes_latency_avg_ms double 24 average The Average latency, in milliseconds, per database write operation
logfile_io_writes_avg_count_per_s double 24 average The Average rate of log file write operations completed
logfile_io_writes_min_count_per_s double 24 min The Minimum rate of log file write operations completed
logfile_io_writes_max_count_per_s double 24 max The Maximum rate of log file write operations completed
logfile_io_writes_latency_avg_ms double 24 average The Average latency, in milliseconds, per log file write operation
logfile_io_writes_latency_avg_min_ms double 24 min The Minimum averagelatency, in milliseconds, per log file write operation
logfile_io_writes_latency_avg_max_ms double 24 max The Maximum averagelatency, in milliseconds, per log file write operation
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 867
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type string 255 lastval
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 868
AI Operations Management - Containerized 24.4
1.4.2.4.40. opsb_exch_mailbox_database_perf_1h
Description Collects performance counters for Exchange Server Mailbox (Hourly)
Source dataset opsb_exch_mailbox_database_perf
Data Aggregation
Column Name Size Description
Type Type
opened_tables_avg_count_per_s double 24 average The Average number of database tables opened per second
opened_tables_min_count_per_s double 24 min The Minimum number of database tables opened per second
opened_tables_max_count_per_s double 24 max The Maximum number of database tables opened per second
closed_tables_avg_count_per_s double 24 average The Average number of database tables closed per second
closed_tables_min_count_per_s double 24 min The Minimum number of database tables closed per second
closed_tables_max_count_per_s double 24 max The Maximum number of database tables closed per second
log_written_bytes_avg_count_per_s double 24 average The Average rate at which the number of bytes are written to the log
log_written_bytes_min_count_per_s double 24 min The Minimum rate at which the number of bytes are written to the log
log_written_bytes_max_count_per_s double 24 max The Maximum rate at which the number of bytes are written to the log
The Average rate at which data is added to the log. This is different from
log_generated_bytes_avg_count_per_s double 24 average Log Bytes Write per second in that each byte is generated only once
whereas each byte may be written many times
The Minimum rate at which data is added to the log. This is different from
log_generated_bytes_min_count_per_s double 24 min Log Bytes Write per second in that each byte is generated only once
whereas each byte may be written many times
The Maximum rate at which data is added to the log. This is different from
log_generated_bytes_max_count_per_s double 24 max Log Bytes Write per second in that each byte is generated only once
whereas each byte may be written many times
The number of threads waiting for their data to be written into the log in
data_log_waiting_threads_count integer 24 lastval
order to complete an update of the database
The Average number of threads waiting for their data to be written into the
data_log_waiting_threads_avg_count integer 24 average
log in order to complete an update of the database
The Minimum number of threads waiting for their data to be written into
data_log_waiting_threads_min_count integer 24 min
the log in order to complete an update of the database
The Maximum number of threads waiting for their data to be written into
data_log_waiting_threads_max_count integer 24 max
the log in order to complete an update of the database
The Average number of log records that cannot be added to the log buffers
log_recrd_stalls_avg_count_per_s double 24 average per second because they are full. If this counter is non-zero most of the
time, the log buffer size may be a bottleneck
The Minimum number of log records that cannot be added to the log
log_recrd_stalls_min_count_per_s double 24 min buffers per second because they are full. If this counter is non-zero most of
the time, the log buffer size may be a bottleneck
The Maximum number of log records that cannot be added to the log
log_recrd_stalls_max_count_per_s double 24 max buffers per second because they are full. If this counter is non-zero most of
the time, the log buffer size may be a bottleneck
ver_buckets_allocated_avg_count integer 24 average The Average total number of version buckets allocated
ver_buckets_allocated_min_count integer 24 min The Minimum total number of version buckets allocated
ver_buckets_allocated_max_count integer 24 max The Maximum total number of version buckets allocated
The Average rate at which database file page requests were fulfilled by the
db_cache_miss_avg_count_per_s double 24 average
database cache by causing a file operation
The Minimum rate at which database file page requests were fulfilled by
db_cache_miss_min_count_per_s double 24 min
the database cache by causing a file operation
The Maximum rate at which database file page requests were fulfilled by
db_cache_miss_max_count_per_s double 24 max
the database cache by causing a file operation
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 869
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Average database file page requests that were fulfilled by the
db_cache_hit_avg_pct double 24 average
database cache without causing a file operation in percentage.
The Minimum database file page requests that were fulfilled by the
db_cache_hit_min_pct double 24 min
database cache without causing a file operation in percentage.
The Maximum database file page requests that were fulfilled by the
db_cache_hit_max_pct double 24 max
database cache without causing a file operation in percentage.
The Percentile of the database file page requests that were fulfilled by the
db_cache_hit_pctl_pct double 24 90 percentile
database cache without causing a file operation in percentage.
The Average rate of page faults that cannot be serviced because there are
page_fault_stall_avg_count_per_s double 24 average no pages available for allocation from the database cache. If this counter is
nonzero most of the time, the clean threshold may be too low
The Minimum rate of page faults that cannot be serviced because there
page_fault_stall_min_count_per_s double 24 min are no pages available for allocation from the database cache. If this
counter is nonzero most of the time, the clean threshold may be too low
The Maximum rate of page faults that cannot be serviced because there
page_fault_stall_max_count_per_s double 24 max are no pages available for allocation from the database cache. If this
counter is nonzero most of the time, the clean threshold may be too low
io_reads_attached_avg_count_per_s double 24 average The Average rate of database read operations completed
io_reads_attached_min_count_per_s double 24 min The Minimum rate of database read operations completed
io_reads_attached_max_count_per_s double 24 max The Maximum rate of database read operations completed
io_reads_attached_avg_latency_avg_ms double 24 average The Average latency, in milliseconds, per database read operation
io_reads_recovery_avg_count_per_s double 24 average The Average rate of database read(Recovery) operations completed.
io_reads_recovery_min_count_per_s double 24 min The Minimum rate of database read(Recovery) operations completed.
io_reads_recovery_max_count_per_s double 24 max The Maximum rate of database read(Recovery) operations completed.
io_reads_avg_count_per_s double 24 average The Average rate of database read operations completed
io_reads_min_count_per_s double 24 min The Minimum rate of database read operations completed
io_reads_max_count_per_s double 24 max The Maximum rate of database read operations completed
io_reads_latency_avg_ms double 24 average The Average latency, in milliseconds, per database read operation
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 870
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
logfile_io_reads_avg_count_per_s double 24 average The Average rate of log file read operations completed
logfile_io_reads_min_count_per_s double 24 min The Minimum rate of log file read operations completed
logfile_io_reads_max_count_per_s double 24 max The Maximum rate of log file read operations completed
logfile_io_reads_latency_avg_ms double 24 average The Average length of time, in milliseconds, per logfile read operation
io_writes_attached_avg_count_per_s double 24 average The Average rate of database write operations completed
io_writes_attached_min_count_per_s double 24 min The Minimum rate of database write operations completed
io_writes_attached_max_count_per_s double 24 max The Maximum rate of database write operations completed
io_writes_attached_latency_avg_ms double 24 average The Average latency, in milliseconds, per database write operation
io_writes_recovery_avg_count_per_s double 24 average The Average rate of database write operations completed
io_writes_recovery_min_count_per_s double 24 min The Minimum rate of database write operations completed
io_writes_recovery_max_count_per_s double 24 max The Maximum rate of database write operations completed
io_writes_recovery_latency_avg_ms double 24 average The Average latency, in milliseconds, per database write operation
io_writes_avg_count_per_s double 24 average The Average rate of database write operations completed
io_writes_min_count_per_s double 24 min The Minimum rate of database write operations completed
io_writes_max_count_per_s double 24 max The Maximum rate of database write operations completed
io_writes_latency_avg_ms double 24 average The Average latency, in milliseconds, per database write operation
logfile_io_writes_avg_count_per_s double 24 average The Average rate of log file write operations completed
logfile_io_writes_min_count_per_s double 24 min The Minimum rate of log file write operations completed
logfile_io_writes_max_count_per_s double 24 max The Maximum rate of log file write operations completed
logfile_io_writes_latency_avg_ms double 24 average The Average latency, in milliseconds, per log file write operation
logfile_io_writes_latency_avg_min_ms double 24 min The Minimum averagelatency, in milliseconds, per log file write operation
logfile_io_writes_latency_avg_max_ms double 24 max The Maximum averagelatency, in milliseconds, per log file write operation
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 871
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type string 255 lastval
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 872
AI Operations Management - Containerized 24.4
1.4.2.4.41. opsb_exch_mailbox_details
Description Collects metric information for Exchange Server Mailbox statistics
Key columns exchange_server_fqdn, mailbox_identity, timestamp_utc_s, node_fqdn
DATABASE_NAME mailbox_db_name string 255 Name of the mailbox database containing the mailbox
PF_SIZE total_items_size_mb double 24 Total size of the items in the mailbox. It's in MB
MB_LASTACCESS last_logon_time string 255 Time when user of the mailbox last logged in
MB_DISCONNECT mailbox_disconnect_date string 255 Date since the mailbox was disconnected
MB_DELSIZE marked_del_items_size_mb double 24 Total size of the items marked for deletion in mailbox.It's in MB
DAG_NAME mailbox_dag_srv_name string 255 Name of the DAG to which the database hosting the mailbox is a member
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 873
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 874
AI Operations Management - Containerized 24.4
1.4.2.4.42. opsb_exch_mailbox_details_1d
Description Collects metric information for Exchange Server Mailbox statistics (Daily)
Source dataset opsb_exch_mailbox_details_1h
Data Aggregation
Column Name Size Description
Type Type
mailbox_db_name string 255 lastval Name of the mailbox database containing the mailbox
total_items_size_avg_mb double 24 average The Average total size of the items in the mailbox. It's in MB
total_items_size_min_mb double 24 min The Minimum total size of the items in the mailbox. It's in MB
total_items_size_max_mb double 24 max The Maximum total size of the items in the mailbox. It's in MB
last_logon_time string 255 lastval Time when user of the mailbox last logged in
mailbox_disconnect_date string 255 lastval Date since the mailbox was disconnected
marked_del_items_avg_count integer 24 average The Average number of items marked for deletion in mailbox
marked_del_items_min_count integer 24 min The Minimum number of items marked for deletion in mailbox
marked_del_items_max_count integer 24 max The Maximum number of items marked for deletion in mailbox
marked_del_items_size_avg_mb double 24 average The Average total size of the items marked for deletion in mailbox.It's in MB
marked_del_items_size_min_mb double 24 min The Minimum total size of the items marked for deletion in mailbox.It's in MB
marked_del_items_size_max_mb double 24 max The Maximum total size of the items marked for deletion in mailbox.It's in MB
mailbox_dag_srv_name string 255 lastval Name of the DAG to which the database hosting the mailbox is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 875
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 876
AI Operations Management - Containerized 24.4
1.4.2.4.43. opsb_exch_mailbox_details_1h
Description Collects metric information for Exchange Server Mailbox statistics (Hourly)
Source dataset opsb_exch_mailbox_details
Data Aggregation
Column Name Size Description
Type Type
mailbox_db_name string 255 lastval Name of the mailbox database containing the mailbox
total_items_size_avg_mb double 24 average The Average total size of the items in the mailbox. It's in MB
total_items_size_min_mb double 24 min The Minimum total size of the items in the mailbox. It's in MB
total_items_size_max_mb double 24 max The Maximum total size of the items in the mailbox. It's in MB
last_logon_time string 255 lastval Time when user of the mailbox last logged in
mailbox_disconnect_date string 255 lastval Date since the mailbox was disconnected
marked_del_items_avg_count integer 24 average The Average number of items marked for deletion in mailbox
marked_del_items_min_count integer 24 min The Minimum number of items marked for deletion in mailbox
marked_del_items_max_count integer 24 max The Maximum number of items marked for deletion in mailbox
marked_del_items_size_avg_mb double 24 average The Average total size of the items marked for deletion in mailbox.It's in MB
marked_del_items_size_min_mb double 24 min The Minimum total size of the items marked for deletion in mailbox.It's in MB
marked_del_items_size_max_mb double 24 max The Maximum total size of the items marked for deletion in mailbox.It's in MB
mailbox_dag_srv_name string 255 lastval Name of the DAG to which the database hosting the mailbox is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 877
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 878
AI Operations Management - Containerized 24.4
1.4.2.4.44. opsb_exch_mailbox_summary_data
Description Collects metric information for Exchange Server Mailbox
Key columns exchange_server_fqdn, mailbox_instance_key, timestamp_utc_s, node_fqdn
EDBPATH edb_file_path string 255 EDB file path of the Mailbox database
EDBFREE edb_free_disk_space_mb double 48 Available free disk space in the drive containing the EDB file in MB
EDBTOTAL edb_total_disk_space_mb double 48 Total disk space of the drive containing the EDB file in MB
DAG_NAME mailbox_dag_srv_name string 255 Name of the DAG to which the database hosting the mailbox is a member
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 879
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 880
AI Operations Management - Containerized 24.4
1.4.2.4.45. opsb_exch_mailbox_summary_data_1d
Description Collects metric information for Exchange Server Mailbox (Daily)
Source dataset opsb_exch_mailbox_summary_data_1h
Data Aggregation
Column Name Size Description
Type Type
edb_file_path string 255 lastval EDB file path of the Mailbox database
edb_free_disk_space_avg_mb double 48 average The Average available free disk space in the drive containing the EDB file in MB
edb_free_disk_space_min_mb double 48 min The Minimum available free disk space in the drive containing the EDB file in MB
edb_free_disk_space_max_mb double 48 max The Maximum available free disk space in the drive containing the EDB file in MB
edb_total_disk_space_avg_mb double 48 average The Average total disk space of the drive containing the EDB file in MB
edb_total_disk_space_min_mb double 48 min The Minimum total disk space of the drive containing the EDB file in MB
edb_total_disk_space_max_mb double 48 max The Maximum total disk space of the drive containing the EDB file in MB
mailbox_user_avg_count integer 24 average The Average number of mailbox users in the Mailbox database
mailbox_user_min_count integer 24 min The Minimum number of mailbox users in the Mailbox database
mailbox_user_max_count integer 24 max The Maximum number of mailbox users in the Mailbox database
mailbox_msg_avg_count integer 24 average The Average number of messages in the Mailbox database
mailbox_msg_min_count integer 24 min The Minimum number of messages in the Mailbox database
mailbox_msg_max_count integer 24 max The Maximum number of messages in the Mailbox database
mailbox_dag_srv_name string 255 lastval Name of the DAG to which the database hosting the mailbox is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 881
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 882
AI Operations Management - Containerized 24.4
1.4.2.4.46. opsb_exch_mailbox_summary_data_1h
Description Collects metric information for Exchange Server Mailbox (Hourly)
Source dataset opsb_exch_mailbox_summary_data
Data Aggregation
Column Name Size Description
Type Type
edb_file_path string 255 lastval EDB file path of the Mailbox database
edb_free_disk_space_avg_mb double 48 average The Average available free disk space in the drive containing the EDB file in MB
edb_free_disk_space_min_mb double 48 min The Minimum available free disk space in the drive containing the EDB file in MB
edb_free_disk_space_max_mb double 48 max The Maximum available free disk space in the drive containing the EDB file in MB
edb_total_disk_space_avg_mb double 48 average The Average total disk space of the drive containing the EDB file in MB
edb_total_disk_space_min_mb double 48 min The Minimum total disk space of the drive containing the EDB file in MB
edb_total_disk_space_max_mb double 48 max The Maximum total disk space of the drive containing the EDB file in MB
mailbox_user_avg_count integer 24 average The Average number of mailbox users in the Mailbox database
mailbox_user_min_count integer 24 min The Minimum number of mailbox users in the Mailbox database
mailbox_user_max_count integer 24 max The Maximum number of mailbox users in the Mailbox database
mailbox_msg_avg_count integer 24 average The Average number of messages in the Mailbox database
mailbox_msg_min_count integer 24 min The Minimum number of messages in the Mailbox database
mailbox_msg_max_count integer 24 max The Maximum number of messages in the Mailbox database
mailbox_dag_srv_name string 255 lastval Name of the DAG to which the database hosting the mailbox is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 883
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 884
AI Operations Management - Containerized 24.4
1.4.2.4.47. opsb_exch_managed_service
Description Collects metrics for Health Management service
Key columns exchange_server_fqdn, hm_worker_svc_name, timestamp_utc_s, node_fqdn
SERVNAME hm_worker_svc_name string 255 Name of the Health Management worker service
DISPLAY_NAME hm_worker_display_name string 255 Display name of the Health Management worker service
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 885
AI Operations Management - Containerized 24.4
1.4.2.4.48. opsb_exch_mapi_connectivity
Description Collects metric information about mapi connectivity check
Key columns exchange_server_fqdn, mapi_key_name, timestamp_utc_s, node_fqdn
MAPIDB exch_db_name string 255 Name of the MAPI Exchange Database for which the test is performed
MAPILAT mapi_latency_ms integer 24 The MAPI latency for the databse in milliseconds
MAPIERR fail_err_info string 255 MAPI Error reported if the test failed
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 886
AI Operations Management - Containerized 24.4
1.4.2.4.49. opsb_exch_mapi_connectivity_1d
Description Collects metric information about mapi connectivity check (Daily)
Source dataset opsb_exch_mapi_connectivity_1h
Data Aggregation
Column Name Size Description
Type Type
exch_db_name string 255 lastval Name of the MAPI Exchange Database for which the test is performed
mapi_latency_avg_ms integer 24 average The Average MAPI latency for the databse in milliseconds
mapi_latency_min_ms integer 24 min The Minimum MAPI latency for the databse in milliseconds
mapi_latency_max_ms integer 24 max The Maximum MAPI latency for the databse in milliseconds
fail_err_info string 255 lastval MAPI Error reported if the test failed
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 887
AI Operations Management - Containerized 24.4
1.4.2.4.50. opsb_exch_mapi_connectivity_1h
Description Collects metric information about mapi connectivity check (Hourly)
Source dataset opsb_exch_mapi_connectivity
Data Aggregation
Column Name Size Description
Type Type
exch_db_name string 255 lastval Name of the MAPI Exchange Database for which the test is performed
mapi_latency_avg_ms integer 24 average The Average MAPI latency for the databse in milliseconds
mapi_latency_min_ms integer 24 min The Minimum MAPI latency for the databse in milliseconds
mapi_latency_max_ms integer 24 max The Maximum MAPI latency for the databse in milliseconds
fail_err_info string 255 lastval MAPI Error reported if the test failed
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 888
AI Operations Management - Containerized 24.4
1.4.2.4.51. opsb_exch_memory_info
Description Collects metrics for memory utilization
Key columns exchange_server_fqdn, mem_info_instance_name, timestamp_utc_s, node_fqdn
MEMORY mem_avail_info_b integer 24 Bytes of physical memory available to processes running on the computer.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 889
AI Operations Management - Containerized 24.4
1.4.2.4.52. opsb_exch_memory_info_1d
Description Collects metrics for memory utilization (Daily)
Source dataset opsb_exch_memory_info
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 890
AI Operations Management - Containerized 24.4
1.4.2.4.53. opsb_exch_memory_info_1h
Description Collects metrics for memory utilization (Hourly)
Source dataset opsb_exch_memory_info
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 891
AI Operations Management - Containerized 24.4
1.4.2.4.54. opsb_exch_network_interface
Description Collects metrics for network health
Key columns exchange_server_fqdn, network_interface_instance_name, timestamp_utc_s, node_fqdn
PACKETSRECDISCAR pckts_recvd_discarded_count integer 24 The number of inbound packets which were chosen to be discarded
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If
CollectionConfigName collection_policy_name string 255
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 892
AI Operations Management - Containerized 24.4
1.4.2.4.55. opsb_exch_network_interface_1d
Description Collects metrics for network health (Daily)
Source dataset opsb_exch_network_interface_1h
Data Aggregation
Column Name Size Description
Type Type
The Average output queue length network interface monitors the occupancy
output_que_length_avg_count integer 24 average
of network interface
The Minimum output queue length network interface monitors the occupancy
output_que_length_min_count integer 24 min
of network interface
pckts_outbound_discarded_count integer 24 lastval The number of outbound packets which were chosen to be discarded
pckts_recvd_discarded_avg_count integer 24 average The Average number of inbound packets which were chosen to be discarded
pckts_recvd_discarded_min_count integer 24 min The Minimum number of inbound packets which were chosen to be discarded
pckts_recvd_discarded_count integer 24 lastval The number of inbound packets which were chosen to be discarded
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 893
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 894
AI Operations Management - Containerized 24.4
1.4.2.4.56. opsb_exch_network_interface_1h
Description Collects metrics for network health (Hourly)
Source dataset opsb_exch_network_interface
Data Aggregation
Column Name Size Description
Type Type
The Average output queue length network interface monitors the occupancy
output_que_length_avg_count integer 24 average
of network interface
The Minimum output queue length network interface monitors the occupancy
output_que_length_min_count integer 24 min
of network interface
pckts_outbound_discarded_count integer 24 lastval The number of outbound packets which were chosen to be discarded
pckts_recvd_discarded_avg_count integer 24 average The Average number of inbound packets which were chosen to be discarded
pckts_recvd_discarded_min_count integer 24 min The Minimum number of inbound packets which were chosen to be discarded
pckts_recvd_discarded_count integer 24 lastval The number of inbound packets which were chosen to be discarded
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 895
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 896
AI Operations Management - Containerized 24.4
1.4.2.4.57. opsb_exch_owa_connection_check
Description Collects Outlook Web Access test details
Key columns exchange_server_fqdn, owa_conn_key, timestamp_utc_s, node_fqdn
OWAKEY owa_conn_key string 255 OWA Connection Key to identify each test
Name of the Exchange OWA Connection Client Access server where the
OWASRV owa_client_access_srv_name string 255
test is performed
Name of the Exchange OWA Connection Mailbox Server for which the
OWADB owa_mailbox_srv_name string 255
test is performed
OWAERR owa_conn_err_info string 255 OWA Connection Error information if the test failed
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 897
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 898
AI Operations Management - Containerized 24.4
1.4.2.4.58. opsb_exch_owa_connection_check_1d
Description Collects Outlook Web Access test details (Daily)
Source dataset opsb_exch_owa_connection_check_1h
Data Aggregation
Column Name Size Description
Type Type
Name of the Exchange OWA Connection Client Access server where the test is
owa_client_access_srv_name string 255 lastval
performed
owa_mailbox_srv_name string 255 lastval Name of the Exchange OWA Connection Mailbox Server for which the test is performed
owa_conn_err_info string 255 lastval OWA Connection Error information if the test failed
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 899
AI Operations Management - Containerized 24.4
1.4.2.4.59. opsb_exch_owa_connection_check_1h
Description Collects Outlook Web Access test details (Hourly)
Source dataset opsb_exch_owa_connection_check
Data Aggregation
Column Name Size Description
Type Type
Name of the Exchange OWA Connection Client Access server where the test is
owa_client_access_srv_name string 255 lastval
performed
owa_mailbox_srv_name string 255 lastval Name of the Exchange OWA Connection Mailbox Server for which the test is performed
owa_conn_err_info string 255 lastval OWA Connection Error information if the test failed
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 900
AI Operations Management - Containerized 24.4
1.4.2.4.60. opsb_exch_owa_perf
Description Collects the OWA performance counters
Key columns exchange_server_fqdn, owa_instance_name, timestamp_utc_s, node_fqdn
The average time that elapsed while waiting for a search to complete in
OWAAVGSCHTM search_time_avg_ms double 24
milliseconds
The average time (in milliseconds) that elapsed between the beginning
OWAAVGRESTM resp_time_avg_ms double 24
and end of an OEH or ASPX request.
OWARQFLDPSEC failed_req_count_per_s double 24 The number of Outlook Web Access requests that are failed per second
The number of Outlook Web Access user sessions that are created per
OWALGPSEC logon_count_per_s double 24
second
OWAPXUSRQPSEC proxy_user_req_count_per_s double 24 The number of proxied requests made per second
OWAREQPSEC req_handled_count_per_s double 24 The number of requests handled by Outlook Web Access per second
OWASTRLGFLPER mailbox_logon_failure_pct double 24 The last 100 user logons to Mailbox servers that have failed in percentage
The average time (in milliseconds) elapsed between the beginning and
OWAPXRESAVG proxy_resp_time_avg_ms double 24
end of proxied requests
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 901
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 902
AI Operations Management - Containerized 24.4
1.4.2.4.61. opsb_exch_owa_perf_1d
Description Collects the OWA performance counters (Daily)
Source dataset opsb_exch_owa_perf
Data Aggregation
Column Name Size Description
Type Type
The Average time that elapsed while waiting for a search to complete in
search_time_avg_ms double 24 average
milliseconds
The Minimum average time that elapsed while waiting for a search to complete in
search_time_avg_min_ms double 24 min
milliseconds
The Maximum average time that elapsed while waiting for a search to complete in
search_time_avg_max_ms double 24 max
milliseconds
The Average time (in milliseconds) that elapsed between the beginning and end
resp_time_avg_ms double 24 average
of an OEH or ASPX request.
The Minimum average time (in milliseconds) that elapsed between the beginning
resp_time_avg_min_ms double 24 min
and end of an OEH or ASPX request.
The Maximum average time (in milliseconds) that elapsed between the beginning
resp_time_avg_max_ms double 24 max
and end of an OEH or ASPX request.
failed_req_avg_count_per_s double 24 average The Average number of Outlook Web Access requests that are failed per second
failed_req_min_count_per_s double 24 min The Minimum number of Outlook Web Access requests that are failed per second
failed_req_max_count_per_s double 24 max The Maximum number of Outlook Web Access requests that are failed per second
The Average number of Outlook Web Access user sessions that are created per
logon_avg_count_per_s double 24 average
second
The Minimum number of Outlook Web Access user sessions that are created per
logon_min_count_per_s double 24 min
second
The Maximum number of Outlook Web Access user sessions that are created per
logon_max_count_per_s double 24 max
second
proxy_user_req_avg_count_per_s double 24 average The Average number of proxied requests made per second
proxy_user_req_min_count_per_s double 24 min The Minimum number of proxied requests made per second
proxy_user_req_max_count_per_s double 24 max The Maximum number of proxied requests made per second
req_handled_avg_count_per_s double 24 average The Average number of requests handled by Outlook Web Access per second
req_handled_min_count_per_s double 24 min The Minimum number of requests handled by Outlook Web Access per second
req_handled_max_count_per_s double 24 max The Maximum number of requests handled by Outlook Web Access per second
The Percentile of the last 100 user logons to Mailbox servers that have failed in
mailbox_logon_failure_pctl_pct double 24 90 percentile
percentage
The Average time (in milliseconds) elapsed between the beginning and end of
proxy_resp_time_avg_ms double 24 average
proxied requests
The Minimum average time (in milliseconds) elapsed between the beginning and
proxy_resp_time_avg_min_ms double 24 min
end of proxied requests
The Maximum average time (in milliseconds) elapsed between the beginning and
proxy_resp_time_avg_max_ms double 24 max
end of proxied requests
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 903
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 904
AI Operations Management - Containerized 24.4
1.4.2.4.62. opsb_exch_owa_perf_1h
Description Collects the OWA performance counters (Hourly)
Source dataset opsb_exch_owa_perf
Data Aggregation
Column Name Size Description
Type Type
The Average time that elapsed while waiting for a search to complete in
search_time_avg_ms double 24 average
milliseconds
The Minimum average time that elapsed while waiting for a search to complete in
search_time_avg_min_ms double 24 min
milliseconds
The Maximum average time that elapsed while waiting for a search to complete in
search_time_avg_max_ms double 24 max
milliseconds
The Average time (in milliseconds) that elapsed between the beginning and end
resp_time_avg_ms double 24 average
of an OEH or ASPX request.
The Minimum average time (in milliseconds) that elapsed between the beginning
resp_time_avg_min_ms double 24 min
and end of an OEH or ASPX request.
The Maximum average time (in milliseconds) that elapsed between the beginning
resp_time_avg_max_ms double 24 max
and end of an OEH or ASPX request.
failed_req_avg_count_per_s double 24 average The Average number of Outlook Web Access requests that are failed per second
failed_req_min_count_per_s double 24 min The Minimum number of Outlook Web Access requests that are failed per second
failed_req_max_count_per_s double 24 max The Maximum number of Outlook Web Access requests that are failed per second
The Average number of Outlook Web Access user sessions that are created per
logon_avg_count_per_s double 24 average
second
The Minimum number of Outlook Web Access user sessions that are created per
logon_min_count_per_s double 24 min
second
The Maximum number of Outlook Web Access user sessions that are created per
logon_max_count_per_s double 24 max
second
proxy_user_req_avg_count_per_s double 24 average The Average number of proxied requests made per second
proxy_user_req_min_count_per_s double 24 min The Minimum number of proxied requests made per second
proxy_user_req_max_count_per_s double 24 max The Maximum number of proxied requests made per second
req_handled_avg_count_per_s double 24 average The Average number of requests handled by Outlook Web Access per second
req_handled_min_count_per_s double 24 min The Minimum number of requests handled by Outlook Web Access per second
req_handled_max_count_per_s double 24 max The Maximum number of requests handled by Outlook Web Access per second
The Percentile of the last 100 user logons to Mailbox servers that have failed in
mailbox_logon_failure_pctl_pct double 24 90 percentile
percentage
The Average time (in milliseconds) elapsed between the beginning and end of
proxy_resp_time_avg_ms double 24 average
proxied requests
The Minimum average time (in milliseconds) elapsed between the beginning and
proxy_resp_time_avg_min_ms double 24 min
end of proxied requests
The Maximum average time (in milliseconds) elapsed between the beginning and
proxy_resp_time_avg_max_ms double 24 max
end of proxied requests
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 905
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 906
AI Operations Management - Containerized 24.4
1.4.2.4.63. opsb_exch_owa_server
Description Shows the Outllok Web Acess server details
Key columns exchange_server_fqdn, owa_url_srv_name, timestamp_utc_s, node_fqdn
ACS_OWAURLSERVNM owa_url_srv_name string 255 Outlook Web Access URL Server Name
Outlook Web Access URL Service State. Service is running if value is 0 and
ACS_OWAURLSERVSTE owa_url_svc_state integer 24
Service is down if value is 1
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 907
AI Operations Management - Containerized 24.4
1.4.2.4.64. opsb_exch_physical_disk
Description Collects metrics for disk utilization
Key columns exchange_server_fqdn, disk_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 908
AI Operations Management - Containerized 24.4
1.4.2.4.65. opsb_exch_physical_disk_1d
Description Collects metrics for disk utilization (Daily)
Source dataset opsb_exch_physical_disk_1h
Data Aggregation
Column Name Size Description
Type Type
disks_read_latency_avg_min_s min The Minimum average time of disk read latency in seconds
disks_read_latency_avg_max_s max The Maximum average time of disk read latency in seconds
disks_write_latency_avg_min_s min The Minimum average time of disk write latency in seconds
disks_write_latency_avg_max_s max The Maximum average time of disk write latency in seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 909
AI Operations Management - Containerized 24.4
1.4.2.4.66. opsb_exch_physical_disk_1h
Description Collects metrics for disk utilization (Hourly)
Source dataset opsb_exch_physical_disk
Data Aggregation
Column Name Size Description
Type Type
disks_read_latency_avg_s double 24 average The Average time of disk read latency in seconds
disks_read_latency_avg_min_s double 24 min The Minimum average time of disk read latency in seconds
disks_read_latency_avg_max_s double 24 max The Maximum average time of disk read latency in seconds
disks_write_latency_avg_s double 24 average The Average time of disk write latency in seconds
disks_write_latency_avg_min_s double 24 min The Minimum average time of disk write latency in seconds
disks_write_latency_avg_max_s double 24 max The Maximum average time of disk write latency in seconds
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 910
AI Operations Management - Containerized 24.4
1.4.2.4.67. opsb_exch_pop3_perf
Description Collects the POP3 performance counters
Key columns exchange_server_fqdn, pop3_conn_instance_name, timestamp_utc_s, node_fqdn
POP3REJECTEDCON total_rejected_conn_count integer 24 Total number of POP3 connections that are rejected
POP3CONRT conn_count_per_s double 24 The number of POP3 connections that occur per second
POP3CONCUR curr_open_conn_count integer 24 The number of connections that are currently open on the POP3 service
POP3UATHCN unauth_conn_count_per_s double 24 The number of unauthenticated connections that occur per second
The number of proxy connections that are currently open on the POP3
POP3CURCN proxy_curr_conn_count integer 24
service
The number of proxy connections that have failed since the POP3 service
POP3CNFAIL failed_proxy_conn_count integer 24
was started
The total number of proxy connections that have been opened since the
POP3TTLCN total_proxy_conn_count integer 24
POP3 service was started
The number of SSL or TLS connections that are currently open on the POP3
POP3ACTSSL active_ssl_conn_count integer 24
service
The total number of SSL or TLS connections that have been opened since
POP3SSLCN total_ssl_conn_count integer 24
the POP3 service was started
The number of AUTH commands that have failed since the POP3 service
POP3ATHFL auth_cmd_failure_count integer 24
was started
The total number of AUTH commands that have been received since the
POP3ATHTTL total_auth_cmd_count integer 24
POP3 service was started
The number of DELETE commands that have failed since the POP3 service
POP3DELFL failed_del_cmd_count integer 24
was started
The total number of DELETE commands that have been received since the
POP3DELE recvd_del_cmd_count integer 24
POP3 service
The number of requests that have failed since the POP3 service was
POP3REQFL req_failure_count integer 24
started
The total number of requests that have been received since the POP3
POP3REQTTL total_req_recvd_count integer 24
service was started
The average time, in milliseconds, that it takes for a remote procedure call
POP3RPCLAT pop3_rpc_latency_avg_ms double 24 to return results from a Mailbox server, averaged over RPC calls in the last
minute
The average time (in milliseconds) it takes for an LDAP call to return
POP3LDPLAT ldap_latency_avg_ms double 24 results from a domain controller, averaged over LDAP calls in the last
minute
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 911
AI Operations Management - Containerized 24.4
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 912
AI Operations Management - Containerized 24.4
1.4.2.4.68. opsb_exch_pop3_perf_1d
Description Collects the POP3 performance counters (Daily)
Source dataset opsb_exch_pop3_perf_1h
Data Aggregation
Column Name Size Description
Type Type
failed_conn_avg_count integer 24 average The Average number of POP3 connections that are failed
failed_conn_min_count integer 24 min The Minimum number of POP3 connections that are failed
failed_conn_max_count integer 24 max The Maximum number of POP3 connections that are failed
total_rejected_conn_count integer 24 lastval Total number of POP3 connections that are rejected
total_rejected_conn_avg_count integer 24 average The Average total number of POP3 connections that are rejected
total_rejected_conn_min_count integer 24 min The Minimum total number of POP3 connections that are rejected
total_rejected_conn_max_count integer 24 max The Maximum total number of POP3 connections that are rejected
conn_avg_count_per_s double 24 average The Average number of POP3 connections that occur per second
conn_min_count_per_s double 24 min The Minimum number of POP3 connections that occur per second
conn_max_count_per_s double 24 max The Maximum number of POP3 connections that occur per second
curr_open_conn_count integer 24 lastval The number of connections that are currently open on the POP3 service
curr_open_conn_avg_count integer 24 average The Average number of connections that are currently open on the POP3 service
curr_open_conn_min_count integer 24 min The Minimum number of connections that are currently open on the POP3 service
curr_open_conn_max_count integer 24 max The Maximum number of connections that are currently open on the POP3 service
unauth_conn_avg_count_per_s double 24 average The Average number of unauthenticated connections that occur per second
unauth_conn_min_count_per_s double 24 min The Minimum number of unauthenticated connections that occur per second
unauth_conn_max_count_per_s double 24 max The Maximum number of unauthenticated connections that occur per second
proxy_curr_conn_count integer 24 lastval The number of proxy connections that are currently open on the POP3 service
The Average number of proxy connections that are currently open on the POP3
proxy_curr_conn_avg_count integer 24 average
service
The Minimum number of proxy connections that are currently open on the POP3
proxy_curr_conn_min_count integer 24 min
service
The Maximum number of proxy connections that are currently open on the POP3
proxy_curr_conn_max_count integer 24 max
service
The number of proxy connections that have failed since the POP3 service was
failed_proxy_conn_count integer 24 lastval
started
The Average number of proxy connections that have failed since the POP3 service
failed_proxy_conn_avg_count integer 24 average
was started
The Minimum number of proxy connections that have failed since the POP3 service
failed_proxy_conn_min_count integer 24 min
was started
The Maximum number of proxy connections that have failed since the POP3 service
failed_proxy_conn_max_count integer 24 max
was started
The total number of proxy connections that have been opened since the POP3
total_proxy_conn_count integer 24 lastval
service was started
The Average total number of proxy connections that have been opened since the
total_proxy_conn_avg_count integer 24 average
POP3 service was started
The Minimum total number of proxy connections that have been opened since the
total_proxy_conn_min_count integer 24 min
POP3 service was started
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 913
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Maximum total number of proxy connections that have been opened since the
total_proxy_conn_max_count integer 24 max
POP3 service was started
active_ssl_conn_count integer 24 lastval The number of SSL or TLS connections that are currently open on the POP3 service
The Average number of SSL or TLS connections that are currently open on the POP3
active_ssl_conn_avg_count integer 24 average
service
The Minimum number of SSL or TLS connections that are currently open on the
active_ssl_conn_min_count integer 24 min
POP3 service
The Maximum number of SSL or TLS connections that are currently open on the
active_ssl_conn_max_count integer 24 max
POP3 service
The total number of SSL or TLS connections that have been opened since the POP3
total_ssl_conn_count integer 24 lastval
service was started
The Average total number of SSL or TLS connections that have been opened since
total_ssl_conn_avg_count integer 24 average
the POP3 service was started
The Minimum total number of SSL or TLS connections that have been opened since
total_ssl_conn_min_count integer 24 min
the POP3 service was started
The Maximum total number of SSL or TLS connections that have been opened since
total_ssl_conn_max_count integer 24 max
the POP3 service was started
auth_cmd_failure_count integer 24 lastval The number of AUTH commands that have failed since the POP3 service was started
The Average number of AUTH commands that have failed since the POP3 service
auth_cmd_failure_avg_count integer 24 average
was started
The Minimum number of AUTH commands that have failed since the POP3 service
auth_cmd_failure_min_count integer 24 min
was started
The Maximum number of AUTH commands that have failed since the POP3 service
auth_cmd_failure_max_count integer 24 max
was started
auth_cmd_avg_count_per_s double 24 average The Average number of AUTH commands per second
auth_cmd_min_count_per_s double 24 min The Minimum number of AUTH commands per second
auth_cmd_max_count_per_s double 24 max The Maximum number of AUTH commands per second
The total number of AUTH commands that have been received since the POP3
total_auth_cmd_count integer 24 lastval
service was started
The Average total number of AUTH commands that have been received since the
total_auth_cmd_avg_count integer 24 average
POP3 service was started
The Minimum total number of AUTH commands that have been received since the
total_auth_cmd_min_count integer 24 min
POP3 service was started
The Maximum total number of AUTH commands that have been received since the
total_auth_cmd_max_count integer 24 max
POP3 service was started
The number of DELETE commands that have failed since the POP3 service was
failed_del_cmd_count integer 24 lastval
started
The Average number of DELETE commands that have failed since the POP3 service
failed_del_cmd_avg_count integer 24 average
was started
The Minimum number of DELETE commands that have failed since the POP3 service
failed_del_cmd_min_count integer 24 min
was started
The Maximum number of DELETE commands that have failed since the POP3 service
failed_del_cmd_max_count integer 24 max
was started
del_cmd_avg_count_per_s double 24 average The Average number of DELETE commands per second
del_cmd_min_count_per_s double 24 min The Minimum number of DELETE commands per second
del_cmd_max_count_per_s double 24 max The Maximum number of DELETE commands per second
The total number of DELETE commands that have been received since the POP3
recvd_del_cmd_count integer 24 lastval
service
The Average total number of DELETE commands that have been received since the
recvd_del_cmd_avg_count integer 24 average
POP3 service
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 914
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Minimum total number of DELETE commands that have been received since the
recvd_del_cmd_min_count integer 24 min
POP3 service
The Maximum total number of DELETE commands that have been received since
recvd_del_cmd_max_count integer 24 max
the POP3 service
req_failure_count integer 24 lastval The number of requests that have failed since the POP3 service was started
req_failure_avg_count integer 24 average The Average number of requests that have failed since the POP3 service was started
The Minimum number of requests that have failed since the POP3 service was
req_failure_min_count integer 24 min
started
The Maximum number of requests that have failed since the POP3 service was
req_failure_max_count integer 24 max
started
The total number of requests that have been received since the POP3 service was
total_req_recvd_count integer 24 lastval
started
The Average total number of requests that have been received since the POP3
total_req_recvd_avg_count integer 24 average
service was started
The Minimum total number of requests that have been received since the POP3
total_req_recvd_min_count integer 24 min
service was started
The Maximum total number of requests that have been received since the POP3
total_req_recvd_max_count integer 24 max
service was started
The Average time, in milliseconds, that it takes for a remote procedure call to return
pop3_rpc_latency_avg_ms average
results from a Mailbox server, averaged over RPC calls in the last minute
The Minimum average time, in milliseconds, that it takes for a remote procedure
pop3_rpc_latency_avg_min_ms min call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Maximum average time, in milliseconds, that it takes for a remote procedure
pop3_rpc_latency_avg_max_ms max call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Average time (in milliseconds) it takes for an LDAP call to return results from a
ldap_latency_avg_ms average
domain controller, averaged over LDAP calls in the last minute
The Minimum average time (in milliseconds) it takes for an LDAP call to return
ldap_latency_avg_min_ms min
results from a domain controller, averaged over LDAP calls in the last minute
The Maximum average time (in milliseconds) it takes for an LDAP call to return
ldap_latency_avg_max_ms max
results from a domain controller, averaged over LDAP calls in the last minute
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 915
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 916
AI Operations Management - Containerized 24.4
1.4.2.4.69. opsb_exch_pop3_perf_1h
Description Collects the POP3 performance counters (Hourly)
Source dataset opsb_exch_pop3_perf
Data Aggregation
Column Name Size Description
Type Type
failed_conn_avg_count integer 24 average The Average number of POP3 connections that are failed
failed_conn_min_count integer 24 min The Minimum number of POP3 connections that are failed
failed_conn_max_count integer 24 max The Maximum number of POP3 connections that are failed
total_rejected_conn_count integer 24 lastval Total number of POP3 connections that are rejected
total_rejected_conn_avg_count integer 24 average The Average total number of POP3 connections that are rejected
total_rejected_conn_min_count integer 24 min The Minimum total number of POP3 connections that are rejected
total_rejected_conn_max_count integer 24 max The Maximum total number of POP3 connections that are rejected
conn_avg_count_per_s double 24 average The Average number of POP3 connections that occur per second
conn_min_count_per_s double 24 min The Minimum number of POP3 connections that occur per second
conn_max_count_per_s double 24 max The Maximum number of POP3 connections that occur per second
curr_open_conn_count integer 24 lastval The number of connections that are currently open on the POP3 service
curr_open_conn_avg_count integer 24 average The Average number of connections that are currently open on the POP3 service
curr_open_conn_min_count integer 24 min The Minimum number of connections that are currently open on the POP3 service
curr_open_conn_max_count integer 24 max The Maximum number of connections that are currently open on the POP3 service
unauth_conn_avg_count_per_s double 24 average The Average number of unauthenticated connections that occur per second
unauth_conn_min_count_per_s double 24 min The Minimum number of unauthenticated connections that occur per second
unauth_conn_max_count_per_s double 24 max The Maximum number of unauthenticated connections that occur per second
proxy_curr_conn_count integer 24 lastval The number of proxy connections that are currently open on the POP3 service
The Average number of proxy connections that are currently open on the POP3
proxy_curr_conn_avg_count integer 24 average
service
The Minimum number of proxy connections that are currently open on the POP3
proxy_curr_conn_min_count integer 24 min
service
The Maximum number of proxy connections that are currently open on the POP3
proxy_curr_conn_max_count integer 24 max
service
The number of proxy connections that have failed since the POP3 service was
failed_proxy_conn_count integer 24 lastval
started
The Average number of proxy connections that have failed since the POP3 service
failed_proxy_conn_avg_count integer 24 average
was started
The Minimum number of proxy connections that have failed since the POP3 service
failed_proxy_conn_min_count integer 24 min
was started
The Maximum number of proxy connections that have failed since the POP3 service
failed_proxy_conn_max_count integer 24 max
was started
The total number of proxy connections that have been opened since the POP3
total_proxy_conn_count integer 24 lastval
service was started
The Average total number of proxy connections that have been opened since the
total_proxy_conn_avg_count integer 24 average
POP3 service was started
The Minimum total number of proxy connections that have been opened since the
total_proxy_conn_min_count integer 24 min
POP3 service was started
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 917
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Maximum total number of proxy connections that have been opened since the
total_proxy_conn_max_count integer 24 max
POP3 service was started
active_ssl_conn_count integer 24 lastval The number of SSL or TLS connections that are currently open on the POP3 service
The Average number of SSL or TLS connections that are currently open on the POP3
active_ssl_conn_avg_count integer 24 average
service
The Minimum number of SSL or TLS connections that are currently open on the
active_ssl_conn_min_count integer 24 min
POP3 service
The Maximum number of SSL or TLS connections that are currently open on the
active_ssl_conn_max_count integer 24 max
POP3 service
The total number of SSL or TLS connections that have been opened since the POP3
total_ssl_conn_count integer 24 lastval
service was started
The Average total number of SSL or TLS connections that have been opened since
total_ssl_conn_avg_count integer 24 average
the POP3 service was started
The Minimum total number of SSL or TLS connections that have been opened since
total_ssl_conn_min_count integer 24 min
the POP3 service was started
The Maximum total number of SSL or TLS connections that have been opened since
total_ssl_conn_max_count integer 24 max
the POP3 service was started
auth_cmd_failure_count integer 24 lastval The number of AUTH commands that have failed since the POP3 service was started
The Average number of AUTH commands that have failed since the POP3 service
auth_cmd_failure_avg_count integer 24 average
was started
The Minimum number of AUTH commands that have failed since the POP3 service
auth_cmd_failure_min_count integer 24 min
was started
The Maximum number of AUTH commands that have failed since the POP3 service
auth_cmd_failure_max_count integer 24 max
was started
auth_cmd_avg_count_per_s double 24 average The Average number of AUTH commands per second
auth_cmd_min_count_per_s double 24 min The Minimum number of AUTH commands per second
auth_cmd_max_count_per_s double 24 max The Maximum number of AUTH commands per second
The total number of AUTH commands that have been received since the POP3
total_auth_cmd_count integer 24 lastval
service was started
The Average total number of AUTH commands that have been received since the
total_auth_cmd_avg_count integer 24 average
POP3 service was started
The Minimum total number of AUTH commands that have been received since the
total_auth_cmd_min_count integer 24 min
POP3 service was started
The Maximum total number of AUTH commands that have been received since the
total_auth_cmd_max_count integer 24 max
POP3 service was started
The number of DELETE commands that have failed since the POP3 service was
failed_del_cmd_count integer 24 lastval
started
The Average number of DELETE commands that have failed since the POP3 service
failed_del_cmd_avg_count integer 24 average
was started
The Minimum number of DELETE commands that have failed since the POP3 service
failed_del_cmd_min_count integer 24 min
was started
The Maximum number of DELETE commands that have failed since the POP3 service
failed_del_cmd_max_count integer 24 max
was started
del_cmd_avg_count_per_s double 24 average The Average number of DELETE commands per second
del_cmd_min_count_per_s double 24 min The Minimum number of DELETE commands per second
del_cmd_max_count_per_s double 24 max The Maximum number of DELETE commands per second
The total number of DELETE commands that have been received since the POP3
recvd_del_cmd_count integer 24 lastval
service
The Average total number of DELETE commands that have been received since the
recvd_del_cmd_avg_count integer 24 average
POP3 service
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 918
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Minimum total number of DELETE commands that have been received since the
recvd_del_cmd_min_count integer 24 min
POP3 service
The Maximum total number of DELETE commands that have been received since
recvd_del_cmd_max_count integer 24 max
the POP3 service
req_failure_count integer 24 lastval The number of requests that have failed since the POP3 service was started
req_failure_avg_count integer 24 average The Average number of requests that have failed since the POP3 service was started
The Minimum number of requests that have failed since the POP3 service was
req_failure_min_count integer 24 min
started
The Maximum number of requests that have failed since the POP3 service was
req_failure_max_count integer 24 max
started
The total number of requests that have been received since the POP3 service was
total_req_recvd_count integer 24 lastval
started
The Average total number of requests that have been received since the POP3
total_req_recvd_avg_count integer 24 average
service was started
The Minimum total number of requests that have been received since the POP3
total_req_recvd_min_count integer 24 min
service was started
The Maximum total number of requests that have been received since the POP3
total_req_recvd_max_count integer 24 max
service was started
The Average time, in milliseconds, that it takes for a remote procedure call to return
pop3_rpc_latency_avg_ms double 24 average
results from a Mailbox server, averaged over RPC calls in the last minute
The Minimum average time, in milliseconds, that it takes for a remote procedure
pop3_rpc_latency_avg_min_ms double 24 min call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Maximum average time, in milliseconds, that it takes for a remote procedure
pop3_rpc_latency_avg_max_ms double 24 max call to return results from a Mailbox server, averaged over RPC calls in the last
minute
The Average time (in milliseconds) it takes for an LDAP call to return results from a
ldap_latency_avg_ms double 24 average
domain controller, averaged over LDAP calls in the last minute
The Minimum average time (in milliseconds) it takes for an LDAP call to return
ldap_latency_avg_min_ms double 24 min
results from a domain controller, averaged over LDAP calls in the last minute
The Maximum average time (in milliseconds) it takes for an LDAP call to return
ldap_latency_avg_max_ms double 24 max
results from a domain controller, averaged over LDAP calls in the last minute
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 919
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 920
AI Operations Management - Containerized 24.4
1.4.2.4.70. opsb_exch_processor_info
Description Collects metrics for CPU utilization
Key columns exchange_server_fqdn, processor_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 921
AI Operations Management - Containerized 24.4
1.4.2.4.71. opsb_exch_processor_info_1d
Description Collects metrics for CPU utilization (Daily)
Source dataset opsb_exch_processor_info
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 922
AI Operations Management - Containerized 24.4
1.4.2.4.72. opsb_exch_processor_info_1h
Description Collects metrics for CPU utilization (Hourly)
Source dataset opsb_exch_processor_info
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 923
AI Operations Management - Containerized 24.4
1.4.2.4.73. opsb_exch_processor_time
Description Collects metrics for Exchange server processor
Key columns exchange_server_fqdn, processor_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 924
AI Operations Management - Containerized 24.4
1.4.2.4.74. opsb_exch_processor_time_1d
Description Collects metrics for Exchange server processor (Daily)
Source dataset opsb_exch_processor_time
Data Aggregation
Column Name Size Description
Type Type
processor_user_time_pctl_pct integer 24 90 percentile The Percentile of the processor User Time in Percentage
processor_privileged_time_pctl_pct integer 24 90 percentile The Percentile of the processor Privileged Time in Percentage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 925
AI Operations Management - Containerized 24.4
1.4.2.4.75. opsb_exch_processor_time_1h
Description Collects metrics for Exchange server processor (Hourly)
Source dataset opsb_exch_processor_time
Data Aggregation
Column Name Size Description
Type Type
processor_user_time_pctl_pct integer 24 90 percentile The Percentile of the processor User Time in Percentage
processor_privileged_time_pctl_pct integer 24 90 percentile The Percentile of the processor Privileged Time in Percentage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 926
AI Operations Management - Containerized 24.4
1.4.2.4.76. opsb_exch_public_folder_db
Description Collects the details about public folder database
Key columns exchange_server_fqdn, db_instance_key, timestamp_utc_s, node_fqdn
DATABASE_NAME public_folder_db_name string 255 Indicates the name of the Public Folder database
EDBPATH edb_file_path string 255 Public Folder EDB filepath of the Public Folder database
EDBFREE edb_drive_free_space_mb double 24 Available free disk space in the drive containing the EDB file
EDBTOTAL edb_drive_total_space_mb double 24 Total disk space of the drive containing the Public Folder EDB file
FOLDER_COUNT user_folder_count integer 24 Number of mailbox users in the Public Folder database
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 927
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 928
AI Operations Management - Containerized 24.4
1.4.2.4.77. opsb_exch_public_folder_db_1d
Description Collects the details about public folder database (Daily)
Source dataset opsb_exch_public_folder_db_1h
Data Aggregation
Column Name Size Description
Type Type
public_folder_db_name string 255 lastval Indicates the name of the Public Folder database
edb_file_path string 255 lastval Public Folder EDB filepath of the Public Folder database
edb_file_size_avg_mb double 24 average The Average size of the Public Folder EDB file
edb_file_size_min_mb double 24 min The Minimum size of the Public Folder EDB file
edb_file_size_max_mb double 24 max The Maximum size of the Public Folder EDB file
edb_drive_free_space_avg_mb double 24 average The Average available free disk space in the drive containing the EDB file
edb_drive_free_space_min_mb double 24 min The Minimum available free disk space in the drive containing the EDB file
edb_drive_free_space_max_mb double 24 max The Maximum available free disk space in the drive containing the EDB file
edb_drive_total_space_avg_mb double 24 average The Average total disk space of the drive containing the Public Folder EDB file
edb_drive_total_space_min_mb double 24 min The Minimum total disk space of the drive containing the Public Folder EDB file
edb_drive_total_space_max_mb double 24 max The Maximum total disk space of the drive containing the Public Folder EDB file
user_folder_count integer 24 lastval Number of mailbox users in the Public Folder database
user_folder_avg_count integer 24 average The Average number of mailbox users in the Public Folder database
user_folder_min_count integer 24 min The Minimum number of mailbox users in the Public Folder database
user_folder_max_count integer 24 max The Maximum number of mailbox users in the Public Folder database
total_msg_avg_count integer 24 average The Average number of messages in the Public Folder database
total_msg_min_count integer 24 min The Minimum number of messages in the Public Folder database
total_msg_max_count integer 24 max The Maximum number of messages in the Public Folder database
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 929
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 930
AI Operations Management - Containerized 24.4
1.4.2.4.78. opsb_exch_public_folder_db_1h
Description Collects the details about public folder database (Hourly)
Source dataset opsb_exch_public_folder_db
Data Aggregation
Column Name Size Description
Type Type
public_folder_db_name string 255 lastval Indicates the name of the Public Folder database
edb_file_path string 255 lastval Public Folder EDB filepath of the Public Folder database
edb_file_size_avg_mb double 24 average The Average size of the Public Folder EDB file
edb_file_size_min_mb double 24 min The Minimum size of the Public Folder EDB file
edb_file_size_max_mb double 24 max The Maximum size of the Public Folder EDB file
edb_drive_free_space_avg_mb double 24 average The Average available free disk space in the drive containing the EDB file
edb_drive_free_space_min_mb double 24 min The Minimum available free disk space in the drive containing the EDB file
edb_drive_free_space_max_mb double 24 max The Maximum available free disk space in the drive containing the EDB file
edb_drive_total_space_avg_mb double 24 average The Average total disk space of the drive containing the Public Folder EDB file
edb_drive_total_space_min_mb double 24 min The Minimum total disk space of the drive containing the Public Folder EDB file
edb_drive_total_space_max_mb double 24 max The Maximum total disk space of the drive containing the Public Folder EDB file
user_folder_count integer 24 lastval Number of mailbox users in the Public Folder database
user_folder_avg_count integer 24 average The Average number of mailbox users in the Public Folder database
user_folder_min_count integer 24 min The Minimum number of mailbox users in the Public Folder database
user_folder_max_count integer 24 max The Maximum number of mailbox users in the Public Folder database
total_msg_avg_count integer 24 average The Average number of messages in the Public Folder database
total_msg_min_count integer 24 min The Minimum number of messages in the Public Folder database
total_msg_max_count integer 24 max The Maximum number of messages in the Public Folder database
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 931
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 932
AI Operations Management - Containerized 24.4
1.4.2.4.79. opsb_exch_public_folder_details
Description Collects the public folder details
Key columns exchange_server_fqdn, public_folder_name, timestamp_utc_s, node_fqdn
PF_SIZE total_items_size_mb double 24 Total size of the items in the public folder. It is in MB
PF_LASTMFTIME last_modified_time string 255 Time when user of the mailbox logged in to do modification to folders
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed.
For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 933
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 934
AI Operations Management - Containerized 24.4
1.4.2.4.80. opsb_exch_public_folder_details_1d
Description Collects the public folder details (Daily)
Source dataset opsb_exch_public_folder_details_1h
Data Aggregation
Column Name Size Description
Type Type
total_items_size_avg_mb double 24 average The Average total size of the items in the public folder. It is in MB
total_items_size_min_mb double 24 min The Minimum total size of the items in the public folder. It is in MB
total_items_size_max_mb double 24 max The Maximum total size of the items in the public folder. It is in MB
total_del_items_size_avg_mb double 24 average The Average total size of the deleted items in MB
total_del_items_size_min_mb double 24 min The Minimum total size of the deleted items in MB
total_del_items_size_max_mb double 24 max The Maximum total size of the deleted items in MB
total_associated_items_size_avg_mb double 24 average The Average total size of the associated items in MB
total_associated_items_size_min_mb double 24 min The Minimum total size of the associated items in MB
total_associated_items_size_max_mb double 24 max The Maximum total size of the associated items in MB
total_item_avg_count integer 24 average The Average number of items in the public folder
total_item_min_count integer 24 min The Minimum number of items in the public folder
total_item_max_count integer 24 max The Maximum number of items in the public folder
associated_item_avg_count integer 24 average The Average number of associated items in the public folder
associated_item_min_count integer 24 min The Minimum number of associated items in the public folder
associated_item_max_count integer 24 max The Maximum number of associated items in the public folder
del_item_avg_count integer 24 average The Average number of deleted items in the public folder
del_item_min_count integer 24 min The Minimum number of deleted items in the public folder
del_item_max_count integer 24 max The Maximum number of deleted items in the public folder
last_modified_time string 255 lastval Time when user of the mailbox logged in to do modification to folders
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 935
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 936
AI Operations Management - Containerized 24.4
1.4.2.4.81. opsb_exch_public_folder_details_1h
Description Collects the public folder details (Hourly)
Source dataset opsb_exch_public_folder_details
Data Aggregation
Column Name Size Description
Type Type
total_items_size_avg_mb double 24 average The Average total size of the items in the public folder. It is in MB
total_items_size_min_mb double 24 min The Minimum total size of the items in the public folder. It is in MB
total_items_size_max_mb double 24 max The Maximum total size of the items in the public folder. It is in MB
total_del_items_size_avg_mb double 24 average The Average total size of the deleted items in MB
total_del_items_size_min_mb double 24 min The Minimum total size of the deleted items in MB
total_del_items_size_max_mb double 24 max The Maximum total size of the deleted items in MB
total_associated_items_size_avg_mb double 24 average The Average total size of the associated items in MB
total_associated_items_size_min_mb double 24 min The Minimum total size of the associated items in MB
total_associated_items_size_max_mb double 24 max The Maximum total size of the associated items in MB
total_item_avg_count integer 24 average The Average number of items in the public folder
total_item_min_count integer 24 min The Minimum number of items in the public folder
total_item_max_count integer 24 max The Maximum number of items in the public folder
associated_item_avg_count integer 24 average The Average number of associated items in the public folder
associated_item_min_count integer 24 min The Minimum number of associated items in the public folder
associated_item_max_count integer 24 max The Maximum number of associated items in the public folder
del_item_avg_count integer 24 average The Average number of deleted items in the public folder
del_item_min_count integer 24 min The Minimum number of deleted items in the public folder
del_item_max_count integer 24 max The Maximum number of deleted items in the public folder
last_modified_time string 255 lastval Time when user of the mailbox logged in to do modification to folders
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 937
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 938
AI Operations Management - Containerized 24.4
1.4.2.4.82. opsb_exch_rpc_client_perf
Description Collects performance counters for RPC Client Access Service
Key columns exchange_server_fqdn, rpc_client_instance_name, timestamp_utc_s, node_fqdn
Number of unique users that have shown some activity in the last
RPCACTUSERCNT active_user_count integer 24
two minutes
RPCCLRPCATM attempted_rpc_count integer 24 The client-reported total number of RPCs attempted by the users
RPCOPRSEC rpc_ops_count_per_s double 24 The rate at which RPC operations occur, per second
RPCPACKSEC rpc_packets_processed_count_per_s double 24 The rate at which RPC packets are processed per second
RPCDISOPRSEC dispatch_ops_count_per_s double 24 The number of RPC dispatch task operations, per second
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 939
AI Operations Management - Containerized 24.4
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 940
AI Operations Management - Containerized 24.4
1.4.2.4.83. opsb_exch_rpc_client_perf_1d
Description Collects performance counters for RPC Client Access Service (Daily)
Source dataset opsb_exch_rpc_client_perf_1h
Data Aggregation
Column Name Size Description
Type Type
Number of unique users that have shown some activity in the last two
active_user_count integer 24 lastval
minutes
The Average number of unique users that have shown some activity in the
active_user_avg_count integer 24 average
last two minutes
The Minimum number of unique users that have shown some activity in
active_user_min_count integer 24 min
the last two minutes
The Maximum number of unique users that have shown some activity in
active_user_max_count integer 24 max
the last two minutes
client_conn_avg_count integer 24 average The Average total number of client connections maintained
client_conn_min_count integer 24 min The Minimum total number of client connections maintained
client_conn_max_count integer 24 max The Maximum total number of client connections maintained
attempted_rpc_count integer 24 lastval The client-reported total number of RPCs attempted by the users
attempted_rpc_avg_count integer 24 average The Average client-reported total number of RPCs attempted by the users
attempted_rpc_min_count integer 24 min The Minimum client-reported total number of RPCs attempted by the users
successful_rpc_avg_count integer 24 average The Average client-reported total number of successful RPCs
successful_rpc_min_count integer 24 min The Minimum client-reported total number of successful RPCs
successful_rpc_max_count integer 24 max The Maximum client-reported total number of successful RPCs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 941
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
rpc_ops_avg_count_per_s double 24 average The Average rate at which RPC operations occur, per second
rpc_ops_min_count_per_s double 24 min The Minimum rate at which RPC operations occur, per second
rpc_ops_max_count_per_s double 24 max The Maximum rate at which RPC operations occur, per second
rpc_packets_processed_avg_count_per_s double 24 average The Average rate at which RPC packets are processed per second
rpc_packets_processed_min_count_per_s double 24 min The Minimum rate at which RPC packets are processed per second
rpc_packets_processed_max_count_per_s double 24 max The Maximum rate at which RPC packets are processed per second
Number of client requests that are currently being processed by the RPC
client_reqs_processed_count double 24 lastval
Client Access service
The Average number of client requests that are currently being processed
client_reqs_processed_avg_count double 24 average
by the RPC Client Access service
The Average RPC Client Latency is the latency (in milliseconds) averaged
rpc_client_latency_avg_ms average
for the past 1024 packets
The Minimum average RPC Client Latency is the latency (in milliseconds)
rpc_client_latency_avg_min_ms min
averaged for the past 1024 packets
The Maximum average RPC Client Latency is the latency (in milliseconds)
rpc_client_latency_avg_max_ms max
averaged for the past 1024 packets
dispatch_ops_avg_count_per_s double 24 average The Average number of RPC dispatch task operations, per second
dispatch_ops_min_count_per_s double 24 min The Minimum number of RPC dispatch task operations, per second
dispatch_ops_max_count_per_s double 24 max The Maximum number of RPC dispatch task operations, per second
dispatch_task_que_count double 24 lastval The number of RPC dispatch tasks waiting to be processed in the queue
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through
collection_data_flow string 80 lastval
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 942
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 943
AI Operations Management - Containerized 24.4
1.4.2.4.84. opsb_exch_rpc_client_perf_1h
Description Collects performance counters for RPC Client Access Service (Hourly)
Source dataset opsb_exch_rpc_client_perf
Data Aggregation
Column Name Size Description
Type Type
Number of unique users that have shown some activity in the last two
active_user_count integer 24 lastval
minutes
The Average number of unique users that have shown some activity in the
active_user_avg_count integer 24 average
last two minutes
The Minimum number of unique users that have shown some activity in
active_user_min_count integer 24 min
the last two minutes
The Maximum number of unique users that have shown some activity in
active_user_max_count integer 24 max
the last two minutes
client_conn_avg_count integer 24 average The Average total number of client connections maintained
client_conn_min_count integer 24 min The Minimum total number of client connections maintained
client_conn_max_count integer 24 max The Maximum total number of client connections maintained
attempted_rpc_count integer 24 lastval The client-reported total number of RPCs attempted by the users
attempted_rpc_avg_count integer 24 average The Average client-reported total number of RPCs attempted by the users
attempted_rpc_min_count integer 24 min The Minimum client-reported total number of RPCs attempted by the users
successful_rpc_avg_count integer 24 average The Average client-reported total number of successful RPCs
successful_rpc_min_count integer 24 min The Minimum client-reported total number of successful RPCs
successful_rpc_max_count integer 24 max The Maximum client-reported total number of successful RPCs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 944
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
rpc_ops_avg_count_per_s double 24 average The Average rate at which RPC operations occur, per second
rpc_ops_min_count_per_s double 24 min The Minimum rate at which RPC operations occur, per second
rpc_ops_max_count_per_s double 24 max The Maximum rate at which RPC operations occur, per second
rpc_packets_processed_avg_count_per_s double 24 average The Average rate at which RPC packets are processed per second
rpc_packets_processed_min_count_per_s double 24 min The Minimum rate at which RPC packets are processed per second
rpc_packets_processed_max_count_per_s double 24 max The Maximum rate at which RPC packets are processed per second
Number of client requests that are currently being processed by the RPC
client_reqs_processed_count double 24 lastval
Client Access service
The Average number of client requests that are currently being processed
client_reqs_processed_avg_count double 24 average
by the RPC Client Access service
The Average RPC Client Latency is the latency (in milliseconds) averaged
rpc_client_latency_avg_ms double 24 average
for the past 1024 packets
The Minimum average RPC Client Latency is the latency (in milliseconds)
rpc_client_latency_avg_min_ms double 24 min
averaged for the past 1024 packets
The Maximum average RPC Client Latency is the latency (in milliseconds)
rpc_client_latency_avg_max_ms double 24 max
averaged for the past 1024 packets
dispatch_ops_avg_count_per_s double 24 average The Average number of RPC dispatch task operations, per second
dispatch_ops_min_count_per_s double 24 min The Minimum number of RPC dispatch task operations, per second
dispatch_ops_max_count_per_s double 24 max The Maximum number of RPC dispatch task operations, per second
dispatch_task_que_count double 24 lastval The number of RPC dispatch tasks waiting to be processed in the queue
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through
collection_data_flow string 80 lastval
an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 945
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 946
AI Operations Management - Containerized 24.4
1.4.2.4.85. opsb_exch_service_status
Description Collects metric information about Service Status
Key columns exchange_server_fqdn, svc_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 947
AI Operations Management - Containerized 24.4
1.4.2.4.86. opsb_exch_service_status_1d
Description Collects metric information about Service Status (Daily)
Source dataset opsb_exch_service_status_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 948
AI Operations Management - Containerized 24.4
1.4.2.4.87. opsb_exch_service_status_1h
Description Collects metric information about Service Status (Hourly)
Source dataset opsb_exch_service_status
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 949
AI Operations Management - Containerized 24.4
1.4.2.4.88. opsb_exch_smtp_receive
Description Collects performance counters for the SMTP Receive component
Key columns exchange_server_fqdn, smtp_recvd_connector_instance_name, timestamp_utc_s, node_fqdn
SMTPCONNCURR smtp_recvd_inbound_conn_count integer 24 Number of inbound connections to the SMTP receive server
SMTPMSGRECV smtp_recvd_total_recvd_msg_count integer 24 The number of messages received by the SMTP receive server
SMTPMBYTERCSEC smtp_recvd_msg_bps double 24 Number of SMTP bytes received in messages per second
SMTPAVBYMSG smtp_recvd_msg_b double 24 Average bytes per inbound SMTP message received
SMTPAVBYTCN smtp_bytes_recvd_per_conn_count double 24 Average number of SMTP bytes received per connection.
SMTPAVMSGCN smtp_msgs_recvd_per_conn_count double 24 Average number of SMTP messages received per connection
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 950
AI Operations Management - Containerized 24.4
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 951
AI Operations Management - Containerized 24.4
1.4.2.4.89. opsb_exch_smtp_receive_1d
Description Collects performance counters for the SMTP Receive component (Daily)
Source dataset opsb_exch_smtp_receive_1h
Data Aggregation
Column Name Size Description
Type Type
smtp_recvd_inbound_conn_count integer 24 lastval Number of inbound connections to the SMTP receive server
smtp_recvd_conn_total_count integer 24 lastval Total number of connections ever made to the SMTP receive server
smtp_recvd_total_recvd_msg_count integer 24 lastval The number of messages received by the SMTP receive server
smtp_recvd_total_recvd_msg_avg_count integer 24 average The Average number of messages received by the SMTP receive server
smtp_recvd_msg_avg_bps double 24 average The Average number of SMTP bytes received in messages per second
smtp_recvd_msg_min_bps double 24 min The Minimum number of SMTP bytes received in messages per second
smtp_recvd_msg_max_bps double 24 max The Maximum number of SMTP bytes received in messages per second
smtp_recvd_msg_avg_b double 24 average The Average bytes per inbound SMTP message received
smtp_recvd_msg_min_b double 24 min The Minimum average bytes per inbound SMTP message received
smtp_recvd_msg_max_b double 24 max The Maximum average bytes per inbound SMTP message received
smtp_recvd_recipient_per_msg_count double 24 lastval Average number of recipients per inbound SMTP message received
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 952
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_recvd_recipient_per_msg_avg_count double 24 average The Average number of recipients per inbound SMTP message received
smtp_bytes_recvd_per_conn_count double 24 lastval Average number of SMTP bytes received per connection.
smtp_bytes_recvd_per_conn_avg_count double 24 average The Average number of SMTP bytes received per connection.
smtp_bytes_recvd_per_conn_min_count double 24 min The Minimum average number of SMTP bytes received per connection.
smtp_bytes_recvd_per_conn_max_count double 24 max The Maximum average number of SMTP bytes received per connection.
smtp_msgs_recvd_per_conn_count double 24 lastval Average number of SMTP messages received per connection
smtp_msgs_recvd_per_conn_avg_count double 24 average The Average number of SMTP messages received per connection
smtp_recvd_avg_bps double 24 average The Average number of SMTP bytes received per second
smtp_recvd_min_bps double 24 min The Minimum number of SMTP bytes received per second
smtp_recvd_max_bps double 24 max The Maximum number of SMTP bytes received per second
smtp_total_recvd_bytes_avg_count integer 24 average The Average total number of SMTP bytes received
smtp_total_recvd_bytes_min_count integer 24 min The Minimum total number of SMTP bytes received
smtp_total_recvd_bytes_max_count integer 24 max The Maximum total number of SMTP bytes received
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 953
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 954
AI Operations Management - Containerized 24.4
1.4.2.4.90. opsb_exch_smtp_receive_1h
Description Collects performance counters for the SMTP Receive component (Hourly)
Source dataset opsb_exch_smtp_receive
Data Aggregation
Column Name Size Description
Type Type
smtp_recvd_inbound_conn_count integer 24 lastval Number of inbound connections to the SMTP receive server
smtp_recvd_conn_total_count integer 24 lastval Total number of connections ever made to the SMTP receive server
smtp_recvd_total_recvd_msg_count integer 24 lastval The number of messages received by the SMTP receive server
smtp_recvd_total_recvd_msg_avg_count integer 24 average The Average number of messages received by the SMTP receive server
smtp_recvd_msg_avg_bps double 24 average The Average number of SMTP bytes received in messages per second
smtp_recvd_msg_min_bps double 24 min The Minimum number of SMTP bytes received in messages per second
smtp_recvd_msg_max_bps double 24 max The Maximum number of SMTP bytes received in messages per second
smtp_recvd_msg_avg_b double 24 average The Average bytes per inbound SMTP message received
smtp_recvd_msg_min_b double 24 min The Minimum average bytes per inbound SMTP message received
smtp_recvd_msg_max_b double 24 max The Maximum average bytes per inbound SMTP message received
smtp_recvd_recipient_per_msg_count double 24 lastval Average number of recipients per inbound SMTP message received
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 955
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_recvd_recipient_per_msg_avg_count double 24 average The Average number of recipients per inbound SMTP message received
smtp_bytes_recvd_per_conn_count double 24 lastval Average number of SMTP bytes received per connection.
smtp_bytes_recvd_per_conn_avg_count double 24 average The Average number of SMTP bytes received per connection.
smtp_bytes_recvd_per_conn_min_count double 24 min The Minimum average number of SMTP bytes received per connection.
smtp_bytes_recvd_per_conn_max_count double 24 max The Maximum average number of SMTP bytes received per connection.
smtp_msgs_recvd_per_conn_count double 24 lastval Average number of SMTP messages received per connection
smtp_msgs_recvd_per_conn_avg_count double 24 average The Average number of SMTP messages received per connection
smtp_recvd_avg_bps double 24 average The Average number of SMTP bytes received per second
smtp_recvd_min_bps double 24 min The Minimum number of SMTP bytes received per second
smtp_recvd_max_bps double 24 max The Maximum number of SMTP bytes received per second
smtp_total_recvd_bytes_avg_count integer 24 average The Average total number of SMTP bytes received
smtp_total_recvd_bytes_min_count integer 24 min The Minimum total number of SMTP bytes received
smtp_total_recvd_bytes_max_count integer 24 max The Maximum total number of SMTP bytes received
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 956
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 957
AI Operations Management - Containerized 24.4
1.4.2.4.91. opsb_exch_smtp_send_new
Description Collects performance counters for the Exchange SMTP New Send component
Key columns exchange_server_fqdn, send_connector_instance_name, timestamp_utc_s, node_fqdn
SMTPMSGSEND total_msgs_send_count integer 24 Total number of messages sent by the SMTP Send connector
SMTPRCPSENT recipient_send_count integer 24 Number of recipients sent by the SMTP Send Connector
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 958
AI Operations Management - Containerized 24.4
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 959
AI Operations Management - Containerized 24.4
1.4.2.4.92. opsb_exch_smtp_send_new_1d
Description Collects performance counters for the Exchange SMTP new Send component (Daily)
Source dataset opsb_exch_smtp_send_new_1h
Data Aggregation
Column Name Size Description
Type Type
outbound_conn_count integer 24 lastval The number of outbound connections from the SMTP Send connector
total_conn_count integer 24 lastval Number of connections ever made from the SMTP Send connector
The Average number of connections ever made from the SMTP Send
total_conn_avg_count integer 24 average
connector
The Minimum number of connections ever made from the SMTP Send
total_conn_min_count integer 24 min
connector
The Maximum number of connections ever made from the SMTP Send
total_conn_max_count integer 24 max
connector
total_msgs_send_count integer 24 lastval Total number of messages sent by the SMTP Send connector
The Average total number of bytes sent, this number only includes
total_send_msg_avg_b integer 24 average
messages that are successfully sent
The Minimum total number of bytes sent, this number only includes
total_send_msg_min_b integer 24 min
messages that are successfully sent
The Maximum total number of bytes sent, this number only includes
total_send_msg_max_b integer 24 max
messages that are successfully sent
smtp_send_msg_avg_bps double 24 average The Average number of bytes sent per second
smtp_send_msg_min_bps double 24 min The Minimum number of bytes sent per second
smtp_send_msg_max_bps double 24 max The Maximum number of bytes sent per second
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 960
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_send_avg_bps double 24 average The Average number of bytes sent per second
smtp_send_min_bps double 24 min The Minimum number of bytes sent per second
smtp_send_max_bps double 24 max The Maximum number of bytes sent per second
recipient_send_count integer 24 lastval Number of recipients sent by the SMTP Send Connector
recipient_send_avg_count integer 24 average The Average number of recipients sent by the SMTP Send Connector
recipient_send_min_count integer 24 min The Minimum number of recipients sent by the SMTP Send Connector
recipient_send_max_count integer 24 max The Maximum number of recipients sent by the SMTP Send Connector
msg_recipients_count double 24 lastval Average recipients per message handled by the SMTP Send Connector
The Average number of bytes per message sent by this SMTP Send
bytes_per_msg_avg_count double 24 average
Connector
The Minimum average number of bytes per message sent by this SMTP
bytes_per_msg_min_count double 24 min
Send Connector
The Maximum average number of bytes per message sent by this SMTP
bytes_per_msg_max_count double 24 max
Send Connector
The Average number of bytes sent per connection by this SMTP Send
bytes_per_conn_avg_count double 24 average
Connector
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 961
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Number of socket errors with IPv4 SMTP host encountered by the send
socket_err_last_hour_ipv4_count integer 24 lastval
connector in the last hour.
The Average number of socket errors with IPv4 SMTP host encountered
socket_err_last_hour_ipv4_avg_count integer 24 average
by the send connector in the last hour.
Number of socket errors with IPv6 SMTP host encountered by the send
socket_err_last_hour_ipv6_count integer 24 lastval
connector in the last hour
The Average number of socket errors with IPv6 SMTP host encountered
socket_err_last_hour_ipv6_avg_count integer 24 average
by the send connector in the last hour
Number of inbound proxy out transient SMTP (4xx) errors in the last
send_protocol_err_last_hour_4xx_count integer 24 lastval
hour
The Average number of inbound proxy out transient SMTP (4xx) errors
send_protocol_err_last_hour_4xx_avg_count integer 24 average
in the last hour
The Minimum number of inbound proxy out transient SMTP (4xx) errors
send_protocol_err_last_hour_4xx_min_count integer 24 min
in the last hour
Number of inbound proxy out permanent SMTP (5xx) errors in the last
send_protocol_err_last_hour_5xx_count integer 24 lastval
hour
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 962
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present
in the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 963
AI Operations Management - Containerized 24.4
1.4.2.4.93. opsb_exch_smtp_send_new_1h
Description Collects performance counters for the Exchange SMTP new Send component (Hourly)
Source dataset opsb_exch_smtp_send_new
Data Aggregation
Column Name Size Description
Type Type
outbound_conn_count integer 24 lastval The number of outbound connections from the SMTP Send connector
total_conn_count integer 24 lastval Number of connections ever made from the SMTP Send connector
The Average number of connections ever made from the SMTP Send
total_conn_avg_count integer 24 average
connector
The Minimum number of connections ever made from the SMTP Send
total_conn_min_count integer 24 min
connector
The Maximum number of connections ever made from the SMTP Send
total_conn_max_count integer 24 max
connector
total_msgs_send_count integer 24 lastval Total number of messages sent by the SMTP Send connector
The Average total number of bytes sent, this number only includes
total_send_msg_avg_b integer 24 average
messages that are successfully sent
The Minimum total number of bytes sent, this number only includes
total_send_msg_min_b integer 24 min
messages that are successfully sent
The Maximum total number of bytes sent, this number only includes
total_send_msg_max_b integer 24 max
messages that are successfully sent
smtp_send_msg_avg_bps double 24 average The Average number of bytes sent per second
smtp_send_msg_min_bps double 24 min The Minimum number of bytes sent per second
smtp_send_msg_max_bps double 24 max The Maximum number of bytes sent per second
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 964
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_send_avg_bps double 24 average The Average number of bytes sent per second
smtp_send_min_bps double 24 min The Minimum number of bytes sent per second
smtp_send_max_bps double 24 max The Maximum number of bytes sent per second
recipient_send_count integer 24 lastval Number of recipients sent by the SMTP Send Connector
recipient_send_avg_count integer 24 average The Average number of recipients sent by the SMTP Send Connector
recipient_send_min_count integer 24 min The Minimum number of recipients sent by the SMTP Send Connector
recipient_send_max_count integer 24 max The Maximum number of recipients sent by the SMTP Send Connector
msg_recipients_count double 24 lastval Average recipients per message handled by the SMTP Send Connector
The Average number of bytes per message sent by this SMTP Send
bytes_per_msg_avg_count double 24 average
Connector
The Minimum average number of bytes per message sent by this SMTP
bytes_per_msg_min_count double 24 min
Send Connector
The Maximum average number of bytes per message sent by this SMTP
bytes_per_msg_max_count double 24 max
Send Connector
The Average number of bytes sent per connection by this SMTP Send
bytes_per_conn_avg_count double 24 average
Connector
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 965
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Number of socket errors with IPv4 SMTP host encountered by the send
socket_err_last_hour_ipv4_count integer 24 lastval
connector in the last hour.
The Average number of socket errors with IPv4 SMTP host encountered
socket_err_last_hour_ipv4_avg_count integer 24 average
by the send connector in the last hour.
Number of socket errors with IPv6 SMTP host encountered by the send
socket_err_last_hour_ipv6_count integer 24 lastval
connector in the last hour
The Average number of socket errors with IPv6 SMTP host encountered
socket_err_last_hour_ipv6_avg_count integer 24 average
by the send connector in the last hour
Number of inbound proxy out transient SMTP (4xx) errors in the last
send_protocol_err_last_hour_4xx_count integer 24 lastval
hour
The Average number of inbound proxy out transient SMTP (4xx) errors
send_protocol_err_last_hour_4xx_avg_count integer 24 average
in the last hour
The Minimum number of inbound proxy out transient SMTP (4xx) errors
send_protocol_err_last_hour_4xx_min_count integer 24 min
in the last hour
Number of inbound proxy out permanent SMTP (5xx) errors in the last
send_protocol_err_last_hour_5xx_count integer 24 lastval
hour
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 966
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present
in the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 967
AI Operations Management - Containerized 24.4
1.4.2.4.94. opsb_exch_smtp_send_old
Description Collects performance counters for the Exchange SMTP Old Send component
Key columns exchange_server_fqdn, smtp_send_connector_instance_name, timestamp_utc_s, node_fqdn
INSTANCE_NAME smtp_send_connector_instance_name string 255 Name of the SMTP Send old Connector
SMTPMBYSNSEC smtp_send_msg_bps double 24 Number of SMTP old bytes sent per second
SMTPBYSNTSEC smtp_send_bps double 24 Number of SMTP Send Old bytes per second
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 968
AI Operations Management - Containerized 24.4
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 969
AI Operations Management - Containerized 24.4
1.4.2.4.95. opsb_exch_smtp_send_old_1d
Description Collects performance counters for the Exchange SMTP Old Send component (Daily)
Source dataset opsb_exch_smtp_send_old_1h
Data Aggregation
Column Name Size Description
Type Type
smtp_send_msg_avg_bps double 24 average The Average number of SMTP old bytes sent per second
smtp_send_msg_min_bps double 24 min The Minimum number of SMTP old bytes sent per second
smtp_send_msg_max_bps double 24 max The Maximum number of SMTP old bytes sent per second
smtp_total_bytes_send_avg_count integer 24 average The Average total number of SMTP Old bytes sent
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 970
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_total_bytes_send_min_count integer 24 min The Minimum total number of SMTP Old bytes sent
smtp_total_bytes_send_max_count integer 24 max The Maximum total number of SMTP Old bytes sent
smtp_send_avg_bps double 24 average The Average number of SMTP Send Old bytes per second
smtp_send_min_bps double 24 min The Minimum number of SMTP Send Old bytes per second
smtp_send_max_bps double 24 max The Maximum number of SMTP Send Old bytes per second
smtp_recipient_send_count integer 24 lastval Number of recipients sent by the SMTP Send old Connector
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 971
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_send_protocol_err_avg_count integer 24 average The Average number of SMTP Send Old Protocol Errors
smtp_send_protocol_err_min_count integer 24 min The Minimum number of SMTP Send Old Protocol Errors
smtp_send_protocol_err_max_count integer 24 max The Maximum number of SMTP Send Old Protocol Errors
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
collection_policy_name string 255 lastval policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 972
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 973
AI Operations Management - Containerized 24.4
1.4.2.4.96. opsb_exch_smtp_send_old_1h
Description Collects performance counters for the Exchange SMTP Old Send component (Hourly)
Source dataset opsb_exch_smtp_send_old
Data Aggregation
Column Name Size Description
Type Type
smtp_send_msg_avg_bps double 24 average The Average number of SMTP old bytes sent per second
smtp_send_msg_min_bps double 24 min The Minimum number of SMTP old bytes sent per second
smtp_send_msg_max_bps double 24 max The Maximum number of SMTP old bytes sent per second
smtp_total_bytes_send_avg_count integer 24 average The Average total number of SMTP Old bytes sent
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 974
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_total_bytes_send_min_count integer 24 min The Minimum total number of SMTP Old bytes sent
smtp_total_bytes_send_max_count integer 24 max The Maximum total number of SMTP Old bytes sent
smtp_send_avg_bps double 24 average The Average number of SMTP Send Old bytes per second
smtp_send_min_bps double 24 min The Minimum number of SMTP Send Old bytes per second
smtp_send_max_bps double 24 max The Maximum number of SMTP Send Old bytes per second
smtp_recipient_send_count integer 24 lastval Number of recipients sent by the SMTP Send old Connector
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 975
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
smtp_send_protocol_err_avg_count integer 24 average The Average number of SMTP Send Old Protocol Errors
smtp_send_protocol_err_min_count integer 24 min The Minimum number of SMTP Send Old Protocol Errors
smtp_send_protocol_err_max_count integer 24 max The Maximum number of SMTP Send Old Protocol Errors
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
collection_policy_name string 255 lastval policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 976
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 977
AI Operations Management - Containerized 24.4
1.4.2.4.97. opsb_exch_store_infomation_perf
Description Collects performance counters for Exchange Information Store
Key columns exchange_server_fqdn, store_instance_name, timestamp_utc_s, node_fqdn
RPCREQ rpc_req_count integer 24 The number of MAPI RPC requests that are currently in progress
MSGDLPSEC delivered_msg_count_per_s double 24 The number of messages delivered to the database per second
MSGSUBPSEC submitted_msg_count_per_s double 24 The number of messages submitted from the database per second
QRMBCNT quarantined_mailbox_count integer 24 Indicates the number of quarantined mailboxes per database
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can
collection_source collection_source string 255 be the name of hostname if the source is AMC else if its empty it
will be Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If
CollectionConfigName collection_policy_name string 255
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 978
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 979
AI Operations Management - Containerized 24.4
1.4.2.4.98. opsb_exch_store_infomation_perf_1d
Description Collects performance counters for Exchange Information Store (Daily)
Source dataset opsb_exch_store_infomation_perf
Data Aggregation
Column Name Size Description
Type Type
rpc_req_count integer 24 lastval The number of MAPI RPC requests that are currently in progress
rpc_req_avg_count integer 24 average The Average number of MAPI RPC requests that are currently in progress
rpc_req_min_count integer 24 min The Minimum number of MAPI RPC requests that are currently in progress
rpc_req_max_count integer 24 max The Maximum number of MAPI RPC requests that are currently in progress
rpc_ops_avg_count_per_s double 24 average The Average number of RPC operations per second
rpc_ops_min_count_per_s double 24 min The Minimum number of RPC operations per second
rpc_ops_max_count_per_s double 24 max The Maximum number of RPC operations per second
info_rpc_latency_avg_ms double 24 average The Average Information latency of RPC process in milliseconds
info_rpc_latency_avg_min_ms double 24 min The Minimum average Information latency of RPC process in milliseconds
info_rpc_latency_avg_max_ms double 24 max The Maximum average Information latency of RPC process in milliseconds
delivered_msg_avg_count_per_s double 24 average The Average number of messages delivered to the database per second
delivered_msg_min_count_per_s double 24 min The Minimum number of messages delivered to the database per second
delivered_msg_max_count_per_s double 24 max The Maximum number of messages delivered to the database per second
submitted_msg_avg_count_per_s double 24 average The Average number of messages submitted from the database per second
submitted_msg_min_count_per_s double 24 min The Minimum number of messages submitted from the database per second
The Average number of MAPI message objects created on the database per
mapi_msgs_created_avg_count_per_s double 24 average
second
The Minimum number of MAPI message objects created on the database per
mapi_msgs_created_min_count_per_s double 24 min
second
The Average number of MAPI message objects opened on the database per
mapi_msgs_opened_avg_count_per_s double 24 average
second
The Minimum number of MAPI message objects opened on the database per
mapi_msgs_opened_min_count_per_s double 24 min
second
The Maximum number of MAPI message objects opened on the database per
mapi_msgs_opened_max_count_per_s double 24 max
second
The Average number of MAPI message objects modified on the database per
mapi_msgs_modified_avg_count_per_s double 24 average
second
The Average MAPI RPC Requests that are currently in progress as compared
mapi_inprogress_rpc_req_avg_pct double 24 average
to the maximum allowed in percentage
The Minimum MAPI RPC Requests that are currently in progress as compared
mapi_inprogress_rpc_req_min_pct double 24 min
to the maximum allowed in percentage
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 980
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Percentile of the MAPI RPC Requests that are currently in progress as
mapi_inprogress_rpc_req_pctl_pct double 24 90 percentile
compared to the maximum allowed in percentage
quarantined_mailbox_count integer 24 lastval Indicates the number of quarantined mailboxes per database
quarantined_mailbox_avg_count integer 24 average The Average indicates the number of quarantined mailboxes per database
quarantined_mailbox_min_count integer 24 min The Minimum indicates the number of quarantined mailboxes per database
quarantined_mailbox_max_count integer 24 max The Maximum indicates the number of quarantined mailboxes per database
active_background_task_count integer 24 lastval Indicates the total number of active background tasks currently executing
The Average indicates the total number of active background tasks currently
active_background_task_avg_count integer 24 average
executing
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 981
AI Operations Management - Containerized 24.4
1.4.2.4.99. opsb_exch_store_infomation_perf_1h
Description Collects performance counters for Exchange Information Store (Hourly)
Source dataset opsb_exch_store_infomation_perf
Data Aggregation
Column Name Size Description
Type Type
rpc_req_count integer 24 lastval The number of MAPI RPC requests that are currently in progress
rpc_req_avg_count integer 24 average The Average number of MAPI RPC requests that are currently in progress
rpc_req_min_count integer 24 min The Minimum number of MAPI RPC requests that are currently in progress
rpc_req_max_count integer 24 max The Maximum number of MAPI RPC requests that are currently in progress
rpc_ops_avg_count_per_s double 24 average The Average number of RPC operations per second
rpc_ops_min_count_per_s double 24 min The Minimum number of RPC operations per second
rpc_ops_max_count_per_s double 24 max The Maximum number of RPC operations per second
info_rpc_latency_avg_ms double 24 average The Average Information latency of RPC process in milliseconds
info_rpc_latency_avg_min_ms double 24 min The Minimum average Information latency of RPC process in milliseconds
info_rpc_latency_avg_max_ms double 24 max The Maximum average Information latency of RPC process in milliseconds
delivered_msg_avg_count_per_s double 24 average The Average number of messages delivered to the database per second
delivered_msg_min_count_per_s double 24 min The Minimum number of messages delivered to the database per second
delivered_msg_max_count_per_s double 24 max The Maximum number of messages delivered to the database per second
submitted_msg_avg_count_per_s double 24 average The Average number of messages submitted from the database per second
submitted_msg_min_count_per_s double 24 min The Minimum number of messages submitted from the database per second
The Average number of MAPI message objects created on the database per
mapi_msgs_created_avg_count_per_s double 24 average
second
The Minimum number of MAPI message objects created on the database per
mapi_msgs_created_min_count_per_s double 24 min
second
The Average number of MAPI message objects opened on the database per
mapi_msgs_opened_avg_count_per_s double 24 average
second
The Minimum number of MAPI message objects opened on the database per
mapi_msgs_opened_min_count_per_s double 24 min
second
The Maximum number of MAPI message objects opened on the database per
mapi_msgs_opened_max_count_per_s double 24 max
second
The Average number of MAPI message objects modified on the database per
mapi_msgs_modified_avg_count_per_s double 24 average
second
The Average MAPI RPC Requests that are currently in progress as compared
mapi_inprogress_rpc_req_avg_pct double 24 average
to the maximum allowed in percentage
The Minimum MAPI RPC Requests that are currently in progress as compared
mapi_inprogress_rpc_req_min_pct double 24 min
to the maximum allowed in percentage
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 982
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The Percentile of the MAPI RPC Requests that are currently in progress as
mapi_inprogress_rpc_req_pctl_pct double 24 90 percentile
compared to the maximum allowed in percentage
quarantined_mailbox_count integer 24 lastval Indicates the number of quarantined mailboxes per database
quarantined_mailbox_avg_count integer 24 average The Average indicates the number of quarantined mailboxes per database
quarantined_mailbox_min_count integer 24 min The Minimum indicates the number of quarantined mailboxes per database
quarantined_mailbox_max_count integer 24 max The Maximum indicates the number of quarantined mailboxes per database
active_background_task_count integer 24 lastval Indicates the total number of active background tasks currently executing
The Average indicates the total number of active background tasks currently
active_background_task_avg_count integer 24 average
executing
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow string 80 lastval
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id_id string 255
to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 983
AI Operations Management - Containerized 24.4
1.4.2.4.100. opsb_exch_store_interface_perf
Description Collects performance counters for Exchange Store Interface
Key columns exchange_server_fqdn, store_interface_name, timestamp_utc_s, node_fqdn
The total number of RPC requests that returned with a non zero result
STIRPCRQFL rpc_req_failed_count integer 24
from the server
STIRPCRQFE rpc_req_failed_exception_count integer 24 Total number of RPC requests that failed with exception
STIRPCRQSS rpc_req_initiated_count_per_s double 24 The current rate of initiated RPC requests per second
STIRPCLTTL rpc_latency_total_ms double 24 The total amount of time spent inside RPC calls (in milliseconds)
STIRPCLTAV rpc_latency_ms double 24 The average latency of RPC requests (in milliseconds)
STIRPCSPRQ rpc_slow_req_pct double 24 Slow RPC requests among all RPC requests in percentage
STIRPCSLTL rpc_slow_req_total_latency_ms double 24 Total amount of time spent inside slow RPC calls (in milliseconds)
STIRPCSRQA rpc_slow_req_latency_ms double 24 The average latency of slow RPC requests (in milliseconds)
STIRPCBYST rpc_send_b integer 24 Total number of bytes, sent to the server since exrpc32 was loaded
STIRPCBYSA rpc_avg_send_b double 24 The average number of bytes, sent to the server in one RPC call
The total number of bytes, received from the server since exrpc32
STIRPCBYRC rpc_recvd_b integer 24
was loaded
STIROPRQST rop_req_sent_count integer 24 The total number of ROP requests, buffered for delivery
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 984
AI Operations Management - Containerized 24.4
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed.
For Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 985
AI Operations Management - Containerized 24.4
1.4.2.4.101. opsb_exch_store_interface_perf_1d
Description Collects performance counters for Exchange Store Interface (Daily)
Source dataset opsb_exch_store_interface_perf
Data Aggregation
Column Name Size Description
Type Type
rpc_req_send_avg_count integer 24 average The Average total number of initiated RPC requests
rpc_req_send_min_count integer 24 min The Minimum total number of initiated RPC requests
rpc_req_send_max_count integer 24 max The Maximum total number of initiated RPC requests
rpc_req_succeed_avg_count integer 24 average The Average total number of succeeded RPC requests
rpc_req_succeed_min_count integer 24 min The Minimum total number of succeeded RPC requests
rpc_req_succeed_max_count integer 24 max The Maximum total number of succeeded RPC requests
The total number of RPC requests that returned with a non zero result from the
rpc_req_failed_count integer 24 lastval
server
The Average total number of RPC requests that returned with a non zero result
rpc_req_failed_avg_count integer 24 average
from the server
The Minimum total number of RPC requests that returned with a non zero
rpc_req_failed_min_count integer 24 min
result from the server
The Maximum total number of RPC requests that returned with a non zero
rpc_req_failed_max_count integer 24 max
result from the server
rpc_req_failed_exception_count integer 24 lastval Total number of RPC requests that failed with exception
rpc_req_failed_exception_avg_count integer 24 average The Average total number of RPC requests that failed with exception
rpc_req_failed_exception_min_count integer 24 min The Minimum total number of RPC requests that failed with exception
rpc_req_failed_exception_max_count integer 24 max The Maximum total number of RPC requests that failed with exception
rpc_req_outstanding_avg_count integer 24 average The Average current number of outstanding RPC requests
rpc_req_outstanding_min_count integer 24 min The Minimum current number of outstanding RPC requests
rpc_req_outstanding_max_count integer 24 max The Maximum current number of outstanding RPC requests
rpc_req_initiated_count_per_s double 24 lastval The current rate of initiated RPC requests per second
rpc_req_initiated_avg_count_per_s double 24 average The Average current rate of initiated RPC requests per second
rpc_req_initiated_min_count_per_s double 24 min The Minimum current rate of initiated RPC requests per second
rpc_req_initiated_max_count_per_s double 24 max The Maximum current rate of initiated RPC requests per second
rpc_latency_total_avg_ms double 24 average The Average total amount of time spent inside RPC calls (in milliseconds)
rpc_latency_total_min_ms double 24 min The Minimum total amount of time spent inside RPC calls (in milliseconds)
rpc_latency_total_max_ms double 24 max The Maximum total amount of time spent inside RPC calls (in milliseconds)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 986
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
rpc_latency_avg_ms double 24 average The Average latency of RPC requests (in milliseconds)
rpc_latency_min_ms double 24 min The Minimum average latency of RPC requests (in milliseconds)
rpc_latency_max_ms double 24 max The Maximum average latency of RPC requests (in milliseconds)
rpc_slow_req_avg_count integer 24 average The Average total number of slow RPC requests
rpc_slow_req_min_count integer 24 min The Minimum total number of slow RPC requests
rpc_slow_req_max_count integer 24 max The Maximum total number of slow RPC requests
rpc_slow_req_avg_pct double 24 average The Average slow RPC requests among all RPC requests in percentage
rpc_slow_req_min_pct double 24 min The Minimum slow RPC requests among all RPC requests in percentage
rpc_slow_req_max_pct double 24 max The Maximum slow RPC requests among all RPC requests in percentage
rpc_slow_req_pctl_pct double 24 90 percentile The Percentile of the slow RPC requests among all RPC requests in percentage
rpc_slow_req_total_latency_avg_ms double 24 average The Average total amount of time spent inside slow RPC calls (in milliseconds)
rpc_slow_req_total_latency_min_ms double 24 min The Minimum total amount of time spent inside slow RPC calls (in milliseconds)
The Maximum total amount of time spent inside slow RPC calls (in
rpc_slow_req_total_latency_max_ms double 24 max
milliseconds)
rpc_slow_req_latency_avg_ms double 24 average The Average latency of slow RPC requests (in milliseconds)
rpc_slow_req_latency_min_ms double 24 min The Minimum average latency of slow RPC requests (in milliseconds)
rpc_slow_req_latency_max_ms double 24 max The Maximum average latency of slow RPC requests (in milliseconds)
The Average total number of bytes, sent to the server since exrpc32 was
rpc_send_avg_b integer 24 average
loaded
The Minimum total number of bytes, sent to the server since exrpc32 was
rpc_send_min_b integer 24 min
loaded
The Maximum total number of bytes, sent to the server since exrpc32 was
rpc_send_max_b integer 24 max
loaded
rpc_avg_send_avg_b double 24 average The Average number of bytes, sent to the server in one RPC call
rpc_avg_send_min_b double 24 min The Minimum average number of bytes, sent to the server in one RPC call
rpc_avg_send_max_b double 24 max The Maximum average number of bytes, sent to the server in one RPC call
The Average total number of bytes, received from the server since exrpc32
rpc_recvd_avg_b integer 24 average
was loaded
The Minimum total number of bytes, received from the server since exrpc32
rpc_recvd_min_b integer 24 min
was loaded
The Maximum total number of bytes, received from the server since exrpc32
rpc_recvd_max_b integer 24 max
was loaded
The Average number of bytes, received from the server in one succeeded RPC
rpc_avg_recvd_avg_b double 24 average
call
The Minimum average number of bytes, received from the server in one
rpc_avg_recvd_min_b double 24 min
succeeded RPC call
The Maximum average number of bytes, received from the server in one
rpc_avg_recvd_max_b double 24 max
succeeded RPC call
rop_req_sent_count integer 24 lastval The total number of ROP requests, buffered for delivery
rop_req_sent_avg_count integer 24 average The Average total number of ROP requests, buffered for delivery
rop_req_sent_min_count integer 24 min The Minimum total number of ROP requests, buffered for delivery
rop_req_sent_max_count integer 24 max The Maximum total number of ROP requests, buffered for delivery
rop_req_completed_avg_count integer 24 average The Average total number of completed ROP requests
rop_req_completed_min_count integer 24 min The Minimum total number of completed ROP requests
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 987
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
rop_req_completed_max_count integer 24 max The Maximum total number of completed ROP requests
rop_req_outstanding_avg_count integer 24 average The Average total number of outstanding ROP requests
rop_req_outstanding_min_count integer 24 min The Minimum total number of outstanding ROP requests
rop_req_outstanding_max_count integer 24 max The Maximum total number of outstanding ROP requests
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 988
AI Operations Management - Containerized 24.4
1.4.2.4.102. opsb_exch_store_interface_perf_1h
Description Collects performance counters for Exchange Store Interface (Hourly)
Source dataset opsb_exch_store_interface_perf
Data Aggregation
Column Name Size Description
Type Type
rpc_req_send_avg_count integer 24 average The Average total number of initiated RPC requests
rpc_req_send_min_count integer 24 min The Minimum total number of initiated RPC requests
rpc_req_send_max_count integer 24 max The Maximum total number of initiated RPC requests
rpc_req_succeed_avg_count integer 24 average The Average total number of succeeded RPC requests
rpc_req_succeed_min_count integer 24 min The Minimum total number of succeeded RPC requests
rpc_req_succeed_max_count integer 24 max The Maximum total number of succeeded RPC requests
The total number of RPC requests that returned with a non zero result from the
rpc_req_failed_count integer 24 lastval
server
The Average total number of RPC requests that returned with a non zero result
rpc_req_failed_avg_count integer 24 average
from the server
The Minimum total number of RPC requests that returned with a non zero
rpc_req_failed_min_count integer 24 min
result from the server
The Maximum total number of RPC requests that returned with a non zero
rpc_req_failed_max_count integer 24 max
result from the server
rpc_req_failed_exception_count integer 24 lastval Total number of RPC requests that failed with exception
rpc_req_failed_exception_avg_count integer 24 average The Average total number of RPC requests that failed with exception
rpc_req_failed_exception_min_count integer 24 min The Minimum total number of RPC requests that failed with exception
rpc_req_failed_exception_max_count integer 24 max The Maximum total number of RPC requests that failed with exception
rpc_req_outstanding_avg_count integer 24 average The Average current number of outstanding RPC requests
rpc_req_outstanding_min_count integer 24 min The Minimum current number of outstanding RPC requests
rpc_req_outstanding_max_count integer 24 max The Maximum current number of outstanding RPC requests
rpc_req_initiated_count_per_s double 24 lastval The current rate of initiated RPC requests per second
rpc_req_initiated_avg_count_per_s double 24 average The Average current rate of initiated RPC requests per second
rpc_req_initiated_min_count_per_s double 24 min The Minimum current rate of initiated RPC requests per second
rpc_req_initiated_max_count_per_s double 24 max The Maximum current rate of initiated RPC requests per second
rpc_latency_total_avg_ms double 24 average The Average total amount of time spent inside RPC calls (in milliseconds)
rpc_latency_total_min_ms double 24 min The Minimum total amount of time spent inside RPC calls (in milliseconds)
rpc_latency_total_max_ms double 24 max The Maximum total amount of time spent inside RPC calls (in milliseconds)
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 989
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
rpc_latency_avg_ms double 24 average The Average latency of RPC requests (in milliseconds)
rpc_latency_min_ms double 24 min The Minimum average latency of RPC requests (in milliseconds)
rpc_latency_max_ms double 24 max The Maximum average latency of RPC requests (in milliseconds)
rpc_slow_req_avg_count integer 24 average The Average total number of slow RPC requests
rpc_slow_req_min_count integer 24 min The Minimum total number of slow RPC requests
rpc_slow_req_max_count integer 24 max The Maximum total number of slow RPC requests
rpc_slow_req_avg_pct double 24 average The Average slow RPC requests among all RPC requests in percentage
rpc_slow_req_min_pct double 24 min The Minimum slow RPC requests among all RPC requests in percentage
rpc_slow_req_max_pct double 24 max The Maximum slow RPC requests among all RPC requests in percentage
rpc_slow_req_pctl_pct double 24 90 percentile The Percentile of the slow RPC requests among all RPC requests in percentage
rpc_slow_req_total_latency_avg_ms double 24 average The Average total amount of time spent inside slow RPC calls (in milliseconds)
rpc_slow_req_total_latency_min_ms double 24 min The Minimum total amount of time spent inside slow RPC calls (in milliseconds)
The Maximum total amount of time spent inside slow RPC calls (in
rpc_slow_req_total_latency_max_ms double 24 max
milliseconds)
rpc_slow_req_latency_avg_ms double 24 average The Average latency of slow RPC requests (in milliseconds)
rpc_slow_req_latency_min_ms double 24 min The Minimum average latency of slow RPC requests (in milliseconds)
rpc_slow_req_latency_max_ms double 24 max The Maximum average latency of slow RPC requests (in milliseconds)
The Average total number of bytes, sent to the server since exrpc32 was
rpc_send_avg_b integer 24 average
loaded
The Minimum total number of bytes, sent to the server since exrpc32 was
rpc_send_min_b integer 24 min
loaded
The Maximum total number of bytes, sent to the server since exrpc32 was
rpc_send_max_b integer 24 max
loaded
rpc_avg_send_avg_b double 24 average The Average number of bytes, sent to the server in one RPC call
rpc_avg_send_min_b double 24 min The Minimum average number of bytes, sent to the server in one RPC call
rpc_avg_send_max_b double 24 max The Maximum average number of bytes, sent to the server in one RPC call
The Average total number of bytes, received from the server since exrpc32
rpc_recvd_avg_b integer 24 average
was loaded
The Minimum total number of bytes, received from the server since exrpc32
rpc_recvd_min_b integer 24 min
was loaded
The Maximum total number of bytes, received from the server since exrpc32
rpc_recvd_max_b integer 24 max
was loaded
The Average number of bytes, received from the server in one succeeded RPC
rpc_avg_recvd_avg_b double 24 average
call
The Minimum average number of bytes, received from the server in one
rpc_avg_recvd_min_b double 24 min
succeeded RPC call
The Maximum average number of bytes, received from the server in one
rpc_avg_recvd_max_b double 24 max
succeeded RPC call
rop_req_sent_count integer 24 lastval The total number of ROP requests, buffered for delivery
rop_req_sent_avg_count integer 24 average The Average total number of ROP requests, buffered for delivery
rop_req_sent_min_count integer 24 min The Minimum total number of ROP requests, buffered for delivery
rop_req_sent_max_count integer 24 max The Maximum total number of ROP requests, buffered for delivery
rop_req_completed_avg_count integer 24 average The Average total number of completed ROP requests
rop_req_completed_min_count integer 24 min The Minimum total number of completed ROP requests
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 990
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
rop_req_completed_max_count integer 24 max The Maximum total number of completed ROP requests
rop_req_outstanding_avg_count integer 24 average The Average total number of outstanding ROP requests
rop_req_outstanding_min_count integer 24 min The Minimum total number of outstanding ROP requests
rop_req_outstanding_max_count integer 24 max The Maximum total number of outstanding ROP requests
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 991
AI Operations Management - Containerized 24.4
1.4.2.4.103. opsb_exch_top_destination
Description Collects metric information about Top Destination
Key columns exchange_server_fqdn, email_source_key, timestamp_utc_s, node_fqdn
DOMAIN_NAME domain_name string 255 Domain name of the incoming mails source
SERVER_NAME exch_srv_name string 255 Name of the incoming mails source Exchange Server
ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Exchange Server is member of
IS_INTERNAL is_source_internal string 255 Identifies if the source is internal to the organization
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed.
For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 992
AI Operations Management - Containerized 24.4
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 993
AI Operations Management - Containerized 24.4
1.4.2.4.104. opsb_exch_top_destination_1d
Description Collects metric information about Top Destination (Daily)
Source dataset opsb_exch_top_destination_1h
Data Aggregation
Column Name Size Description
Type Type
domain_name string 255 lastval Domain name of the incoming mails source
exch_srv_name string 255 lastval Name of the incoming mails source Exchange Server
ad_site_name string 255 lastval Name of the AD Site of which the Exchange Server is member of
is_source_internal string 255 lastval Identifies if the source is internal to the organization
total_bytes_sent_avg_count double 48 average The Average total bytes sent by the source
total_bytes_sent_min_count double 48 min The Minimum total bytes sent by the source
total_bytes_sent_max_count double 48 max The Maximum total bytes sent by the source
recvd_msg_avg_count integer 24 average The Average number of messages received by the source
recvd_msg_min_count integer 24 min The Minimum number of messages received by the source
recvd_msg_max_count integer 24 max The Maximum number of messages received by the source
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 994
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 995
AI Operations Management - Containerized 24.4
1.4.2.4.105. opsb_exch_top_destination_1h
Description Collects metric information about Top Destination (Hourly)
Source dataset opsb_exch_top_destination
Data Aggregation
Column Name Size Description
Type Type
domain_name string 255 lastval Domain name of the incoming mails source
exch_srv_name string 255 lastval Name of the incoming mails source Exchange Server
ad_site_name string 255 lastval Name of the AD Site of which the Exchange Server is member of
is_source_internal string 255 lastval Identifies if the source is internal to the organization
total_bytes_sent_avg_count double 48 average The Average total bytes sent by the source
total_bytes_sent_min_count double 48 min The Minimum total bytes sent by the source
total_bytes_sent_max_count double 48 max The Maximum total bytes sent by the source
recvd_msg_avg_count integer 24 average The Average number of messages received by the source
recvd_msg_min_count integer 24 min The Minimum number of messages received by the source
recvd_msg_max_count integer 24 max The Maximum number of messages received by the source
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 996
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 997
AI Operations Management - Containerized 24.4
1.4.2.4.106. opsb_exch_top_recipient_details
Description Collects details about top recipients
Key columns exchange_server_fqdn, recipient_email_address, timestamp_utc_s, node_fqdn
ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Recipient Exchange Server is a member
DAG_NAME recipient_dag_srv_name string 255 Name of the DAG of which the Recipient Exchange Server is a member
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 998
AI Operations Management - Containerized 24.4
1.4.2.4.107. opsb_exch_top_recipient_details_1d
Description Collects details about top recipients (Daily)
Source dataset opsb_exch_top_recipient_details_1h
Data Aggregation
Column Name Size Description
Type Type
ad_site_name string 255 lastval Name of the AD Site of which the Recipient Exchange Server is a member
total_bytes_send_avg_count double 24 average The Average total bytes send by the recipient
total_bytes_send_min_count double 24 min The Minimum total bytes send by the recipient
total_bytes_send_max_count double 24 max The Maximum total bytes send by the recipient
recvd_msg_avg_count integer 24 average The Average number of messages received by the recipient
recvd_msg_min_count integer 24 min The Minimum number of messages received by the recipient
recvd_msg_max_count integer 24 max The Maximum number of messages received by the recipient
recipient_dag_srv_name string 255 lastval Name of the DAG of which the Recipient Exchange Server is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 999
AI Operations Management - Containerized 24.4
1.4.2.4.108. opsb_exch_top_recipient_details_1h
Description Collects details about top recipients (Hourly)
Source dataset opsb_exch_top_recipient_details
Data Aggregation
Column Name Size Description
Type Type
ad_site_name string 255 lastval Name of the AD Site of which the Recipient Exchange Server is a member
total_bytes_send_avg_count double 24 average The Average total bytes send by the recipient
total_bytes_send_min_count double 24 min The Minimum total bytes send by the recipient
total_bytes_send_max_count double 24 max The Maximum total bytes send by the recipient
recvd_msg_avg_count integer 24 average The Average number of messages received by the recipient
recvd_msg_min_count integer 24 min The Minimum number of messages received by the recipient
recvd_msg_max_count integer 24 max The Maximum number of messages received by the recipient
recipient_dag_srv_name string 255 lastval Name of the DAG of which the Recipient Exchange Server is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1000
AI Operations Management - Containerized 24.4
1.4.2.4.109. opsb_exch_top_sender
Description Collects details about email top sender
Key columns exchange_server_fqdn, sender_email_address, timestamp_utc_s, node_fqdn
ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Sender Exchange Server is a member
DAG_NAME sender_dag_srv_name string 255 Name of the DAG of which the Sender Exchange Server is a member
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1001
AI Operations Management - Containerized 24.4
1.4.2.4.110. opsb_exch_top_sender_1d
Description Collects details about email top sender (Daily)
Source dataset opsb_exch_top_sender_1h
Data Aggregation
Column Name Size Description
Type Type
ad_site_name string 255 lastval Name of the AD Site of which the Sender Exchange Server is a member
total_bytes_send_avg_count double 24 average The Average total bytes sent by the sender
total_bytes_send_min_count double 24 min The Minimum total bytes sent by the sender
total_bytes_send_max_count double 24 max The Maximum total bytes sent by the sender
msg_avg_count integer 24 average The Average number of messages sent by the sender
msg_min_count integer 24 min The Minimum number of messages sent by the sender
msg_max_count integer 24 max The Maximum number of messages sent by the sender
sender_dag_srv_name string 255 lastval Name of the DAG of which the Sender Exchange Server is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1002
AI Operations Management - Containerized 24.4
1.4.2.4.111. opsb_exch_top_sender_1h
Description Collects details about email top sender (Hourly)
Source dataset opsb_exch_top_sender
Data Aggregation
Column Name Size Description
Type Type
ad_site_name string 255 lastval Name of the AD Site of which the Sender Exchange Server is a member
total_bytes_send_avg_count double 24 average The Average total bytes sent by the sender
total_bytes_send_min_count double 24 min The Minimum total bytes sent by the sender
total_bytes_send_max_count double 24 max The Maximum total bytes sent by the sender
msg_avg_count integer 24 average The Average number of messages sent by the sender
msg_min_count integer 24 min The Minimum number of messages sent by the sender
msg_max_count integer 24 max The Maximum number of messages sent by the sender
sender_dag_srv_name string 255 lastval Name of the DAG of which the Sender Exchange Server is a member
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1003
AI Operations Management - Containerized 24.4
1.4.2.4.112. opsb_exch_top_source
Description Collects metric information about email top source
Key columns exchange_server_fqdn, email_source_key, timestamp_utc_s, node_fqdn
DOMAIN_NAME domain_name string 255 Domain name of the source of the incoming mails
ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Exchange Server is a member
IS_INTERNAL is_source_internal string 255 Identifies if the source is internal to the organization
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1004
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1005
AI Operations Management - Containerized 24.4
1.4.2.4.113. opsb_exch_top_source_1d
Description Collects metric information about email top source (Daily)
Source dataset opsb_exch_top_source_1h
Data Aggregation
Column Name Size Description
Type Type
domain_name string 255 lastval Domain name of the source of the incoming mails
ad_site_name string 255 lastval Name of the AD Site of which the Exchange Server is a member
is_source_internal string 255 lastval Identifies if the source is internal to the organization
total_bytes_send_avg_count double 24 average The Average total bytes sent by the source
total_bytes_send_min_count double 24 min The Minimum total bytes sent by the source
total_bytes_send_max_count double 24 max The Maximum total bytes sent by the source
recvd_msg_avg_count integer 24 average The Average number of messages received by the source
recvd_msg_min_count integer 24 min The Minimum number of messages received by the source
recvd_msg_max_count integer 24 max The Maximum number of messages received by the source
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1006
AI Operations Management - Containerized 24.4
1.4.2.4.114. opsb_exch_top_source_1h
Description Collects metric information about email top source (Hourly)
Source dataset opsb_exch_top_source
Data Aggregation
Column Name Size Description
Type Type
domain_name string 255 lastval Domain name of the source of the incoming mails
ad_site_name string 255 lastval Name of the AD Site of which the Exchange Server is a member
is_source_internal string 255 lastval Identifies if the source is internal to the organization
total_bytes_send_avg_count double 24 average The Average total bytes sent by the source
total_bytes_send_min_count double 24 min The Minimum total bytes sent by the source
total_bytes_send_max_count double 24 max The Maximum total bytes sent by the source
recvd_msg_avg_count integer 24 average The Average number of messages received by the source
recvd_msg_min_count integer 24 min The Minimum number of messages received by the source
recvd_msg_max_count integer 24 max The Maximum number of messages received by the source
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1007
AI Operations Management - Containerized 24.4
1.4.2.4.115. opsb_exch_transport_queue_info
Description Collects transport Queue details
Key columns exchange_server_fqdn, que_identity, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1008
AI Operations Management - Containerized 24.4
1.4.2.4.116. opsb_exch_transport_queue_info_1d
Description Collects transport Queue details (Daily)
Source dataset opsb_exch_transport_queue_info_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1009
AI Operations Management - Containerized 24.4
1.4.2.4.117. opsb_exch_transport_queue_info_1h
Description Collects transport Queue details (Hourly)
Source dataset opsb_exch_transport_queue_info
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1010
AI Operations Management - Containerized 24.4
1.4.2.4.118. opsb_exch_transport_queue_perf
Description Collects performance counters for Exchange Transport Queue
Key columns exchange_server_fqdn, transport_que_instance_name, timestamp_utc_s, node_fqdn
LARG_IDQ_LENGTH internal_largest_delivery_que_items_count integer 24 The number of internal items in the largest delivery queue
LARG_XDQ_LENGTH external_largest_delivery_que_items_count integer 24 The number of external items in the largest delivery queue
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1011
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1012
AI Operations Management - Containerized 24.4
1.4.2.4.119. opsb_exch_transport_queue_perf_1d
Description Collects performance counters for Exchange Transport Queue (Daily)
Source dataset opsb_exch_transport_queue_perf_1h
Data Aggregation
Column Name Size Description
Type Type
active_mailbox_que_length_avg_count integer 24 average The Average length of the Active Mailbox Delivery Queue
active_mailbox_que_length_min_count integer 24 min The Minimum length of the Active Mailbox Delivery Queue
active_mailbox_que_length_max_count integer 24 max The Maximum length of the Active Mailbox Delivery Queue
active_non_smtp_que_length_avg_count integer 24 average The Average length of the Active Non-Smtp Delivery Queue
active_non_smtp_que_length_min_count integer 24 min The Minimum length of the Active Non-Smtp Delivery Queue
active_non_smtp_que_length_max_count integer 24 max The Maximum length of the Active Non-Smtp Delivery Queue
retry_mailbox_que_length_avg_count integer 24 average The Average length of the Retry Mailbox Delivery Queue
retry_mailbox_que_length_min_count integer 24 min The Minimum length of the Retry Mailbox Delivery Queue
retry_mailbox_que_length_max_count integer 24 max The Maximum length of the Retry Mailbox Delivery Queue
retry_non_smtp_que_length_avg_count integer 24 average The Average length of the Retry Non-Smtp Delivery Queue
retry_non_smtp_que_length_min_count integer 24 min The Minimum length of the Retry Non-Smtp Delivery Queue
retry_non_smtp_que_length_max_count integer 24 max The Maximum length of the Retry Non-Smtp Delivery Queue
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1013
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The number of external items set for "retry" in the remote delivery
retry_external_delivery_que_items_count integer 24 lastval
queues
The Average number of external items set for "retry" in the remote
retry_external_delivery_que_items_avg_count integer 24 average
delivery queues
retry_internal_delivery_que_items_count integer 24 lastval The number of internal items in retry in the remote delivery queues
internal_largest_delivery_que_items_count integer 24 lastval The number of internal items in the largest delivery queue
internal_largest_delivery_que_items_avg_count integer 24 average The Average number of internal items in the largest delivery queue
external_largest_delivery_que_items_count integer 24 lastval The number of external items in the largest delivery queue
agg_shadow_que_items_avg_count integer 24 average The Average current count of messages in all shadow queues
agg_shadow_que_items_min_count integer 24 min The Minimum current count of messages in all shadow queues
agg_shadow_que_items_max_count integer 24 max The Maximum current count of messages in all shadow queues
internal_agg_delivery_que_items_count integer 24 lastval The number of internal items queued for delivery in all queues
external_agg_delivery_que_items_count integer 24 lastval The number of external items queued for delivery in all queues
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1014
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If
collection_policy_name string 255 lastval
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
node_short_name string 255 lastval
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
This field holds the tenant id to which the row in dataset belongs
tenant_id_id string 255 to. Needed to apply row level access policies to control access to
data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1015
AI Operations Management - Containerized 24.4
1.4.2.4.120. opsb_exch_transport_queue_perf_1h
Description Collects performance counters for Exchange Transport Queue (Hourly)
Source dataset opsb_exch_transport_queue_perf
Data Aggregation
Column Name Size Description
Type Type
active_mailbox_que_length_avg_count integer 24 average The Average length of the Active Mailbox Delivery Queue
active_mailbox_que_length_min_count integer 24 min The Minimum length of the Active Mailbox Delivery Queue
active_mailbox_que_length_max_count integer 24 max The Maximum length of the Active Mailbox Delivery Queue
active_non_smtp_que_length_avg_count integer 24 average The Average length of the Active Non-Smtp Delivery Queue
active_non_smtp_que_length_min_count integer 24 min The Minimum length of the Active Non-Smtp Delivery Queue
active_non_smtp_que_length_max_count integer 24 max The Maximum length of the Active Non-Smtp Delivery Queue
retry_mailbox_que_length_avg_count integer 24 average The Average length of the Retry Mailbox Delivery Queue
retry_mailbox_que_length_min_count integer 24 min The Minimum length of the Retry Mailbox Delivery Queue
retry_mailbox_que_length_max_count integer 24 max The Maximum length of the Retry Mailbox Delivery Queue
retry_non_smtp_que_length_avg_count integer 24 average The Average length of the Retry Non-Smtp Delivery Queue
retry_non_smtp_que_length_min_count integer 24 min The Minimum length of the Retry Non-Smtp Delivery Queue
retry_non_smtp_que_length_max_count integer 24 max The Maximum length of the Retry Non-Smtp Delivery Queue
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1016
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
The number of external items set for "retry" in the remote delivery
retry_external_delivery_que_items_count integer 24 lastval
queues
The Average number of external items set for "retry" in the remote
retry_external_delivery_que_items_avg_count integer 24 average
delivery queues
retry_internal_delivery_que_items_count integer 24 lastval The number of internal items in retry in the remote delivery queues
internal_largest_delivery_que_items_count integer 24 lastval The number of internal items in the largest delivery queue
internal_largest_delivery_que_items_avg_count integer 24 average The Average number of internal items in the largest delivery queue
external_largest_delivery_que_items_count integer 24 lastval The number of external items in the largest delivery queue
agg_shadow_que_items_avg_count integer 24 average The Average current count of messages in all shadow queues
agg_shadow_que_items_min_count integer 24 min The Minimum current count of messages in all shadow queues
agg_shadow_que_items_max_count integer 24 max The Maximum current count of messages in all shadow queues
internal_agg_delivery_que_items_count integer 24 lastval The number of internal items queued for delivery in all queues
external_agg_delivery_que_items_count integer 24 lastval The number of external items queued for delivery in all queues
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1017
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If
collection_policy_name string 255 lastval
policies do have versions, the corresponding version number shall
be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
node_short_name string 255 lastval
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
This field holds the tenant id to which the row in dataset belongs
tenant_id_id string 255 to. Needed to apply row level access policies to control access to
data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1018
AI Operations Management - Containerized 24.4
1.4.2.4.121. opsb_exch_webserver_connection
Description Collects Performance counters for Exchange Web Server Connection
Key columns exchange_server_fqdn, webserver_instance_name, timestamp_utc_s, node_fqdn
CURRENTCONNECTIONS webserver_curr_conn_count integer 24 Number of connections established with the web service.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1019
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1020
AI Operations Management - Containerized 24.4
1.4.2.4.122. opsb_exch_webserver_connection_1d
Description Collects Performance counters for Exchange Web Server Connection (Daily)
Source dataset opsb_exch_webserver_connection_1h
Data Aggregation
Column Name Size Description
Type Type
webserver_curr_conn_avg_count integer 24 average The Average number of connections established with the web service.
webserver_curr_conn_min_count integer 24 min The Minimum number of connections established with the web service.
webserver_curr_conn_max_count integer 24 max The Maximum number of connections established with the web service.
webserver_curr_conn_count integer 24 lastval Number of connections established with the web service.
The Average rate of internet server API extension requests which are
internet_srv_api_extn_req_avg_count_per_s integer 24 average
received by the web service.
The Minimum rate of internet server API extension requests which are
internet_srv_api_extn_req_min_count_per_s integer 24 min
received by the web service.
The Maximum rate of internet server API extension requests which are
internet_srv_api_extn_req_max_count_per_s integer 24 max
received by the web service.
The Average HTTP requests that do not use the enlisted methods:
other_req_methods_avg_count_per_s integer 24 average OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.
The Minimum HTTP requests that do not use the enlisted methods:
other_req_methods_min_count_per_s integer 24 min OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.
The Maximum HTTP requests that do not use the enlisted methods:
other_req_methods_max_count_per_s integer 24 max OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1021
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1022
AI Operations Management - Containerized 24.4
1.4.2.4.123. opsb_exch_webserver_connection_1h
Description Collects Performance counters for Exchange Web Server Connection (Hourly)
Source dataset opsb_exch_webserver_connection
Data Aggregation
Column Name Size Description
Type Type
webserver_curr_conn_avg_count integer 24 average The Average number of connections established with the web service.
webserver_curr_conn_min_count integer 24 min The Minimum number of connections established with the web service.
webserver_curr_conn_max_count integer 24 max The Maximum number of connections established with the web service.
webserver_curr_conn_count integer 24 lastval Number of connections established with the web service.
The Average rate of internet server API extension requests which are
internet_srv_api_extn_req_avg_count_per_s integer 24 average
received by the web service.
The Minimum rate of internet server API extension requests which are
internet_srv_api_extn_req_min_count_per_s integer 24 min
received by the web service.
The Maximum rate of internet server API extension requests which are
internet_srv_api_extn_req_max_count_per_s integer 24 max
received by the web service.
The Average HTTP requests that do not use the enlisted methods:
other_req_methods_avg_count_per_s integer 24 average OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.
The Minimum HTTP requests that do not use the enlisted methods:
other_req_methods_min_count_per_s integer 24 min OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.
The Maximum HTTP requests that do not use the enlisted methods:
other_req_methods_max_count_per_s integer 24 max OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id uuid lastval in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1023
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1024
AI Operations Management - Containerized 24.4
1.4.2.4.124. opsb_exch_webserver_url_monitor
Description Collects Performance counters for Exchange Web Server URL
Key columns exchange_server_fqdn, exchange_webserver_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1025
AI Operations Management - Containerized 24.4
1.4.2.4.125. opsb_exch_workload_management
Description Collects metrics for Exchange server workload management
Key columns exchange_server_fqdn, workload_instance_name, timestamp_utc_s, node_fqdn
ACTIVETASKS active_tasks_count integer 24 Number of Active Tasks in current Exchange server Workload
COMPLETEDTASKS completed_tasks_count integer 24 Number of Completed Tasks in current Exchange server Workload
QUEUEDTASKS qued_tasks_count integer 24 Number of Queued Tasks in current Exchange server Workload
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1026
AI Operations Management - Containerized 24.4
1.4.2.4.126. opsb_exch_workload_management_1d
Description Collects metrics for Exchange server workload management (Daily)
Source dataset opsb_exch_workload_management_1h
Data Aggregation
Column Name Size Description
Type Type
active_tasks_avg_count integer 24 average The Average number of Active Tasks in current Exchange server Workload
active_tasks_min_count integer 24 min The Minimum number of Active Tasks in current Exchange server Workload
active_tasks_max_count integer 24 max The Maximum number of Active Tasks in current Exchange server Workload
active_tasks_count integer 24 lastval Number of Active Tasks in current Exchange server Workload
completed_tasks_avg_count integer 24 average The Average number of Completed Tasks in current Exchange server Workload
completed_tasks_min_count integer 24 min The Minimum number of Completed Tasks in current Exchange server Workload
completed_tasks_max_count integer 24 max The Maximum number of Completed Tasks in current Exchange server Workload
completed_tasks_count integer 24 lastval Number of Completed Tasks in current Exchange server Workload
qued_tasks_avg_count integer 24 average The Average number of Queued Tasks in current Exchange server Workload
qued_tasks_min_count integer 24 min The Minimum number of Queued Tasks in current Exchange server Workload
qued_tasks_max_count integer 24 max The Maximum number of Queued Tasks in current Exchange server Workload
qued_tasks_count integer 24 lastval Number of Queued Tasks in current Exchange server Workload
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1027
AI Operations Management - Containerized 24.4
1.4.2.4.127. opsb_exch_workload_management_1h
Description Collects metrics for Exchange server workload management (Hourly)
Source dataset opsb_exch_workload_management
Data Aggregation
Column Name Size Description
Type Type
active_tasks_avg_count integer 24 average The Average number of Active Tasks in current Exchange server Workload
active_tasks_min_count integer 24 min The Minimum number of Active Tasks in current Exchange server Workload
active_tasks_max_count integer 24 max The Maximum number of Active Tasks in current Exchange server Workload
active_tasks_count integer 24 lastval Number of Active Tasks in current Exchange server Workload
completed_tasks_avg_count integer 24 average The Average number of Completed Tasks in current Exchange server Workload
completed_tasks_min_count integer 24 min The Minimum number of Completed Tasks in current Exchange server Workload
completed_tasks_max_count integer 24 max The Maximum number of Completed Tasks in current Exchange server Workload
completed_tasks_count integer 24 lastval Number of Completed Tasks in current Exchange server Workload
qued_tasks_avg_count integer 24 average The Average number of Queued Tasks in current Exchange server Workload
qued_tasks_min_count integer 24 min The Minimum number of Queued Tasks in current Exchange server Workload
qued_tasks_max_count integer 24 max The Maximum number of Queued Tasks in current Exchange server Workload
qued_tasks_count integer 24 lastval Number of Queued Tasks in current Exchange server Workload
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
collection_data_flow string 80 lastval data directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1028
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1029
AI Operations Management - Containerized 24.4
1.4.2.5.1. opsb_mssql_virtual_device_size
Description MsSql Virtual Device Size Monitoring Data
Key columns mssql_instance_name, mssql_virtual_device_name, timestamp_utc_s, node_fqdn
null virtual_device_total_size_mb double 24 MSSQL Server total virtual device size (in MB)
null virtual_device_free_space_mb double 24 MSSQL Server free virtual device size (in MB)
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1030
AI Operations Management - Containerized 24.4
1.4.2.5.2. opsb_mssql_virtual_device_size_1h
Description MSSQL Virtual Device Size Monitoring Data(Hourly)
Source dataset opsb_mssql_virtual_device_size
Data Aggregation
Column Name Size Description
Type Type
virtual_device_total_size_avg_mb double 24 average The Average MSSQL Server total virtual device size (in MB)
virtual_device_total_size_min_mb double 24 min The Minimum MSSQL Server total virtual device size (in MB)
virtual_device_total_size_max_mb double 24 max The Maximum MSSQL Server total virtual device size (in MB)
virtual_device_free_space_avg_mb double 24 average The Average MSSQL Server free virtual device size (in MB)
virtual_device_free_space_min_mb double 24 min The Minimum MSSQL Server free virtual device size (in MB)
virtual_device_free_space_max_mb double 24 max The Maximum MSSQL Server free virtual device size (in MB)
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1031
AI Operations Management - Containerized 24.4
1.4.2.5.3. opsb_mssql_virtual_device_size_1d
Description MSSQL Virtual Device Size Monitoring Data(Daily)
Source dataset opsb_mssql_virtual_device_size_1h
Data Aggregation
Column Name Size Description
Type Type
virtual_device_total_size_avg_mb double 24 average The Average MSSQL Server total virtual device size (in MB)
virtual_device_total_size_min_mb double 24 min The Minimum MSSQL Server total virtual device size (in MB)
virtual_device_total_size_max_mb double 24 max The Maximum MSSQL Server total virtual device size (in MB)
virtual_device_free_space_avg_mb double 24 average The Average MSSQL Server free virtual device size (in MB)
virtual_device_free_space_min_mb double 24 min The Minimum MSSQL Server free virtual device size (in MB)
virtual_device_free_space_max_mb double 24 max The Maximum MSSQL Server free virtual device size (in MB)
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1032
AI Operations Management - Containerized 24.4
1.4.2.5.4. opsb_mssql_table_size
Description MSSQL Table Size Monitoring Data
Key columns mssql_instance_name, mssql_table_name, timestamp_utc_s, node_fqdn
null table_total_size_mb double 24 MSSQL Server total table size (in MB)
null table_free_space_mb double 24 MSSQL Server free table space (in MB)
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1033
AI Operations Management - Containerized 24.4
1.4.2.5.5. opsb_mssql_table_size_1h
Description MSSQL Table Size Monitoring Data (Hourly)
Source dataset opsb_mssql_table_size
Data Aggregation
Column Name Size Description
Type Type
table_total_size_avg_mb double 24 average The Average MSSQL Server total table size (in MB)
table_total_size_min_mb double 24 min The Minimum MSSQL Server total table size (in MB)
table_total_size_max_mb double 24 max The Maximum MSSQL Server total table size (in MB)
table_free_space_avg_mb double 24 average The Average MSSQL Server free table space (in MB)
table_free_space_min_mb double 24 min The Minimum MSSQL Server free table space (in MB)
table_free_space_max_mb double 24 max The Maximum MSSQL Server free table space (in MB)
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through this
API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -
node_timezone_offset_h string 80 lastval
8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1034
AI Operations Management - Containerized 24.4
1.4.2.5.6. opsb_mssql_table_size_1d
Description MsSql Table Size Monitoring Data (Daily)
Source dataset opsb_mssql_table_size_1h
Data Aggregation
Column Name Size Description
Type Type
table_total_size_avg_mb double 24 average The Average MSSQL Server total table size (in MB)
table_total_size_min_mb double 24 min The Minimum MSSQL Server total table size (in MB)
table_total_size_max_mb double 24 max The Maximum MSSQL Server total table size (in MB)
table_free_space_avg_mb double 24 average The Average MSSQL Server free table space (in MB)
table_free_space_min_mb double 24 min The Minimum MSSQL Server free table space (in MB)
table_free_space_max_mb double 24 max The Maximum MSSQL Server free table space (in MB)
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through this
API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -
node_timezone_offset_h string 80 lastval
8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1035
AI Operations Management - Containerized 24.4
1.4.2.5.7. opsb_mssql_server_workload
Description MSSQL Server Workload Monitoring Data
Key columns mssql_instance_name, mssql_srv_name, timestamp_utc_s, node_fqdn
Number of physical reads and writes to the disk since the last collection for
null physical_read_write_count double 24
each tablespace.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1036
AI Operations Management - Containerized 24.4
1.4.2.5.8. opsb_mssql_server_workload_1h
Description MSSQL Server Workload Monitoring Data(Hourly)
Source dataset opsb_mssql_server_workload
Data Aggregation
Column Name Size Description
Type Type
The Average number of physical reads and writes to the disk since the last
physical_read_write_avg_count double 24 average
collection for each tablespace.
The Minimum number of physical reads and writes to the disk since the last
physical_read_write_min_count double 24 min
collection for each tablespace.
The Maximum number of physical reads and writes to the disk since the last
physical_read_write_max_count double 24 max
collection for each tablespace.
Number of physical reads and writes to the disk since the last collection for each
physical_read_write_count double 24 lastval
tablespace.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1037
AI Operations Management - Containerized 24.4
1.4.2.5.9. opsb_mssql_server_workload_1d
Description MSSQL Server Workload Monitoring Data (Daily)
Source dataset opsb_mssql_server_workload_1h
Data Aggregation
Column Name Size Description
Type Type
The Average number of physical reads and writes to the disk since the last
physical_read_write_avg_count double 24 average
collection for each tablespace.
The Minimum number of physical reads and writes to the disk since the last
physical_read_write_min_count double 24 min
collection for each tablespace.
The Maximum number of physical reads and writes to the disk since the last
physical_read_write_max_count double 24 max
collection for each tablespace.
Number of physical reads and writes to the disk since the last collection for each
physical_read_write_count double 24 lastval
tablespace.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection Service
collection_type string 255 lastval
- Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP",
etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1038
AI Operations Management - Containerized 24.4
1.4.2.5.10. opsb_mssql_server_status
Description MSSQL Server Status Monitoring Data
Key columns mssql_instance_name, timestamp_utc_s, node_fqdn
This metric monitors the ability to connect to a server, the possible values
M097_SERVERCONNECT connection_status integer 24
are 0(Running), 1(Stopped)
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1039
AI Operations Management - Containerized 24.4
1.4.2.5.11. opsb_mssql_server_status_1h
Description MSSQL Server Status Monitoring Data (Hourly)
Key columns mssql_instance_name, timestamp_utc_s, node_fqdn
The time duration (in minutes) in an hour when the MSSQL server is in
null uptime_min double
running state.
The time duration (in minutes) in an hour when the MSSQL server is not in
null downtime_min double
running state.
The percentage of time in an hour when the MSSQL server is not in running
null downtime_pct double
state.
The time duration (in minutes) in an hour when the MSSQL server is not
null planned_downtime_min double
running due to planned outage.
The percentage of time in an hour when the MSSQL server is not running
null planned_downtime_pct double
due to planned outage.
The time duration (in minutes) in an hour when the MSSQL server is not
null unknown_time_min double
running due to unknown outage.
The percentage of time in an hour when the MSSQL server is not running
null unknown_time_pct double
due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1040
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1041
AI Operations Management - Containerized 24.4
1.4.2.5.12. opsb_mssql_server_status_1d
Description MSSQL server Status Monitoring data (Daily)
Source dataset opsb_mssql_server_status_1h
Data Aggregation
Column Name Size Description
Type Type
uptime_min double sum The time duration (in minutes) in an hour when the MSSQL server is in running state.
uptime_avg_pct double avg The Average percentage of time in an hour when the MSSQL server is in running state.
The time duration (in minutes) in an hour when the MSSQL server is not in running
downtime_min double sum
state.
The Average percentage of time in an hour when the MSSQL server is not in running
downtime_avg_pct double avg
state.
The time duration (in minutes) in an hour when MSSQL server is not in running state due
unknown_time_min double sum
to unknown outage.
The Average percentage of time in an hour when the MSSQL server is not in running
unknown_time_avg_pct double avg
state due to unknown outage.
The time duration (in minutes) in an hour when the MSSQL server is not in running state
planned_downtime_min double sum
due to planned outage.
The Average percentage of time in an hour when the MSSQL server is not in running
planned_downtime_avg_pct double avg
state due to planned outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1042
AI Operations Management - Containerized 24.4
1.4.2.5.13. opsb_mssql_server_perf
Description MSSQL Server Performance Monitoring Data
Key columns mssql_instance_name, timestamp_utc_s, node_fqdn
M025_CPUUSEDPCT cpu_used_pct integer 24 The percentage of CPU time used by SQL Server
M032_RUNABLECONTNPCT runnable_connection_pct integer 24 The percentage of total connections that are runnable
M056_TBLLCKESCALRATE table_lock_escalation_count_per_s integer 24 The table lock escalation count per second
M072_LOCKSWAITRATE lock_wait_count_per_s integer 24 The locks wait rate per object type
M094_MEMRYCNSMPTN memory_used_mb integer 24 The amount of memory used by the resource pool
M096_FTHREADCNT free_threads_count integer 24 The number of free threads for DB Engine process
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1043
AI Operations Management - Containerized 24.4
BFRMGR_PGRDP_SEC page_read_count_per_s double 24 The number of physical database page reads issued
BFRMGR_PGWRTP_SEC page_write_count_per_s double 24 The number of physical database page writes issued
AVLBREP_RCVREP_SEC available_replica_msg_receive_per_s double 24 Total number of messages received from the replica
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1044
AI Operations Management - Containerized 24.4
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1045
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1046
AI Operations Management - Containerized 24.4
1.4.2.5.14. opsb_mssql_server_perf_1h
Description MSSQL server Performance Monitoring Data (Hourly)
Source dataset opsb_mssql_server_perf
Data Aggregation
Column Name Size Description
Type Type
txn_avg_count_per_s integer 24 average The Average server transaction count per second
txn_min_count_per_s integer 24 min The Minimum of server transaction count per second
txn_max_count_per_s integer 24 max The Maximum of server transaction count per second
cmd_queue_length_avg_pct integer 24 average The Average percentage of command queue length used
cmd_queue_length_min_pct integer 24 min The Minimum of percentage of command queue length used
cmd_queue_length_max_pct integer 24 max The Maximum of percentage of command queue length used
cpu_used_avg_pct integer 24 average The Average percentage of CPU time used by SQL Server
cpu_used_min_pct integer 24 min The Minimum of percentage of CPU time used by SQL Server
cpu_used_max_pct integer 24 max The Maximum of percentage of CPU time used by SQL Server
cpu_used_pctl_pct integer 24 90 percentile The Percentile of CPU time used by SQL Server
active_connection_pctl_pct integer 24 90 percentile The Percentile of total connections that are active vs sleeping
runnable_connection_avg_pct integer 24 average The Average percentage of total connections that are runnable
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1047
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
runnable_connection_pctl_pct integer 24 90 percentile The Percentile of total connections that are runnable
full_scan_avg_count_per_s integer 24 average The Average of full scans count per second
full_scan_min_count_per_s integer 24 min The Minimum of full scans count per second
full_scan_max_count_per_s integer 24 max The Maximum of full scans count per second
index_search_avg_count_per_s integer 24 average The Average of index searches count per second
index_search_min_count_per_s integer 24 min The Minimum of index searches count per second
index_search_max_count_per_s integer 24 max The Maximum of index searches count per second
pages_allocated_avg_count_per_s integer 24 average The Average count of pages allocated per second
pages_allocated_min_count_per_s integer 24 min The Minimum count of pages allocated per second
pages_allocated_max_count_per_s integer 24 max The Maximum count of pages allocated per second
extents_allocated_avg_count_per_s integer 24 average The Average of Extents allocated Count per second
extents_allocated_min_count_per_s integer 24 min The Minimum Extents allocated Count per second
extents_allocated_max_count_per_s integer 24 max The Maximum Extents allocated Count per second
page_split_avg_count_per_s integer 24 average The Average page splits count per second
page_split_min_count_per_s integer 24 min The Minimum of page splits count per second
page_split_max_count_per_s integer 24 max The Maximum of page splits count per second
table_lock_escalation_avg_count_per_s integer 24 average The Average table lock escalation count per second
table_lock_escalation_min_count_per_s integer 24 min The Minimum of table lock escalation count per second
table_lock_escalation_max_count_per_s integer 24 max The Maximum of table lock escalation count per second
active_txn_avg_count integer 24 average The Average number of active transactions for the entire server
latch_wait_avg_count_per_s integer 24 average The Average Latch waits count per second
latch_wait_max_count_per_s integer 24 max The Maximum of Latch waits count per second
lock_timeout_avg_count_per_s integer 24 average The Average lock timeout count per second
lock_timeout_min_count_per_s integer 24 min The Minimum of lock timeout count per second
lock_timeout_max_count_per_s integer 24 max The Maximum of lock timeout count per second
lock_wait_avg_count_per_s integer 24 average The Average locks wait rate per object type
lock_wait_min_count_per_s integer 24 min The Minimum of locks wait rate per object type
lock_wait_max_count_per_s integer 24 max The Maximum of locks wait rate per object type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1048
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
batch_request_avg_count_per_s integer 24 average The Average of Batch requests count per second
batch_request_min_count_per_s integer 24 min The Minimum of Batch requests count per second
batch_request_max_count_per_s integer 24 max The Maximum of Batch requests count per second
current_latch_time_avg_min_ms integer 24 min The Minimum of current average latch wait time
current_latch_time_avg_max_ms integer 24 max The Maximum of current average latch wait time
memory_used_avg_mb integer 24 average The Average amount of memory used by the resource pool
memory_used_min_mb integer 24 min The Minimum of amount of memory used by the resource pool
memory_used_max_mb integer 24 max The Maximum of amount of memory used by the resource pool
free_threads_avg_count integer 24 average The Average number of free threads for DB Engine process
free_threads_min_count integer 24 min The Minimum of number of free threads for DB Engine process
free_threads_max_count integer 24 max The maximum of number of free threads for DB Engine process
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1049
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
page_read_avg_count_per_s double 24 average The Average number of physical database page reads issued
page_read_min_count_per_s double 24 min The Minimum of number of physical database page reads issued
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1050
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
page_read_max_count_per_s double 24 max The Maximum of number of physical database page reads issued
page_write_avg_count_per_s double 24 average The Average number of physical database page writes issued
page_write_min_count_per_s double 24 min The Minimum of number of physical database page writes issued
The Average total memory the server has committed to the SQL
buffer_manager_db_pages_avg_b double 24 average
objects
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1051
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1052
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1053
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
db_replica_syncstate_avg_count integer 24 average The Average number of database replica(s) not synchronized
db_replica_syncstate_min_count integer 24 min The Minimum of number of database replica(s) not synchronized
db_replica_syncstate_max_count integer 24 max The Maximum of number of database replica(s) not synchronized
db_replica_join_state_avg_count integer 24 average The Average number of database replica(s) not joined
db_replica_join_state_min_count integer 24 min The Minimum of number of database replica(s) not joined
db_replica_join_state_max_count integer 24 max The Maximum of number of database replica(s) not joined
Indicates the type of the data producer that ingested the data.
producer_instance_type string 50 lastval
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
collection_policy_name string 255 lastval
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1054
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This field holds the tenant id to which the row in dataset belongs
tenant_id_id string 255 to. Needed to apply row level access policies to control access to
data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1055
AI Operations Management - Containerized 24.4
1.4.2.5.15. opsb_mssql_server_perf_1d
Description MSSQL server Performance Monitoring Data (Daily)
Source dataset opsb_mssql_server_perf
Data Aggregation
Column Name Size Description
Type Type
txn_avg_count_per_s integer 24 average The Average server transaction count per second
txn_min_count_per_s integer 24 min The Minimum of server transaction count per second
txn_max_count_per_s integer 24 max The Maximum of server transaction count per second
cmd_queue_length_avg_pct integer 24 average The Average percentage of command queue length used
cmd_queue_length_min_pct integer 24 min The Minimum of percentage of command queue length used
cmd_queue_length_max_pct integer 24 max The Maximum of percentage of command queue length used
cpu_used_avg_pct integer 24 average The Average percentage of CPU time used by SQL Server
cpu_used_min_pct integer 24 min The Minimum of percentage of CPU time used by SQL Server
cpu_used_max_pct integer 24 max The Maximum of percentage of CPU time used by SQL Server
cpu_used_pctl_pct integer 24 90 percentile The Percentile of CPU time used by SQL Server
active_connection_pctl_pct integer 24 90 percentile The Percentile of total connections that are active vs sleeping
runnable_connection_avg_pct integer 24 average The Average percentage of total connections that are runnable
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1056
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
runnable_connection_pctl_pct integer 24 90 percentile The Percentile of total connections that are runnable
full_scan_avg_count_per_s integer 24 average The Average of full scans count per second
full_scan_min_count_per_s integer 24 min The Minimum of full scans count per second
full_scan_max_count_per_s integer 24 max The Maximum of full scans count per second
index_search_avg_count_per_s integer 24 average The Average of index searches count per second
index_search_min_count_per_s integer 24 min The Minimum of index searches count per second
index_search_max_count_per_s integer 24 max The Maximum of index searches count per second
pages_allocated_avg_count_per_s integer 24 average The Average count of pages allocated per second
pages_allocated_min_count_per_s integer 24 min The Minimum count of pages allocated per second
pages_allocated_max_count_per_s integer 24 max The Maximum count of pages allocated per second
extents_allocated_avg_count_per_s integer 24 average The Average of Extents allocated Count per second
extents_allocated_min_count_per_s integer 24 min The Minimum Extents allocated Count per second
extents_allocated_max_count_per_s integer 24 max The Maximum Extents allocated Count per second
page_split_avg_count_per_s integer 24 average The Average page splits count per second
page_split_min_count_per_s integer 24 min The Minimum of page splits count per second
page_split_max_count_per_s integer 24 max The Maximum of page splits count per second
table_lock_escalation_avg_count_per_s integer 24 average The Average table lock escalation count per second
table_lock_escalation_min_count_per_s integer 24 min The Minimum of table lock escalation count per second
table_lock_escalation_max_count_per_s integer 24 max The Maximum of table lock escalation count per second
active_txn_avg_count integer 24 average The Average number of active transactions for the entire server
latch_wait_avg_count_per_s integer 24 average The Average Latch waits count per second
latch_wait_max_count_per_s integer 24 max The Maximum of Latch waits count per second
lock_timeout_avg_count_per_s integer 24 average The Average lock timeout count per second
lock_timeout_min_count_per_s integer 24 min The Minimum of lock timeout count per second
lock_timeout_max_count_per_s integer 24 max The Maximum of lock timeout count per second
lock_wait_avg_count_per_s integer 24 average The Average locks wait rate per object type
lock_wait_min_count_per_s integer 24 min The Minimum of locks wait rate per object type
lock_wait_max_count_per_s integer 24 max The Maximum of locks wait rate per object type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1057
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
batch_request_avg_count_per_s integer 24 average The Average of Batch requests count per second
batch_request_min_count_per_s integer 24 min The Minimum of Batch requests count per second
batch_request_max_count_per_s integer 24 max The Maximum of Batch requests count per second
current_latch_time_avg_min_ms integer 24 min The Minimum of current average latch wait time
current_latch_time_avg_max_ms integer 24 max The Maximum of current average latch wait time
memory_used_avg_mb integer 24 average The Average amount of memory used by the resource pool
memory_used_min_mb integer 24 min The Minimum of amount of memory used by the resource pool
memory_used_max_mb integer 24 max The Maximum of amount of memory used by the resource pool
free_threads_avg_count integer 24 average The Average number of free threads for DB Engine process
free_threads_min_count integer 24 min The Minimum of number of free threads for DB Engine process
free_threads_max_count integer 24 max The maximum of number of free threads for DB Engine process
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1058
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
page_read_avg_count_per_s double 24 average The Average number of physical database page reads issued
page_read_min_count_per_s double 24 min The Minimum of number of physical database page reads issued
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1059
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
page_read_max_count_per_s double 24 max The Maximum of number of physical database page reads issued
page_write_avg_count_per_s double 24 average The Average number of physical database page writes issued
page_write_min_count_per_s double 24 min The Minimum of number of physical database page writes issued
The Average total memory the server has committed to the SQL
buffer_manager_db_pages_avg_b double 24 average
objects
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1060
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1061
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1062
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
db_replica_syncstate_avg_count integer 24 average The Average number of database replica(s) not synchronized
db_replica_syncstate_min_count integer 24 min The Minimum of number of database replica(s) not synchronized
db_replica_syncstate_max_count integer 24 max The Maximum of number of database replica(s) not synchronized
db_replica_join_state_avg_count integer 24 average The Average number of database replica(s) not joined
db_replica_join_state_min_count integer 24 min The Minimum of number of database replica(s) not joined
db_replica_join_state_max_count integer 24 max The Maximum of number of database replica(s) not joined
Indicates the type of the data producer that ingested the data.
producer_instance_type string 50 lastval
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
collection_policy_name string 255 lastval
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1063
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
This field holds the tenant id to which the row in dataset belongs
tenant_id_id string 255 to. Needed to apply row level access policies to control access to
data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1064
AI Operations Management - Containerized 24.4
1.4.2.5.16. opsb_mssql_server_fault
Description MSSQL Server Fault Monitoring Data
Key columns mssql_instance_name, timestamp_utc_s, node_fqdn
M023_READWRITEERRCNT read_write_error_count integer 24 The number of SQL Server read/write errors since the last probing
M024_PACKERERRORCNT packet_error_count integer 24 The number of packet errors while reading or writing packets
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1065
AI Operations Management - Containerized 24.4
1.4.2.5.17. opsb_mssql_server_fault_1h
Description MSSQL Server Fault Monitoring Data (Hourly)
Source dataset opsb_mssql_server_fault
Data Aggregation
Column Name Size Description
Type Type
read_write_error_count integer 24 lastval The number of SQL Server read/write errors since the last probing
read_write_error_avg_count integer 24 average The Average number of SQL Server read/write errors since the last probing
read_write_error_min_count integer 24 min The Minimum number of SQL Server read/write errors since the last probing
read_write_error_max_count integer 24 max The Maximum number of SQL Server read/write errors since the last probing
packet_error_count integer 24 lastval The number of packet errors while reading or writing packets
packet_error_avg_count integer 24 average The Average number of packet errors while reading or writing packets
packet_error_min_count integer 24 min The Minimum number of packet errors while reading or writing packets
packet_error_max_count integer 24 max The Maximum number of packet errors while reading or writing packets
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1066
AI Operations Management - Containerized 24.4
1.4.2.5.18. opsb_mssql_server_fault_1d
Description MSSQL Server Fault Monitoring Data (Daily)
Source dataset opsb_mssql_server_fault_1h
Data Aggregation
Column Name Size Description
Type Type
read_write_error_count integer 24 lastval The number of SQL Server read/write errors since the last probing
read_write_error_avg_count integer 24 average The Average number of SQL Server read/write errors since the last probing
read_write_error_min_count integer 24 min The Minimum number of SQL Server read/write errors since the last probing
read_write_error_max_count integer 24 max The Maximum number of SQL Server read/write errors since the last probing
packet_error_count integer 24 lastval The number of packet errors while reading or writing packets
packet_error_avg_count integer 24 average The Average number of packet errors while reading or writing packets
packet_error_min_count integer 24 min The Minimum number of packet errors while reading or writing packets
packet_error_max_count integer 24 max The Maximum number of packet errors while reading or writing packets
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1067
AI Operations Management - Containerized 24.4
1.4.2.5.19. opsb_mssql_server_conf
Description MSSQL Server Configuration Monitoring data
Key columns mssql_instance_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1068
AI Operations Management - Containerized 24.4
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1069
AI Operations Management - Containerized 24.4
1.4.2.5.20. opsb_mssql_server_conf_1h
Description MSSQL server Configuration Monitoring data (Hourly)
Source dataset opsb_mssql_server_conf
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1070
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1071
AI Operations Management - Containerized 24.4
1.4.2.5.21. opsb_mssql_server_conf_1d
Description MSSQL server Configuration Monitoring data (Daily)
Source dataset opsb_mssql_server_conf
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1072
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1073
AI Operations Management - Containerized 24.4
1.4.2.5.22. opsb_mssql_server_admin
Description MSSQL Server Admin Monitoring data
Key columns mssql_instance_name, timestamp_utc_s, node_fqdn
M066_DBLOGGROWTHSCNT txn_log_expansion_count integer 24 The number of transaction log expansions for the server
M067_DBLOGSHRINKSCNT txn_log_shrink_count integer 24 The number of transaction log shrinks for the server
M091_SQLADTADHOC adhoc_query_count integer 24 The number of ad hoc queries in the plan cache
M092_SQLADTLSTBCKUP last_full_db_backup_mb integer 24 The size of last full database backup of each database
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1074
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1075
AI Operations Management - Containerized 24.4
1.4.2.5.23. opsb_mssql_server_admin_1h
Description MSSQL server Admin Monitoring data (Hourly)
Source dataset opsb_mssql_server_admin
Data Aggregation
Column Name Size Description
Type Type
txn_log_expansion_avg_count integer 24 average The Average number of transaction log expansions for the server
txn_log_expansion_max_count integer 24 max The Maximum of number of transaction log expansions for the server
txn_log_shrink_avg_count integer 24 average The Average number of transaction log shrinks for the server
txn_log_shrink_min_count integer 24 min The Minimum of number of transaction log shrinks for the server
txn_log_shrink_max_count integer 24 max The Maximum of number of transaction log shrinks for the server
adhoc_query_avg_count integer 24 average The Average number of ad hoc queries in the plan cache
adhoc_query_min_count integer 24 min The Minimum of number of ad hoc queries in the plan cache
adhoc_query_max_count integer 24 max The Maximum of number of ad hoc queries in the plan cache
last_full_db_backup_avg_mb integer 24 average The Average size of last full database backup of each database
last_full_db_backup_min_mb integer 24 min The Minimum of size of last full database backup of each database
last_full_db_backup_max_mb integer 24 max The Maximum of size of last full database backup of each database
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1076
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If policies
collection_policy_name string 255 lastval
do have versions, the corresponding version number shall be
suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
node_short_name string 255 lastval
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1077
AI Operations Management - Containerized 24.4
1.4.2.5.24. opsb_mssql_server_admin_1d
Description MSSQL server Admin Monitoring data (Daily)
Source dataset opsb_mssql_server_admin
Data Aggregation
Column Name Size Description
Type Type
txn_log_expansion_avg_count integer 24 average The Average number of transaction log expansions for the server
txn_log_expansion_max_count integer 24 max The Maximum of number of transaction log expansions for the server
txn_log_shrink_avg_count integer 24 average The Average number of transaction log shrinks for the server
txn_log_shrink_min_count integer 24 min The Minimum of number of transaction log shrinks for the server
txn_log_shrink_max_count integer 24 max The Maximum of number of transaction log shrinks for the server
adhoc_query_avg_count integer 24 average The Average number of ad hoc queries in the plan cache
adhoc_query_min_count integer 24 min The Minimum of number of ad hoc queries in the plan cache
adhoc_query_max_count integer 24 max The Maximum of number of ad hoc queries in the plan cache
last_full_db_backup_avg_mb integer 24 average The Average size of last full database backup of each database
last_full_db_backup_min_mb integer 24 min The Minimum of size of last full database backup of each database
last_full_db_backup_max_mb integer 24 max The Maximum of size of last full database backup of each database
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1078
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If policies
collection_policy_name string 255 lastval
do have versions, the corresponding version number shall be
suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
node_short_name string 255 lastval
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1079
AI Operations Management - Containerized 24.4
1.4.2.5.25. opsb_mssql_filegroup_size
Description MSSQL Filegroup Size Monitoring Data
Key columns mssql_instance_name, mssql_filegroup_name, timestamp_utc_s, node_fqdn
This metric monitors the total space (MB) in each filegroup for each
null filegroup_total_size_mb double 24
database
This metric monitors the free space (MB) in each filegroup for each
null filegroup_free_space_mb double 24
database
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1080
AI Operations Management - Containerized 24.4
1.4.2.5.26. opsb_mssql_filegroup_size_1h
Description MSSQL Filegroup Size Monitoring Data (Hourly)
Source dataset opsb_mssql_filegroup_size
Data Aggregation
Column Name Size Description
Type Type
The Average this metric monitors the total space (MB) in each filegroup for each
filegroup_total_size_avg_mb double 24 average
database
The Minimum this metric monitors the total space (MB) in each filegroup for each
filegroup_total_size_min_mb double 24 min
database
The Maximum this metric monitors the total space (MB) in each filegroup for each
filegroup_total_size_max_mb double 24 max
database
The Average this metric monitors the free space (MB) in each filegroup for each
filegroup_free_space_avg_mb double 24 average
database
The Minimum this metric monitors the free space (MB) in each filegroup for each
filegroup_free_space_min_mb double 24 min
database
The Maximum this metric monitors the free space (MB) in each filegroup for each
filegroup_free_space_max_mb double 24 max
database
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API but
collection_data_flow string 80 lastval
a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1081
AI Operations Management - Containerized 24.4
1.4.2.5.27. opsb_mssql_filegroup_size_1d
Description MSSQL Filegroup Size Monitoring Data (Daily)
Source dataset opsb_mssql_filegroup_size_1h
Data Aggregation
Column Name Size Description
Type Type
The Average this metric monitors the total space (MB) in each filegroup for each
filegroup_total_size_avg_mb double 24 average
database
The Minimum this metric monitors the total space (MB) in each filegroup for each
filegroup_total_size_min_mb double 24 min
database
The Maximum this metric monitors the total space (MB) in each filegroup for each
filegroup_total_size_max_mb double 24 max
database
The Average this metric monitors the free space (MB) in each filegroup for each
filegroup_free_space_avg_mb double 24 average
database
The Minimum this metric monitors the free space (MB) in each filegroup for each
filegroup_free_space_min_mb double 24 min
database
The Maximum this metric monitors the free space (MB) in each filegroup for each
filegroup_free_space_max_mb double 24 max
database
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API but
collection_data_flow string 80 lastval
a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1082
AI Operations Management - Containerized 24.4
1.4.2.5.28. opsb_mssql_db_status
Description MSSQL DataBase Status Monitoring Data
Key columns mssql_db_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1083
AI Operations Management - Containerized 24.4
1.4.2.5.29. opsb_mssql_db_status_1h
Description MSSQL DataBase Status Monitoring Data(Hourly)
Key columns mssql_db_name, timestamp_utc_s, node_fqdn
The time duration (in minutes) in an hour when the MSSQL database is in
null uptime_min double
connected state.
The time duration (in minutes) in an hour when the MSSQL database is not
null downtime_min double
in connected state.
The time duration (in minutes) in an hour when the MSSQL database is not
null planned_downtime_min double
connected due to planned outage.
The time duration (in minutes) in an hour when the MSSQL database is not
null unknown_time_min double
connected due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1084
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1085
AI Operations Management - Containerized 24.4
1.4.2.5.30. opsb_mssql_db_status_1d
Description MSSQL DataBase Status Monitoring data (Daily)
Source dataset opsb_mssql_db_status_1h
Data Aggregation
Column Name Size Description
Type Type
The time duration (in minutes) in an hour when the MSSQL Database is in connected
uptime_min double sum
state.
The Average percentage of time in an hour when the MSSQL Database is in connected
uptime_avg_pct double avg
state.
The time duration (in minutes) in an hour when the MSSQL Database is not in connected
downtime_min double sum
state.
The Average percentage of time in an hour when the MSSQL Database is not in
downtime_avg_pct double avg
connected state.
The time duration (in minutes) in an hour when MSSQL Database is not in connected
unknown_time_min double sum
state due to unknown outage.
The Average percentage of time in an hour when the MSSQL Database is not in
unknown_time_avg_pct double avg
connected state due to unknown outage.
The time duration (in minutes) in an hour when the MSSQL Database is not in connected
planned_downtime_min double sum
state due to planned outage.
The Average percentage of time in an hour when the MSSQL Database is not in
planned_downtime_avg_pct double avg
connected state due to planned outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1086
AI Operations Management - Containerized 24.4
1.4.2.5.31. opsb_mssql_db_size
Description MSSQL DataBase Size Monitoring Data
Key columns mssql_instance_name, mssql_db_name, timestamp_utc_s, node_fqdn
null db_total_size_mb double 24 MSSQL Server total database size (in MB)
null db_free_space_mb double 24 MSSQL Server free/unallocated space available (in MB)
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
timestamp_utc_collector timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1087
AI Operations Management - Containerized 24.4
1.4.2.5.32. opsb_mssql_db_size_1h
Description MSSQL DataBase Size Monitoring Data (Hourly)
Source dataset opsb_mssql_db_size
Data Aggregation
Column Name Size Description
Type Type
db_total_size_avg_mb double 24 average The Average MSSQL Server total database size (in MB)
db_total_size_min_mb double 24 min The Minimum MSSQL Server total database size (in MB)
db_total_size_max_mb double 24 max The Maximum MSSQL Server total database size (in MB)
db_free_space_avg_mb double 24 average The Average MSSQL Server free/unallocated space available (in MB)
db_free_space_min_mb double 24 min The Minimum MSSQL Server free/unallocated space available (in MB)
db_free_space_max_mb double 24 max The Maximum MSSQL Server free/unallocated space available (in MB)
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through this
API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1088
AI Operations Management - Containerized 24.4
1.4.2.5.33. opsb_mssql_db_size_1d
Description MSSQL DataBase Size Monitoring Data (Daily)
Source dataset opsb_mssql_db_size_1h
Data Aggregation
Column Name Size Description
Type Type
db_total_size_avg_mb double 24 average The Average MSSQL Server total database size (in MB)
db_total_size_min_mb double 24 min The Minimum MSSQL Server total database size (in MB)
db_total_size_max_mb double 24 max The Maximum MSSQL Server total database size (in MB)
db_free_space_avg_mb double 24 average The Average MSSQL Server free/unallocated space available (in MB)
db_free_space_min_mb double 24 min The Minimum MSSQL Server free/unallocated space available (in MB)
db_free_space_max_mb double 24 max The Maximum MSSQL Server free/unallocated space available (in MB)
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
directly to OPTIC Data Lake. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through this
API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1089
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1090
AI Operations Management - Containerized 24.4
1.4.2.6.1. opsb_postgres_db_conn_status
Description Monitors the Connection Status metric of PostgreSQL where ConnectionStatus= 0 Down and ConnectionStatus= 1
UP
Key columns postgres_db_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to. Needed
tenant_id tenant_id string 255
to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
producer_instance_id producer_instance_id string 255 ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id cmdb_id uuid
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id cmdb_global_id uuid
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled collection
of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type collection_type string 255
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the server
MonitoredSystem node_fqdn string 255
to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
MonitoredSystemTimezone node_timezone_offset_h string 80
+1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1091
AI Operations Management - Containerized 24.4
1.4.2.6.2. opsb_postgres_db_conn_status_1d
Description Monitors the postgreSQL database connection status (Daily)
Source dataset opsb_postgres_db_conn_status_1h
Data Aggregation
Column Name Size Description
Type Type
The time duration (in minutes) in an hour when the PostgreSQL Connection Status is in
uptime_min double sum
connected state.
The Average percentage of time in an hour when the PostgreSQL Connection Status is in
uptime_avg_pct double avg
connected state.
The time duration (in minutes) in an hour when the PostgreSQL Connection Status is not
downtime_min double sum
in connected state.
The Average percentage of time in an hour when the PostgreSQL Connection Status is
downtime_avg_pct double avg
not in connected state.
The time duration (in minutes) in an hour when PostgreSQL Connection Status is not in
unknown_time_min double sum
connected state due to unknown outage.
The Average percentage of time in an hour when the PostgreSQL Connection Status is
unknown_time_avg_pct double avg
not in connected state due to unknown outage.
The time duration (in minutes) in an hour when the PostgreSQL Connection Status is not
planned_downtime_min double sum
in connected state due to planned outage.
The Average percentage of time in an hour when the PostgreSQL Connection Status is
planned_downtime_avg_pct double avg
not in connected state due to planned outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1092
AI Operations Management - Containerized 24.4
1.4.2.6.3. opsb_postgres_db_conn_status_1h
Description Monitors the postgreSQL database connection status (Hourly)
Key columns postgres_db_name, timestamp_utc_s, node_fqdn
The time duration (in minutes) in an hour when the SAP connection is in
null uptime_min double
running state.
The time duration (in minutes) in an hour when the SAP connection is not
null downtime_min double
in running state.
The time duration (in minutes) in an hour when the SAP connection is not
null planned_downtime_min double
running due to SAP server planned outage.
The percentage of time in an hour when the SAP connection is not running
null planned_downtime_pct double
due to SAP Server planned outage.
The time duration (in minutes) in an hour when the SAP connection state
null unknown_time_min double
information not available due to unknown outage.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1093
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1094
AI Operations Management - Containerized 24.4
1.4.2.6.4. opsb_postgres_db_stat
Description Monitors the PostgreSQL Database Statistics
Key columns postgres_db_name, timestamp_utc_s, node_fqdn
Data
Metric Name/Global Name Column Name Size Description
Type
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present
in the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1095
AI Operations Management - Containerized 24.4
Data
Metric Name/Global Name Column Name Size Description
Type
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1096
AI Operations Management - Containerized 24.4
1.4.2.6.5. opsb_postgres_db_stat_1d
Description Monitors the PostgreSQL database Statistics for daily
Source dataset opsb_postgres_db_stat
Data Aggregation
Column Name Size Description
Type Type
commit_ratio_avg_pct double 24 average The Average commit Ratio metric of PostgreSQL database in percentage
commit_ratio_min_pct double 24 min The Minimum commit Ratio metric of PostgreSQL database in percentage
commit_ratio_max_pct double 24 max The Maximum commit Ratio metric of PostgreSQL database in percentage
commit_ratio_pctl_pct double 24 90 percentile The Percentile of the commit Ratio metric of PostgreSQL database in percentage
hit_ratio_avg_pct double 24 average The Average hit Ratio of PostgreSQL database in percentage
hit_ratio_min_pct double 24 min The Minimum hit Ratio of PostgreSQL database in percentage
hit_ratio_max_pct double 24 max The Maximum hit Ratio of PostgreSQL database in percentage
hit_ratio_pctl_pct double 24 90 percentile The Percentile of the hit Ratio of PostgreSQL database in percentage
backend_conn_avg_pct double 24 average The Average backend Connections Percentage of PostgreSQL database
backend_conn_min_pct double 24 min The Minimum backend Connections Percentage of PostgreSQL database
backend_conn_max_pct double 24 max The Maximum backend Connections Percentage of PostgreSQL database
backend_conn_pctl_pct double 24 90 percentile The Percentile of the backend Connections Percentage of PostgreSQL database
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1097
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1098
AI Operations Management - Containerized 24.4
1.4.2.6.6. opsb_postgres_db_stat_1h
Description Monitors the PostgreSQL database Statistics for hourly
Source dataset opsb_postgres_db_stat
Data Aggregation
Column Name Size Description
Type Type
commit_ratio_avg_pct double 24 average The Average commit Ratio metric of PostgreSQL database in percentage
commit_ratio_min_pct double 24 min The Minimum commit Ratio metric of PostgreSQL database in percentage
commit_ratio_max_pct double 24 max The Maximum commit Ratio metric of PostgreSQL database in percentage
commit_ratio_pctl_pct double 24 90 percentile The Percentile of the commit Ratio metric of PostgreSQL database in percentage
hit_ratio_avg_pct double 24 average The Average hit Ratio of PostgreSQL database in percentage
hit_ratio_min_pct double 24 min The Minimum hit Ratio of PostgreSQL database in percentage
hit_ratio_max_pct double 24 max The Maximum hit Ratio of PostgreSQL database in percentage
hit_ratio_pctl_pct double 24 90 percentile The Percentile of the hit Ratio of PostgreSQL database in percentage
backend_conn_avg_pct double 24 average The Average backend Connections Percentage of PostgreSQL database
backend_conn_min_pct double 24 min The Minimum backend Connections Percentage of PostgreSQL database
backend_conn_max_pct double 24 max The Maximum backend Connections Percentage of PostgreSQL database
backend_conn_pctl_pct double 24 90 percentile The Percentile of the backend Connections Percentage of PostgreSQL database
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1099
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1100
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1101
AI Operations Management - Containerized 24.4
1.4.2.7.1. opsb_ora_users_sessions
Description Oracle Database details such as users, session and processes.
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1102
AI Operations Management - Containerized 24.4
1.4.2.7.2. opsb_ora_users_sessions_1h
Description Oracle Database details such as users, session and processes. (Hourly)
Source dataset opsb_ora_users_sessions
Data Aggregation
Column Name Size Description
Type Type
curr_act_process_pctl_pct integer 24 90 percentile The Percentile of the percentage of current active processes
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -
node_timezone_offset_h string 80 lastval
8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1103
AI Operations Management - Containerized 24.4
1.4.2.7.3. opsb_ora_users_sessions_1d
Description Oracle Database details such as users, session and processes. (Daily)
Source dataset opsb_ora_users_sessions
Data Aggregation
Column Name Size Description
Type Type
curr_act_process_pctl_pct integer 24 90 percentile The Percentile of the percentage of current active processes
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_global_id uuid lastval
if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -
node_timezone_offset_h string 80 lastval
8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1104
AI Operations Management - Containerized 24.4
1.4.2.7.4. opsb_ora_tablespace_metrics
Description Oracle Database Tablespace metrics such as IO, Allocated and Free
Key columns ora_instance_name, ora_database_host, ora_tablespace_name, timestamp_utc_s, node_fqdn
null tablespace_io_count integer 24 Number of physical reads and writes for tablespace.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1105
AI Operations Management - Containerized 24.4
1.4.2.7.5. opsb_ora_tablespace_metrics_1h
Description Oracle Database Tablespace metrics such as IO, Allocated and Free (Hourly)
Source dataset opsb_ora_tablespace_metrics
Data Aggregation
Column Name Size Description
Type Type
tablespace_free_space_avg_mb integer 24 average The Average free Space Available for Tablespace in MB
tablespace_free_space_min_mb integer 24 min The Minimum free Space Available for Tablespace in MB
tablespace_free_space_max_mb integer 24 max The Maximum free Space Available for Tablespace in MB
tablespace_io_avg_count integer 24 average The Average number of physical reads and writes for tablespace.
tablespace_io_min_count integer 24 min The Minimum number of physical reads and writes for tablespace.
tablespace_io_max_count integer 24 max The Maximum number of physical reads and writes for tablespace.
tablespace_io_count integer 24 lastval Number of physical reads and writes for tablespace.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1106
AI Operations Management - Containerized 24.4
1.4.2.7.6. opsb_ora_tablespace_metrics_1d
Description Oracle Database Tablespace metrics such as IO, Allocated and Free (Daily)
Source dataset opsb_ora_tablespace_metrics_1h
Data Aggregation
Column Name Size Description
Type Type
tablespace_free_space_avg_mb integer 24 average The Average free Space Available for Tablespace in MB
tablespace_free_space_min_mb integer 24 min The Minimum free Space Available for Tablespace in MB
tablespace_free_space_max_mb integer 24 max The Maximum free Space Available for Tablespace in MB
tablespace_io_avg_count integer 24 average The Average number of physical reads and writes for tablespace.
tablespace_io_min_count integer 24 min The Minimum number of physical reads and writes for tablespace.
tablespace_io_max_count integer 24 max The Maximum number of physical reads and writes for tablespace.
tablespace_io_count integer 24 lastval Number of physical reads and writes for tablespace.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1107
AI Operations Management - Containerized 24.4
1.4.2.7.7. opsb_ora_storage_metrics
Description Oracle Database Storage Metrics
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
E006_TBLSPFREEPCTCNT low_space_tablespace_count integer 24 Number of table spaces with low free space
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection
CollectionConfigName collection_policy_name string 255 policy. If policies do have versions, the corresponding version
number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1108
AI Operations Management - Containerized 24.4
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1109
AI Operations Management - Containerized 24.4
1.4.2.7.8. opsb_ora_storage_metrics_1h
Description Oracle Database Storage Metrics (Hourly)
Source dataset opsb_ora_storage_metrics
Data Aggregation
Column Name Size Description
Type Type
bg_dump_space_used_avg_pct integer 24 average The Average space used on background dump device in Percentage
bg_dump_space_used_min_pct integer 24 min The Minimum space used on background dump device in Percentage
bg_dump_space_used_max_pct integer 24 max The Maximum space used on background dump device in Percentage
user_dump_space_used_avg_pct integer 24 average The Average space used on user dump device in Percentage
user_dump_space_used_min_pct integer 24 min The Minimum space used on user dump device in Percentage
user_dump_space_used_max_pct integer 24 max The Maximum space used on user dump device in Percentage
user_dump_space_used_pctl_pct integer 24 90 percentile The Percentile of the space used on user dump device in Percentage
core_dump_space_used_avg_pct integer 24 average The Average space used on core dump device in percentage
core_dump_space_used_min_pct integer 24 min The Minimum space used on core dump device in percentage
core_dump_space_used_max_pct integer 24 max The Maximum space used on core dump device in percentage
core_dump_space_used_pctl_pct integer 24 90 percentile The Percentile of the space used on core dump device in percentage
low_space_tablespace_avg_count integer 24 average The Average number of table spaces with low free space
low_space_tablespace_min_count integer 24 min The Minimum number of table spaces with low free space
low_space_tablespace_max_count integer 24 max The Maximum number of table spaces with low free space
low_space_tablespace_count integer 24 lastval Number of table spaces with low free space
high_tablespace_read_ratio_count integer 24 lastval Number of table spaces with high ratio of block to physical reads
high_temp_segments_tablespace_count integer 24 lastval Number of tablespaces with high use of temporary segments to total
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1110
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
fail_group_imbalance_avg_count integer 24 average The Average number of diskgroups having imbalanced failure groups
fail_group_imbalance_min_count integer 24 min The Minimum number of diskgroups having imbalanced failure groups
fail_group_imbalance_max_count integer 24 max The Maximum number of diskgroups having imbalanced failure groups
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1111
AI Operations Management - Containerized 24.4
1.4.2.7.9. opsb_ora_storage_metrics_1d
Description Oracle Database Storage Metrics (Daily)
Source dataset opsb_ora_storage_metrics
Data Aggregation
Column Name Size Description
Type Type
bg_dump_space_used_avg_pct integer 24 average The Average space used on background dump device in Percentage
bg_dump_space_used_min_pct integer 24 min The Minimum space used on background dump device in Percentage
bg_dump_space_used_max_pct integer 24 max The Maximum space used on background dump device in Percentage
user_dump_space_used_avg_pct integer 24 average The Average space used on user dump device in Percentage
user_dump_space_used_min_pct integer 24 min The Minimum space used on user dump device in Percentage
user_dump_space_used_max_pct integer 24 max The Maximum space used on user dump device in Percentage
user_dump_space_used_pctl_pct integer 24 90 percentile The Percentile of the space used on user dump device in Percentage
core_dump_space_used_avg_pct integer 24 average The Average space used on core dump device in percentage
core_dump_space_used_min_pct integer 24 min The Minimum space used on core dump device in percentage
core_dump_space_used_max_pct integer 24 max The Maximum space used on core dump device in percentage
core_dump_space_used_pctl_pct integer 24 90 percentile The Percentile of the space used on core dump device in percentage
low_space_tablespace_avg_count integer 24 average The Average number of table spaces with low free space
low_space_tablespace_min_count integer 24 min The Minimum number of table spaces with low free space
low_space_tablespace_max_count integer 24 max The Maximum number of table spaces with low free space
low_space_tablespace_count integer 24 lastval Number of table spaces with low free space
high_tablespace_read_ratio_count integer 24 lastval Number of table spaces with high ratio of block to physical reads
high_temp_segments_tablespace_count integer 24 lastval Number of tablespaces with high use of temporary segments to total
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1112
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
fail_group_imbalance_avg_count integer 24 average The Average number of diskgroups having imbalanced failure groups
fail_group_imbalance_min_count integer 24 min The Minimum number of diskgroups having imbalanced failure groups
fail_group_imbalance_max_count integer 24 max The Maximum number of diskgroups having imbalanced failure groups
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id uuid lastval in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
collection_policy_name string 255 lastval
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
node_short_name string 255 lastval
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1113
AI Operations Management - Containerized 24.4
1.4.2.7.10. opsb_ora_segment_space_util
Description Oracle Database Segment Space Allocated and Free
Key columns ora_instance_name, ora_database_host, ora_segment_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1114
AI Operations Management - Containerized 24.4
1.4.2.7.11. opsb_ora_segment_space_util_1h
Description Oracle Database Segment Space Allocated and Free (Hourly)
Source dataset opsb_ora_segment_space_util
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1115
AI Operations Management - Containerized 24.4
1.4.2.7.12. opsb_ora_segment_space_util_1d
Description Oracle Database Segment Space Allocated and Free (Daily)
Source dataset opsb_ora_segment_space_util_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data through
this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1116
AI Operations Management - Containerized 24.4
1.4.2.7.13. opsb_ora_replication_metrics
Description Oracle Database Replication Health
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
E056_ARCHVFREESPCCNT archive_free_space_count integer 24 Number of archive logs that fit in archive device
E057_ARCHIVEFREQRATE archive_writes_rate_min integer 24 Average time in minutes between archive log writes
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1117
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1118
AI Operations Management - Containerized 24.4
1.4.2.7.14. opsb_ora_replication_metrics_1h
Description Oracle Database Replication Health (Hourly)
Source dataset opsb_ora_replication_metrics
Data Aggregation
Column Name Size Description
Type Type
archive_free_space_avg_count integer 24 average The Average number of archive logs that fit in archive device
archive_free_space_min_count integer 24 min The Minimum number of archive logs that fit in archive device
archive_free_space_max_count integer 24 max The Maximum number of archive logs that fit in archive device
archive_free_space_count integer 24 lastval Number of archive logs that fit in archive device
archive_writes_rate_avg_min integer 24 average The Average average time in minutes between archive log writes
archive_writes_rate_min_min integer 24 min The Minimum average time in minutes between archive log writes
archive_writes_rate_max_min integer 24 max The Maximum average time in minutes between archive log writes
archive_writes_rate_min integer 24 lastval Average time in minutes between archive log writes
archive_free_space_avg_pct integer 24 average The Average percentage of free space on archive device
archive_free_space_min_pct integer 24 min The Minimum percentage of free space on archive device
archive_free_space_max_pct integer 24 max The Maximum percentage of free space on archive device
archive_free_space_pctl_pct integer 24 10 percentile The Percentile of the percentage of free space on archive device
redo_log_unarchived_avg_count integer 24 average The Average number of redo logs not yet archived
redo_log_unarchived_min_count integer 24 min The Minimum number of redo logs not yet archived
redo_log_unarchived_max_count integer 24 max The Maximum number of redo logs not yet archived
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1119
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1120
AI Operations Management - Containerized 24.4
1.4.2.7.15. opsb_ora_replication_metrics_1d
Description Oracle Database Replication Health (Daily)
Source dataset opsb_ora_replication_metrics
Data Aggregation
Column Name Size Description
Type Type
archive_free_space_avg_count integer 24 average The Average number of archive logs that fit in archive device
archive_free_space_min_count integer 24 min The Minimum number of archive logs that fit in archive device
archive_free_space_max_count integer 24 max The Maximum number of archive logs that fit in archive device
archive_free_space_count integer 24 lastval Number of archive logs that fit in archive device
archive_writes_rate_avg_min integer 24 average The Average average time in minutes between archive log writes
archive_writes_rate_min_min integer 24 min The Minimum average time in minutes between archive log writes
archive_writes_rate_max_min integer 24 max The Maximum average time in minutes between archive log writes
archive_writes_rate_min integer 24 lastval Average time in minutes between archive log writes
archive_free_space_avg_pct integer 24 average The Average percentage of free space on archive device
archive_free_space_min_pct integer 24 min The Minimum percentage of free space on archive device
archive_free_space_max_pct integer 24 max The Maximum percentage of free space on archive device
archive_free_space_pctl_pct integer 24 10 percentile The Percentile of the percentage of free space on archive device
redo_log_unarchived_avg_count integer 24 average The Average number of redo logs not yet archived
redo_log_unarchived_min_count integer 24 min The Minimum number of redo logs not yet archived
redo_log_unarchived_max_count integer 24 max The Maximum number of redo logs not yet archived
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1121
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1122
AI Operations Management - Containerized 24.4
1.4.2.7.16. opsb_ora_query_perf
Description Oracle Database Query Performance
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1123
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1124
AI Operations Management - Containerized 24.4
1.4.2.7.17. opsb_ora_query_perf_1h
Description Oracle Database Query Performance (Hourly)
Source dataset opsb_ora_query_perf
Data Aggregation
Column Name Size Description
Type Type
srvs_busy_avg_pct integer 24 average The Average percentage of busy servers to parallel query servers
srvs_busy_min_pct integer 24 min The Minimum percentage of busy servers to parallel query servers
srvs_busy_max_pct integer 24 max The Maximum percentage of busy servers to parallel query servers
srvs_busy_pctl_pct integer 24 90 percentile The Percentile of the percentage of busy servers to parallel query servers
srv_highwater_avg_pct integer 24 average The Average percentage of highwatermark servers to parallel query servers
srv_highwater_min_pct integer 24 min The Minimum percentage of highwatermark servers to parallel query servers
srv_highwater_max_pct integer 24 max The Maximum percentage of highwatermark servers to parallel query servers
parallel_qry_range_scan_avg_pct integer 24 average The Average percentage of range scan vs full table scans
parallel_qry_range_scan_min_pct integer 24 min The Minimum percentage of range scan vs full table scans
parallel_qry_range_scan_max_pct integer 24 max The Maximum percentage of range scan vs full table scans
parallel_qry_range_scan_pctl_pct integer 24 90 percentile The Percentile of the percentage of range scan vs full table scans
open_cursors_users_avg_count integer 24 average The Average number of users with percentage of open cursors
open_cursors_users_min_count integer 24 min The Minimum number of users with percentage of open cursors
open_cursors_users_max_count integer 24 max The Maximum number of users with percentage of open cursors
recursive_vs_user_call_ratio_avg integer 24 average The Average ratio of recursive calls to user calls
recursive_vs_user_call_ratio_min integer 24 min The Minimum ratio of recursive calls to user calls
recursive_vs_user_call_ratio_max integer 24 max The Maximum ratio of recursive calls to user calls
rollback_avg_count_per_min integer 24 average The Average rate at which rollbacks are being generated
rollback_min_count_per_min integer 24 min The Minimum rate at which rollbacks are being generated
rollback_max_count_per_min integer 24 max The Maximum rate at which rollbacks are being generated
current_txn_pctl_pct integer 24 90 percentile The Percentile of the percentage of current transactions to configured
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1125
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1126
AI Operations Management - Containerized 24.4
1.4.2.7.18. opsb_ora_query_perf_1d
Description Oracle Database Query Performance (Daily)
Source dataset opsb_ora_query_perf
Data Aggregation
Column Name Size Description
Type Type
srvs_busy_avg_pct integer 24 average The Average percentage of busy servers to parallel query servers
srvs_busy_min_pct integer 24 min The Minimum percentage of busy servers to parallel query servers
srvs_busy_max_pct integer 24 max The Maximum percentage of busy servers to parallel query servers
srvs_busy_pctl_pct integer 24 90 percentile The Percentile of the percentage of busy servers to parallel query servers
srv_highwater_avg_pct integer 24 average The Average percentage of highwatermark servers to parallel query servers
srv_highwater_min_pct integer 24 min The Minimum percentage of highwatermark servers to parallel query servers
srv_highwater_max_pct integer 24 max The Maximum percentage of highwatermark servers to parallel query servers
parallel_qry_range_scan_avg_pct integer 24 average The Average percentage of range scan vs full table scans
parallel_qry_range_scan_min_pct integer 24 min The Minimum percentage of range scan vs full table scans
parallel_qry_range_scan_max_pct integer 24 max The Maximum percentage of range scan vs full table scans
parallel_qry_range_scan_pctl_pct integer 24 90 percentile The Percentile of the percentage of range scan vs full table scans
open_cursors_users_avg_count integer 24 average The Average number of users with percentage of open cursors
open_cursors_users_min_count integer 24 min The Minimum number of users with percentage of open cursors
open_cursors_users_max_count integer 24 max The Maximum number of users with percentage of open cursors
recursive_vs_user_call_ratio_avg integer 24 average The Average ratio of recursive calls to user calls
recursive_vs_user_call_ratio_min integer 24 min The Minimum ratio of recursive calls to user calls
recursive_vs_user_call_ratio_max integer 24 max The Maximum ratio of recursive calls to user calls
rollback_avg_count_per_min integer 24 average The Average rate at which rollbacks are being generated
rollback_min_count_per_min integer 24 min The Minimum rate at which rollbacks are being generated
rollback_max_count_per_min integer 24 max The Maximum rate at which rollbacks are being generated
current_txn_pctl_pct integer 24 90 percentile The Percentile of the percentage of current transactions to configured
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1127
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to COSO. Pull:Data producer provides data through an API but a
collection_data_flow string 80 lastval
separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1128
AI Operations Management - Containerized 24.4
1.4.2.7.19. opsb_ora_perf
Description Oracle Database Performance
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
E004_USERSTMPDFLTCNT default_tablespace_users_count integer 24 Number of users with default tablespace set to SYSTEM
E092_SHRSRVRREQWTPCT shared_servers_waiting_pct integer 24 Percentage of the shared servers waiting for requests
E026_DICTCACHEHITPCT dictionary_cache_hit_pct integer 24 Percentage of dictionary cache get hit to total cache hit
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1129
AI Operations Management - Containerized 24.4
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs
tenant_id tenant_id string 255 to. Needed to apply row level access policies to control access to
data.
Indicates the type of the data producer that ingested the data.
producer_instance_type producer_instance_type string 50
E.g UCMDB, NOM
Name of the policy that produced this data row. It can be the
name of an Agent streaming policy or a remote collection policy.
CollectionConfigName collection_policy_name string 255
If policies do have versions, the corresponding version number
shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1130
AI Operations Management - Containerized 24.4
1.4.2.7.20. opsb_ora_perf_1h
Description Oracle Database Performance (Hourly)
Source dataset opsb_ora_perf
Data Aggregation
Column Name Size Description
Type Type
default_tablespace_users_avg_count integer 24 average The Average number of users with default tablespace set to SYSTEM
default_tablespace_users_min_count integer 24 min The Minimum number of users with default tablespace set to SYSTEM
default_tablespace_users_max_count integer 24 max The Maximum number of users with default tablespace set to SYSTEM
default_tablespace_users_count integer 24 lastval Number of users with default tablespace set to SYSTEM
foreign_obj_sys_avg_count integer 24 average The Average number of foreign objects in SYSTEM table space
foreign_obj_sys_min_count integer 24 min The Minimum number of foreign objects in SYSTEM table space
foreign_obj_sys_max_count integer 24 max The Maximum number of foreign objects in SYSTEM table space
unanalyzed_tables_indexes_avg_pct integer 24 average The Average percentage of never analyzed tables & indexes
unanalyzed_tables_indexes_min_pct integer 24 min The Minimum percentage of never analyzed tables & indexes
unanalyzed_tables_indexes_max_pct integer 24 max The Maximum percentage of never analyzed tables & indexes
unanalyzed_tables_indexes_pctl_pct integer 24 90 percentile The Percentile of the percentage of never analyzed tables & indexes
rows_fetched_index_pctl_pct integer 24 10 percentile The Percentile of the percentage of rows fetched by index
chained_rows_fetched_pctl_pct integer 24 90 percentile The Percentile of the percentage of chained rows fetched
segments_extension_disabled_avg_count integer 24 average The Average number of segments that cannot extend
segments_extension_disabled_min_count integer 24 min The Minimum number of segments that cannot extend
segments_extension_disabled_max_count integer 24 max The Maximum number of segments that cannot extend
max_extents_segments_avg_count integer 24 average The Average number of segments approaching max extent
max_extents_segments_min_count integer 24 min The Minimum number of segments approaching max extent
max_extents_segments_max_count integer 24 max The Maximum number of segments approaching max extent
segments_extension_growth_avg_count integer 24 average The Average number of segments adding extents rapidly
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1131
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
segments_extension_growth_min_count integer 24 min The Minimum number of segments adding extents rapidly
segments_extension_growth_max_count integer 24 max The Maximum number of segments adding extents rapidly
rollback_segments_not_online_avg_count integer 24 average The Average number of Rollback Segments not online
rollback_segments_not_online_min_count integer 24 min The Minimum number of Rollback Segments not online
rollback_segments_not_online_max_count integer 24 max The Maximum number of Rollback Segments not online
curr_dispatchers_clients_avg_count integer 24 average The Average number of clients currently connected to all dispatchers
curr_dispatchers_clients_min_count integer 24 min The Minimum number of clients currently connected to all dispatchers
curr_dispatchers_clients_max_count integer 24 max The Maximum number of clients currently connected to all dispatchers
shared_servers_waiting_avg_pct integer 24 average The Average percentage of the shared servers waiting for requests
shared_servers_waiting_min_pct integer 24 min The Minimum percentage of the shared servers waiting for requests
shared_servers_waiting_max_pct integer 24 max The Maximum percentage of the shared servers waiting for requests
uga_mem_used_avg_pct integer 24 average The Average percentage of shared pool allocated to UGA
uga_mem_used_min_pct integer 24 min The Minimum percentage of shared pool allocated to UGA
uga_mem_used_max_pct integer 24 max The Maximum percentage of shared pool allocated to UGA
uga_mem_used_pctl_pct integer 24 90 percentile The Percentile of the percentage of shared pool allocated to UGA
disk_sort_avg_count_per_h integer 24 average The Average number of disk sorts per hour
disk_sort_min_count_per_h integer 24 min The Minimum number of disk sorts per hour
disk_sort_max_count_per_h integer 24 max The Maximum number of disk sorts per hour
buffer_busy_avg_pct integer 24 average The Average percentage of buffer busy waits to logical reads
buffer_busy_min_pct integer 24 min The Minimum percentage of buffer busy waits to logical reads
buffer_busy_max_pct integer 24 max The Maximum percentage of buffer busy waits to logical reads
buffer_busy_pctl_pct integer 24 90 percentile The Percentile of the percentage of buffer busy waits to logical reads
total_buffer_cache_hit_avg_pct integer 24 average The Average total buffer cache hit percentage
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1132
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
total_buffer_cache_hit_min_pct integer 24 min The Minimum total buffer cache hit percentage
total_buffer_cache_hit_max_pct integer 24 max The Maximum total buffer cache hit percentage
total_buffer_cache_hit_pctl_pct integer 24 10 percentile The Percentile of the total buffer cache hit percentage
curr_buffer_cache_hit_avg_pct integer 24 average The Average current buffer cache hit percentage
curr_buffer_cache_hit_min_pct integer 24 min The Minimum current buffer cache hit percentage
curr_buffer_cache_hit_max_pct integer 24 max The Maximum current buffer cache hit percentage
curr_buffer_cache_hit_pctl_pct integer 24 10 percentile The Percentile of the current buffer cache hit percentage
enque_waits_avg_pct integer 24 average The Average percentage of enqueue waits to enqueue requests
enque_waits_min_pct integer 24 min The Minimum percentage of enqueue waits to enqueue requests
enque_waits_max_pct integer 24 max The Maximum percentage of enqueue waits to enqueue requests
enque_waits_pctl_pct integer 24 90 percentile The Percentile of the percentage of enqueue waits to enqueue requests
dictionary_cache_hit_avg_pct integer 24 average The Average percentage of dictionary cache get hit to total cache hit
dictionary_cache_hit_min_pct integer 24 min The Minimum percentage of dictionary cache get hit to total cache hit
dictionary_cache_hit_max_pct integer 24 max The Maximum percentage of dictionary cache get hit to total cache hit
The Percentile of the percentage of dictionary cache get hit to total cache
dictionary_cache_hit_pctl_pct integer 24 90 percentile
hit
redo_log_space_req_avg_count integer 24 average The Average number of request for redo log space
redo_log_space_req_min_count integer 24 min The Minimum number of request for redo log space
redo_log_space_req_max_count integer 24 max The Maximum number of request for redo log space
redo_alloc_latch_misses_avg_pct integer 24 average The Average percentage of redo allocation latch misses
redo_alloc_latch_misses_min_pct integer 24 min The Minimum percentage of redo allocation latch misses
redo_alloc_latch_misses_max_pct integer 24 max The Maximum percentage of redo allocation latch misses
redo_alloc_latch_misses_pctl_pct integer 24 90 percentile The Percentile of the percentage of redo allocation latch misses
redo_copy_latch_misses_avg_pct integer 24 average The Average percentage of redo copy latch misses
redo_copy_latch_misses_min_pct integer 24 min The Minimum percentage of redo copy latch misses
redo_copy_latch_misses_max_pct integer 24 max The Maximum percentage of redo copy latch misses
redo_copy_latch_misses_pctl_pct integer 24 90 percentile The Percentile of the percentage of redo copy latch misses
library_cache_gethits_avg_pct integer 24 average The Average percentage of gethits to gets in dictionary cache
library_cache_gethits_min_pct integer 24 min The Minimum percentage of gethits to gets in dictionary cache
library_cache_gethits_max_pct integer 24 max The Maximum percentage of gethits to gets in dictionary cache
library_cache_gethits_pctl_pct integer 24 10 percentile The Percentile of the percentage of gethits to gets in dictionary cache
library_cache_pinhits_avg_pct integer 24 average The Average percentage of pinhits to pins in dictionary cache
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1133
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
library_cache_pinhits_min_pct integer 24 min The Minimum percentage of pinhits to pins in dictionary cache
library_cache_pinhits_max_pct integer 24 max The Maximum percentage of pinhits to pins in dictionary cache
library_cache_pinhits_pctl_pct integer 24 10 percentile The Percentile of the percentage of pinhits to pins in dictionary cache
free_shared_pool_avg_pct integer 24 average The Average percentage of free shared pool memory
free_shared_pool_min_pct integer 24 min The Minimum percentage of free shared pool memory
free_shared_pool_max_pct integer 24 max The Maximum percentage of free shared pool memory
free_shared_pool_pctl_pct integer 24 10 percentile The Percentile of the percentage of free shared pool memory
sort_avg_count_per_min integer 24 average The Average rate of sorts (disk & in-memory)
sort_min_count_per_min integer 24 min The Minimum rate of sorts (disk & in-memory)
sort_max_count_per_min integer 24 max The Maximum rate of sorts (disk & in-memory)
cursor_in_cache_pctl_pct integer 24 90 percentile The Percentile of the percentage of cursors in cache parameter
recursive_vs_opened_cursor_ratio_avg integer 24 average The Average ratio of recursive calls to cumulative opened cursors
recursive_vs_opened_cursor_ratio_min integer 24 min The Minimum ratio of recursive calls to cumulative opened cursors
recursive_vs_opened_cursor_ratio_max integer 24 max The Maximum ratio of recursive calls to cumulative opened cursors
dbwr_checkpoint_avg_count_per_min integer 24 average The Average rate of Database Writer process checkpoints
dbwr_checkpoint_min_count_per_min integer 24 min The Minimum rate of Database Writer process checkpoints
dbwr_checkpoint_max_count_per_min integer 24 max The Maximum rate of Database Writer process checkpoints
free_java_pool_avg_pct integer 24 average The Average percentage of JAVA pool free memory
free_java_pool_min_pct integer 24 min The Minimum percentage of JAVA pool free memory
free_java_pool_max_pct integer 24 max The Maximum percentage of JAVA pool free memory
free_java_pool_pctl_pct integer 24 10 percentile The Percentile of the percentage of JAVA pool free memory
free_large_pool_avg_pct integer 24 average The Average percentage of Large pool free memory
free_large_pool_min_pct integer 24 min The Minimum percentage of Large pool free memory
free_large_pool_max_pct integer 24 max The Maximum percentage of Large pool free memory
free_large_pool_pctl_pct integer 24 10 percentile The Percentile of the percentage of Large pool free memory
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1134
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1135
AI Operations Management - Containerized 24.4
1.4.2.7.21. opsb_ora_perf_1d
Description Oracle Database Performance (Daily)
Source dataset opsb_ora_perf
Data Aggregation
Column Name Size Description
Type Type
default_tablespace_users_avg_count integer 24 average The Average number of users with default tablespace set to SYSTEM
default_tablespace_users_min_count integer 24 min The Minimum number of users with default tablespace set to SYSTEM
default_tablespace_users_max_count integer 24 max The Maximum number of users with default tablespace set to SYSTEM
default_tablespace_users_count integer 24 lastval Number of users with default tablespace set to SYSTEM
foreign_obj_sys_avg_count integer 24 average The Average number of foreign objects in SYSTEM table space
foreign_obj_sys_min_count integer 24 min The Minimum number of foreign objects in SYSTEM table space
foreign_obj_sys_max_count integer 24 max The Maximum number of foreign objects in SYSTEM table space
unanalyzed_tables_indexes_avg_pct integer 24 average The Average percentage of never analyzed tables & indexes
unanalyzed_tables_indexes_min_pct integer 24 min The Minimum percentage of never analyzed tables & indexes
unanalyzed_tables_indexes_max_pct integer 24 max The Maximum percentage of never analyzed tables & indexes
unanalyzed_tables_indexes_pctl_pct integer 24 90 percentile The Percentile of the percentage of never analyzed tables & indexes
rows_fetched_index_pctl_pct integer 24 10 percentile The Percentile of the percentage of rows fetched by index
chained_rows_fetched_pctl_pct integer 24 90 percentile The Percentile of the percentage of chained rows fetched
segments_extension_disabled_avg_count integer 24 average The Average number of segments that cannot extend
segments_extension_disabled_min_count integer 24 min The Minimum number of segments that cannot extend
segments_extension_disabled_max_count integer 24 max The Maximum number of segments that cannot extend
max_extents_segments_avg_count integer 24 average The Average number of segments approaching max extent
max_extents_segments_min_count integer 24 min The Minimum number of segments approaching max extent
max_extents_segments_max_count integer 24 max The Maximum number of segments approaching max extent
segments_extension_growth_avg_count integer 24 average The Average number of segments adding extents rapidly
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1136
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
segments_extension_growth_min_count integer 24 min The Minimum number of segments adding extents rapidly
segments_extension_growth_max_count integer 24 max The Maximum number of segments adding extents rapidly
rollback_segments_not_online_avg_count integer 24 average The Average number of Rollback Segments not online
rollback_segments_not_online_min_count integer 24 min The Minimum number of Rollback Segments not online
rollback_segments_not_online_max_count integer 24 max The Maximum number of Rollback Segments not online
curr_dispatchers_clients_avg_count integer 24 average The Average number of clients currently connected to all dispatchers
curr_dispatchers_clients_min_count integer 24 min The Minimum number of clients currently connected to all dispatchers
curr_dispatchers_clients_max_count integer 24 max The Maximum number of clients currently connected to all dispatchers
shared_servers_waiting_avg_pct integer 24 average The Average percentage of the shared servers waiting for requests
shared_servers_waiting_min_pct integer 24 min The Minimum percentage of the shared servers waiting for requests
shared_servers_waiting_max_pct integer 24 max The Maximum percentage of the shared servers waiting for requests
uga_mem_used_avg_pct integer 24 average The Average percentage of shared pool allocated to UGA
uga_mem_used_min_pct integer 24 min The Minimum percentage of shared pool allocated to UGA
uga_mem_used_max_pct integer 24 max The Maximum percentage of shared pool allocated to UGA
uga_mem_used_pctl_pct integer 24 90 percentile The Percentile of the percentage of shared pool allocated to UGA
disk_sort_avg_count_per_h integer 24 average The Average number of disk sorts per hour
disk_sort_min_count_per_h integer 24 min The Minimum number of disk sorts per hour
disk_sort_max_count_per_h integer 24 max The Maximum number of disk sorts per hour
buffer_busy_avg_pct integer 24 average The Average percentage of buffer busy waits to logical reads
buffer_busy_min_pct integer 24 min The Minimum percentage of buffer busy waits to logical reads
buffer_busy_max_pct integer 24 max The Maximum percentage of buffer busy waits to logical reads
buffer_busy_pctl_pct integer 24 90 percentile The Percentile of the percentage of buffer busy waits to logical reads
total_buffer_cache_hit_avg_pct integer 24 average The Average total buffer cache hit percentage
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1137
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
total_buffer_cache_hit_min_pct integer 24 min The Minimum total buffer cache hit percentage
total_buffer_cache_hit_max_pct integer 24 max The Maximum total buffer cache hit percentage
total_buffer_cache_hit_pctl_pct integer 24 10 percentile The Percentile of the total buffer cache hit percentage
curr_buffer_cache_hit_avg_pct integer 24 average The Average current buffer cache hit percentage
curr_buffer_cache_hit_min_pct integer 24 min The Minimum current buffer cache hit percentage
curr_buffer_cache_hit_max_pct integer 24 max The Maximum current buffer cache hit percentage
curr_buffer_cache_hit_pctl_pct integer 24 10 percentile The Percentile of the current buffer cache hit percentage
enque_waits_avg_pct integer 24 average The Average percentage of enqueue waits to enqueue requests
enque_waits_min_pct integer 24 min The Minimum percentage of enqueue waits to enqueue requests
enque_waits_max_pct integer 24 max The Maximum percentage of enqueue waits to enqueue requests
enque_waits_pctl_pct integer 24 90 percentile The Percentile of the percentage of enqueue waits to enqueue requests
dictionary_cache_hit_avg_pct integer 24 average The Average percentage of dictionary cache get hit to total cache hit
dictionary_cache_hit_min_pct integer 24 min The Minimum percentage of dictionary cache get hit to total cache hit
dictionary_cache_hit_max_pct integer 24 max The Maximum percentage of dictionary cache get hit to total cache hit
The Percentile of the percentage of dictionary cache get hit to total cache
dictionary_cache_hit_pctl_pct integer 24 90 percentile
hit
redo_log_space_req_avg_count integer 24 average The Average number of request for redo log space
redo_log_space_req_min_count integer 24 min The Minimum number of request for redo log space
redo_log_space_req_max_count integer 24 max The Maximum number of request for redo log space
redo_alloc_latch_misses_avg_pct integer 24 average The Average percentage of redo allocation latch misses
redo_alloc_latch_misses_min_pct integer 24 min The Minimum percentage of redo allocation latch misses
redo_alloc_latch_misses_max_pct integer 24 max The Maximum percentage of redo allocation latch misses
redo_alloc_latch_misses_pctl_pct integer 24 90 percentile The Percentile of the percentage of redo allocation latch misses
redo_copy_latch_misses_avg_pct integer 24 average The Average percentage of redo copy latch misses
redo_copy_latch_misses_min_pct integer 24 min The Minimum percentage of redo copy latch misses
redo_copy_latch_misses_max_pct integer 24 max The Maximum percentage of redo copy latch misses
redo_copy_latch_misses_pctl_pct integer 24 90 percentile The Percentile of the percentage of redo copy latch misses
library_cache_gethits_avg_pct integer 24 average The Average percentage of gethits to gets in dictionary cache
library_cache_gethits_min_pct integer 24 min The Minimum percentage of gethits to gets in dictionary cache
library_cache_gethits_max_pct integer 24 max The Maximum percentage of gethits to gets in dictionary cache
library_cache_gethits_pctl_pct integer 24 10 percentile The Percentile of the percentage of gethits to gets in dictionary cache
library_cache_pinhits_avg_pct integer 24 average The Average percentage of pinhits to pins in dictionary cache
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1138
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
library_cache_pinhits_min_pct integer 24 min The Minimum percentage of pinhits to pins in dictionary cache
library_cache_pinhits_max_pct integer 24 max The Maximum percentage of pinhits to pins in dictionary cache
library_cache_pinhits_pctl_pct integer 24 10 percentile The Percentile of the percentage of pinhits to pins in dictionary cache
free_shared_pool_avg_pct integer 24 average The Average percentage of free shared pool memory
free_shared_pool_min_pct integer 24 min The Minimum percentage of free shared pool memory
free_shared_pool_max_pct integer 24 max The Maximum percentage of free shared pool memory
free_shared_pool_pctl_pct integer 24 10 percentile The Percentile of the percentage of free shared pool memory
sort_avg_count_per_min integer 24 average The Average rate of sorts (disk & in-memory)
sort_min_count_per_min integer 24 min The Minimum rate of sorts (disk & in-memory)
sort_max_count_per_min integer 24 max The Maximum rate of sorts (disk & in-memory)
cursor_in_cache_pctl_pct integer 24 90 percentile The Percentile of the percentage of cursors in cache parameter
recursive_vs_opened_cursor_ratio_avg integer 24 average The Average ratio of recursive calls to cumulative opened cursors
recursive_vs_opened_cursor_ratio_min integer 24 min The Minimum ratio of recursive calls to cumulative opened cursors
recursive_vs_opened_cursor_ratio_max integer 24 max The Maximum ratio of recursive calls to cumulative opened cursors
dbwr_checkpoint_avg_count_per_min integer 24 average The Average rate of Database Writer process checkpoints
dbwr_checkpoint_min_count_per_min integer 24 min The Minimum rate of Database Writer process checkpoints
dbwr_checkpoint_max_count_per_min integer 24 max The Maximum rate of Database Writer process checkpoints
free_java_pool_avg_pct integer 24 average The Average percentage of JAVA pool free memory
free_java_pool_min_pct integer 24 min The Minimum percentage of JAVA pool free memory
free_java_pool_max_pct integer 24 max The Maximum percentage of JAVA pool free memory
free_java_pool_pctl_pct integer 24 10 percentile The Percentile of the percentage of JAVA pool free memory
free_large_pool_avg_pct integer 24 average The Average percentage of Large pool free memory
free_large_pool_min_pct integer 24 min The Minimum percentage of Large pool free memory
free_large_pool_max_pct integer 24 max The Maximum percentage of Large pool free memory
free_large_pool_pctl_pct integer 24 10 percentile The Percentile of the percentage of Large pool free memory
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id uuid lastval the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id uuid lastval the field name if cmdb_global_id of more than one entity is present in the
dataset
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1139
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
collection_policy_name string 255 lastval
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
node_timezone_offset_h string 80 lastval
example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs
This field holds the tenant id to which the row in dataset belongs to.
tenant_id_id string 255
Needed to apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1140
AI Operations Management - Containerized 24.4
1.4.2.7.22. opsb_ora_io_perf
Description Oracle Database IO Performance
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be
collection_source collection_source string 255 the name of hostname if the source is AMC else if its empty it will be
Agent Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used
cmdb_id cmdb_id uuid in the field name if cmdb_id of more than one entity is present in the
dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1141
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1142
AI Operations Management - Containerized 24.4
1.4.2.7.23. opsb_ora_io_perf_1h
Description Oracle Database IO Performance (Hourly)
Source dataset opsb_ora_io_perf
Data Aggregation
Column Name Size Description
Type Type
physical_reads_per_min_avg integer 24 average The Average number of physical reads per min
physical_reads_per_min_min integer 24 min The Minimum number of physical reads per min
physical_reads_per_min_max integer 24 max The Maximum number of physical reads per min
logical_reads_per_min_avg integer 24 average The Average number of logical reads per min
logical_reads_per_min_min integer 24 min The Minimum number of logical reads per min
logical_reads_per_min_max integer 24 max The Maximum number of logical reads per min
dml_locks_used_pctl_pct integer 24 90 percentile The Percentile of the percentage of DML locks used
sessions_wait_for_lock_avg_count integer 24 average The Average number of sessions waiting for release of a lock
sessions_wait_for_lock_min_count integer 24 min The Minimum number of sessions waiting for release of a lock
sessions_wait_for_lock_max_count integer 24 max The Maximum number of sessions waiting for release of a lock
high_contention_latches_avg_count integer 24 average The Average number of latches with high contention ratio
high_contention_latches_min_count integer 24 min The Minimum number of latches with high contention ratio
high_contention_latches_max_count integer 24 max The Maximum number of latches with high contention ratio
locks_disabled_tables_avg_count integer 24 average The Average number of tables with table locks disabled
locks_disabled_tables_min_count integer 24 min The Minimum number of tables with table locks disabled
locks_disabled_tables_max_count integer 24 max The Maximum number of tables with table locks disabled
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1143
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1144
AI Operations Management - Containerized 24.4
1.4.2.7.24. opsb_ora_io_perf_1d
Description Oracle Database IO Performance (Daily)
Source dataset opsb_ora_io_perf
Data Aggregation
Column Name Size Description
Type Type
physical_reads_per_min_avg integer 24 average The Average number of physical reads per min
physical_reads_per_min_min integer 24 min The Minimum number of physical reads per min
physical_reads_per_min_max integer 24 max The Maximum number of physical reads per min
logical_reads_per_min_avg integer 24 average The Average number of logical reads per min
logical_reads_per_min_min integer 24 min The Minimum number of logical reads per min
logical_reads_per_min_max integer 24 max The Maximum number of logical reads per min
dml_locks_used_pctl_pct integer 24 90 percentile The Percentile of the percentage of DML locks used
sessions_wait_for_lock_avg_count integer 24 average The Average number of sessions waiting for release of a lock
sessions_wait_for_lock_min_count integer 24 min The Minimum number of sessions waiting for release of a lock
sessions_wait_for_lock_max_count integer 24 max The Maximum number of sessions waiting for release of a lock
high_contention_latches_avg_count integer 24 average The Average number of latches with high contention ratio
high_contention_latches_min_count integer 24 min The Minimum number of latches with high contention ratio
high_contention_latches_max_count integer 24 max The Maximum number of latches with high contention ratio
locks_disabled_tables_avg_count integer 24 average The Average number of tables with table locks disabled
locks_disabled_tables_min_count integer 24 min The Minimum number of tables with table locks disabled
locks_disabled_tables_max_count integer 24 max The Maximum number of tables with table locks disabled
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of
data through this API.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1145
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1146
AI Operations Management - Containerized 24.4
1.4.2.7.25. opsb_ora_instance_status
Description Oracle database connection status
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1147
AI Operations Management - Containerized 24.4
1.4.2.7.26. opsb_ora_instance_status_1h
Description Oracle database connection status_1h
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
null uptime_min integer The time (in minutes) during the interval when the system was available.
null uptime_pct double The percentage of time the system was available during the interval.
null downtime_min integer The time duration, in minutes, the system was unavailable.
null downtime_pct double The percentage of time the system was unavailable during the interval.
The time (in minutes) during the interval for which the system outage was
null unknown_time_min integer
unknown.
The percentage of time during the interval for which the system outage
null unknown_time_pct double
was unknown.
The time (in minutes) during the interval for which the system outage was
null planned_downtime_min double
planned.
The percentage of time during the interval for which the system outage
null planned_downtime_pct double
was planned.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1148
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1149
AI Operations Management - Containerized 24.4
1.4.2.7.27. opsb_ora_instance_status_1d
Description Oracle DataBase Status Monitoring data (Daily)
Source dataset opsb_ora_instance_status_1h
Data Aggregation
Column Name Size Description
Type Type
The time duration (in minutes) in an hour when the MsSql Database is in connected
uptime_min integer sum
state.
The Average percentage of time in an hour when the MsSql Database is in connected
uptime_avg_pct double avg
state.
The time duration (in minutes) in an hour when the MsSql Database is not in connected
downtime_min integer sum
state.
The Average percentage of time in an hour when the MsSql Database is not in
downtime_avg_pct double avg
connected state.
The time duration (in minutes) in an hour when MsSql Database is not in connected
unknown_time_min integer sum
state due to unknown outage.
The Average percentage of time in an hour when the MsSql Database is not in
unknown_time_avg_pct double avg
connected state due to unknown outage.
The time duration (in minutes) in an hour when the MsSql Database is not in connected
planned_downtime_min double sum
state due to planned outage.
The Average percentage of time in an hour when the MsSql Database is not in
planned_downtime_avg_pct double avg
connected state due to planned outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1150
AI Operations Management - Containerized 24.4
1.4.2.7.28. opsb_ora_db_space_util
Description Oracle Database Instance Space Allocated and Free
Key columns ora_instance_name, ora_database_host, ora_database_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1151
AI Operations Management - Containerized 24.4
1.4.2.7.29. opsb_ora_db_space_util_1h
Description Oracle Database Instance Space Allocated and Free (Hourly)
Source dataset opsb_ora_db_space_util
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1152
AI Operations Management - Containerized 24.4
1.4.2.7.30. opsb_ora_db_space_util_1d
Description Oracle Database Instance Space Allocated and Free (Daily)
Source dataset opsb_ora_db_space_util_1h
Data Aggregation
Column Name Size Description
Type Type
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_id uuid lastval
cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field name if
cmdb_global_id uuid lastval
cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate collection
process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent streaming
collection_policy_name string 255 lastval policy or a remote collection policy. If policies do have versions, the corresponding version
number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6 format
node_ipv6_address string 50 lastval
without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
node_timezone_offset_h string 80 lastval Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply row
tenant_id_id string 255
level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1153
AI Operations Management - Containerized 24.4
1.4.2.7.31. opsb_ora_dataguard_status
Description Oracle Data Guard Fast-Start Failover Status
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
null timestamp_utc_collector_s integer 24 The sample collection time field which holds value in unix epoch
Source of the Metric Collection that produced this data row. It can be the
collection_source collection_source string 255 name of hostname if the source is AMC else if its empty it will be Agent
Streaming
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean 1 Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1154
AI Operations Management - Containerized 24.4
1.4.2.7.32. opsb_ora_dataguard_status_1h
Description Oracle Data Guard Fast-Start Failover Status_1h
Key columns ora_instance_name, ora_database_host, timestamp_utc_s, node_fqdn
null uptime_min integer The time (in minutes) during the interval when the system was available.
null uptime_pct double The percentage of time the system was available during the interval.
null downtime_min integer The time duration, in minutes, the system was unavailable.
null downtime_pct double The percentage of time the system was unavailable during the interval.
The time (in minutes) during the interval for which the system outage was
null unknown_time_min integer
unknown.
The percentage of time during the interval for which the system outage
null unknown_time_pct double
was unknown.
The time (in minutes) during the interval for which the system outage was
null planned_downtime_min double
planned.
The percentage of time during the interval for which the system outage
null planned_downtime_pct double
was planned.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type producer_instance_type string 50
NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid
the field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in
cmdb_global_id cmdb_global_id uuid the field name if cmdb_global_id of more than one entity is present in the
dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to COSO. Pull:Data producer provides data through an
collection_data_flow collection_data_flow string 80
API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming",
collection_type collection_type string 255
"Collection Service - Agent", "BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1155
AI Operations Management - Containerized 24.4
Short name of the server being monitored. Name must not contain any '.'
MonitoredSystemID node_short_name string 255
(Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1156
AI Operations Management - Containerized 24.4
1.4.2.7.33. opsb_ora_dataguard_status_1d
Description Oracle DataBase Status Monitoring data (Daily)
Source dataset opsb_ora_dataguard_status_1h
Data Aggregation
Column Name Size Description
Type Type
The time duration (in minutes) in an hour when the MsSql Database is in connected
uptime_min integer sum
state.
The Average percentage of time in an hour when the MsSql Database is in connected
uptime_avg_pct double avg
state.
The time duration (in minutes) in an hour when the MsSql Database is not in connected
downtime_min integer sum
state.
The Average percentage of time in an hour when the MsSql Database is not in
downtime_avg_pct double avg
connected state.
The time duration (in minutes) in an hour when MsSql Database is not in connected
unknown_time_min integer sum
state due to unknown outage.
The Average percentage of time in an hour when the MsSql Database is not in
unknown_time_avg_pct double avg
connected state due to unknown outage.
The time duration (in minutes) in an hour when the MsSql Database is not in connected
planned_downtime_min double sum
state due to planned outage.
The Average percentage of time in an hour when the MsSql Database is not in
planned_downtime_avg_pct double avg
connected state due to planned outage.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field name
cmdb_id uuid lastval
if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_global_id uuid lastval
name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes data
collection_data_flow string 80 lastval directly to COSO. Pull:Data producer provides data through an API but a separate
collection process does a periodic and scheduled collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
collection_policy_name string 255 lastval streaming policy or a remote collection policy. If policies do have versions, the
corresponding version number shall be suffixed. For Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For example:
collection_type string 255 lastval "SiteScope Streaming", "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified ipv6
node_ipv6_address string 50 lastval
format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1, +4.5,
node_timezone_offset_h string 80 lastval
-8
The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to apply
tenant_id_id string 255
row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1157
AI Operations Management - Containerized 24.4
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1158
AI Operations Management - Containerized 24.4
1.4.2.8.1. opsb_weblogic_cluster
Description Weblogic Server Cluster Monitoring Data
Key columns weblogic_srv_instance_name, weblogic_cluster_name, timestamp_utc_s, node_fqdn
WEBLGCCLUSRTRSNDRQST resend_req_count integer 24 Number of multicast messages to cluster that were resent.
WEBLGC_MCASTMSGLSTCT multicast_msg_lost_count integer 24 Number of multicast messages from cluster lost by server.
WEBLGCCLSOUTMSFAILRT out_msg_fail_count_per_min integer 24 Number of multicast messages from cluster lost by server per minute.
WEBLGC_CLSINMSFAILRT in_msg_fail_count_per_min integer 24 Number of multicast messages to cluster that were re-sent per minute.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of
an Agent streaming policy or a remote collection policy. If policies do
CollectionConfigName collection_policy_name string 255
have versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1159
AI Operations Management - Containerized 24.4
1.4.2.8.2. opsb_weblogic_cluster_1d
Description Weblogic Server Cluster Monitoring Data (Daily)
Source dataset opsb_weblogic_cluster_1h
Data Aggregation
Column Name Size Description
Type Type
resend_req_avg_count integer 24 average The Average number of multicast messages to cluster that were resent.
resend_req_min_count integer 24 min The Minimum number of multicast messages to cluster that were resent.
resend_req_max_count integer 24 max The Maximum number of multicast messages to cluster that were resent.
multicast_msg_lost_avg_count integer 24 average The Average number of multicast messages from cluster lost by server.
multicast_msg_lost_min_count integer 24 min The Minimum number of multicast messages from cluster lost by server.
multicast_msg_lost_max_count integer 24 max The Maximum number of multicast messages from cluster lost by server.
The Average number of multicast messages from cluster lost by server per
out_msg_fail_avg_count_per_min average
minute.
The Minimum number of multicast messages from cluster lost by server per
out_msg_fail_min_count_per_min min
minute.
The Maximum number of multicast messages from cluster lost by server per
out_msg_fail_max_count_per_min max
minute.
The Average number of multicast messages to cluster that were re-sent per
in_msg_fail_avg_count_per_min average
minute.
The Minimum number of multicast messages to cluster that were re-sent per
in_msg_fail_min_count_per_min min
minute.
The Maximum number of multicast messages to cluster that were re-sent per
in_msg_fail_max_count_per_min max
minute.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1160
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
Weblogic server instance name. This is formatted with server name, instance
weblogic_srv_instance_name_id string 255
name and server listen port.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1161
AI Operations Management - Containerized 24.4
1.4.2.8.3. opsb_weblogic_cluster_1h
Description Weblogic Server Cluster Monitoring Data (Hourly)
Source dataset opsb_weblogic_cluster
Data Aggregation
Column Name Size Description
Type Type
resend_req_avg_count integer 24 average The Average number of multicast messages to cluster that were resent.
resend_req_min_count integer 24 min The Minimum number of multicast messages to cluster that were resent.
resend_req_max_count integer 24 max The Maximum number of multicast messages to cluster that were resent.
multicast_msg_lost_avg_count integer 24 average The Average number of multicast messages from cluster lost by server.
multicast_msg_lost_min_count integer 24 min The Minimum number of multicast messages from cluster lost by server.
multicast_msg_lost_max_count integer 24 max The Maximum number of multicast messages from cluster lost by server.
The Average number of multicast messages from cluster lost by server per
out_msg_fail_avg_count_per_min integer 24 average
minute.
The Minimum number of multicast messages from cluster lost by server per
out_msg_fail_min_count_per_min integer 24 min
minute.
The Maximum number of multicast messages from cluster lost by server per
out_msg_fail_max_count_per_min integer 24 max
minute.
The Average number of multicast messages to cluster that were re-sent per
in_msg_fail_avg_count_per_min integer 24 average
minute.
The Minimum number of multicast messages to cluster that were re-sent per
in_msg_fail_min_count_per_min integer 24 min
minute.
The Maximum number of multicast messages to cluster that were re-sent per
in_msg_fail_max_count_per_min integer 24 max
minute.
producer_instance_type string 50 lastval Indicates the type of the data producer that ingested the data. E.g UCMDB, NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the field
cmdb_id uuid lastval
name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively pushes
data directly to OPTIC Data Lake. Pull:Data producer provides data through an API
collection_data_flow string 80 lastval
but a separate collection process does a periodic and scheduled collection of data
through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.' (Period)
node_short_name string 255 lastval
character.
Time zone offset to UTC in hours of the server being monitored. For example: +1,
node_timezone_offset_h string 80 lastval
+4.5, -8
The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1162
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
Weblogic server instance name. This is formatted with server name, instance
weblogic_srv_instance_name_id string 255
name and server listen port.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1163
AI Operations Management - Containerized 24.4
1.4.2.8.4. opsb_weblogic_cluster_status
Description Weblogic Server Cluster Health Status Monitoring Data
Key columns weblogic_srv_instance_name, weblogic_cluster_name, timestamp_utc_s, node_fqdn
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Holds the local ID of the entity in UCMDB. [entity type] should be used in
cmdb_id cmdb_id uuid the field name if cmdb_id of more than one entity is present in the
dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used
cmdb_global_id cmdb_global_id uuid in the field name if cmdb_global_id of more than one entity is present in
the dataset
Name of the policy that produced this data row. It can be the name of an
Agent streaming policy or a remote collection policy. If policies do have
CollectionConfigName collection_policy_name string 255
versions, the corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
The fully qualified hostname of the server being monitored. That is the
MonitoredSystem node_fqdn string 255
server to which the data belongs
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain any
MonitoredSystemID node_short_name string 255
'.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1164
AI Operations Management - Containerized 24.4
1.4.2.8.5. opsb_weblogic_ejb_cache
Description Weblogic Server Enterprise JavaBeans Cache Runtime Information Data
Key columns weblogic_srv_instance_name, weblogic_ejb_cache_rt_app_name, timestamp_utc_s, node_fqdn
WEBLOGIC_NAME weblogic_ejb_cache_rt_app_name string 255 Weblogic EJB cache runtime application name
WEBLGCEJBCACHEHITPCT cache_hit_pct double 24 Percentage of Enterprise JavaBeans (EJBs) in the cache in use.
timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch
This field holds the tenant id to which the row in dataset belongs to.
tenant_id tenant_id string 255
Needed to apply row level access policies to control access to data.
Indicates the type of the data producer that ingested the data. E.g
producer_instance_type producer_instance_type string 50
UCMDB, NOM
Name of the policy that produced this data row. It can be the name
of an Agent streaming policy or a remote collection policy. If policies
CollectionConfigName collection_policy_name string 255
do have versions, the corresponding version number shall be
suffixed. For Example:"MyCollectionPolicy_v1.3"
node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.
Short name of the server being monitored. Name must not contain
MonitoredSystemID node_short_name string 255
any '.' (Period) character.
Time zone offset to UTC in hours of the server being monitored. For
MonitoredSystemTimezone node_timezone_offset_h string 80
example: +1, +4.5, -8
null received_in_downtime boolean Is the data received during downtime of related entity
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1165
AI Operations Management - Containerized 24.4
1.4.2.8.6. opsb_weblogic_ejb_cache_1d
Description Weblogic Server Enterprise JavaBeans Cache Runtime Information Data (Daily)
Source dataset opsb_weblogic_ejb_cache
Data Aggregation
Column Name Size Description
Type Type
The Average provides a count of the total number of attempts to access a bean
cache_access_avg_count double 24 average
from the cache.
cache_hit_avg_pct double 24 average The Average percentage of Enterprise JavaBeans (EJBs) in the cache in use.
cache_hit_min_pct double 24 min The Minimum percentage of Enterprise JavaBeans (EJBs) in the cache in use.
cache_hit_max_pct double 24 max The Maximum percentage of Enterprise JavaBeans (EJBs) in the cache in use.
cache_miss_avg_pct double 24 average The Average percentage of Enterprise JavaBeans (EJBs) cache missed.
cache_miss_min_pct double 24 min The Minimum percentage of Enterprise JavaBeans (EJBs) cache missed.
cache_miss_max_pct double 24 max The Maximum percentage of Enterprise JavaBeans (EJBs) cache missed.
cache_miss_pctl_pct double 24 90 percentile The Percentile of the percentage of Enterprise JavaBeans (EJBs) cache missed.
Indicates the type of the data producer that ingested the data. E.g UCMDB,
producer_instance_type string 50 lastval
NOM
producer_instance_id string 255 lastval ID that uniquely identifies the data producer instance within a producer type
Holds the local ID of the entity in UCMDB. [entity type] should be used in the
cmdb_id uuid lastval
field name if cmdb_id of more than one entity is present in the dataset
Holds the global ID of the entity in UCMDB. [entity type] should be used in the
cmdb_global_id uuid lastval
field name if cmdb_global_id of more than one entity is present in the dataset
Values are Push or Pull. Push:Data producer (producer instance id) actively
pushes data directly to OPTIC Data Lake. Pull:Data producer provides data
collection_data_flow string 80 lastval
through an API but a separate collection process does a periodic and scheduled
collection of data through this API.
Name of the policy that produced this data row. It can be the name of an Agent
streaming policy or a remote collection policy. If policies do have versions, the
collection_policy_name string 255 lastval
corresponding version number shall be suffixed. For
Example:"MyCollectionPolicy_v1.3"
A detailed description of the actual collector that actively collects data. For
example: "SiteScope Streaming", "Operations Agent Streaming", "Collection
collection_type string 255 lastval
Service - Agent", "BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.
node_ipv4_address string 50 lastval IPV4 address of the server being monitored if using IPV4.
The IP address of the monitored server. Encoded as IPv6 format. Fully specified
node_ipv6_address string 50 lastval
ipv6 format without any simplification rules.
Short name of the server being monitored. Name must not contain any '.'
node_short_name string 255 lastval
(Period) character.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1166
AI Operations Management - Containerized 24.4
Data Aggregation
Column Name Size Description
Type Type
Time zone offset to UTC in hours of the server being monitored. For example:
node_timezone_offset_h string 80 lastval
+1, +4.5, -8
The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs
This field holds the tenant id to which the row in dataset belongs to. Needed to
tenant_id_id string 255
apply row level access policies to control access to data.
timestamp_utc_s_id integer 24 The sample time field which holds value in unix epoch
Weblogic server instance name. This is formatted with server name, instance
weblogic_srv_instance_name_id string 255
name and server listen port.
This PDF was generated on 12/19/2024 for your convenience. For the latest documentation, always see https://docs.microfocus.com. Page 1167
AI Operations Management - Containerized 24.4
1.4.2.8.7. opsb_weblogic_ejb_cache_1h
Description Weblogic Server Enterprise JavaBeans Cache Runtime Information Data (Hourly)
Source dataset opsb_weblogic_ejb_cache
Data Aggregation
Column Name Size Description
Type Type
The Average provides a count of the total number of attempts to access a bean
cache_access_avg_count double 24 average
from the cache.
cache_hit_avg_pct double 24 average The Average percentage of Enterprise JavaBeans (EJBs) in the cache in use.
cache_hit_min_pct double 24 min The Minimum percentage of Enterprise JavaBeans (EJBs) in the cache in use.
cache_hit_max_pct double 24 max The Maximum percentage of Enterprise JavaBeans (EJBs) in the cache in use.