0% found this document useful (0 votes)
12 views5,882 pages

Develop Section

Uploaded by

shitalhbhalerao
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
12 views5,882 pages

Develop Section

Uploaded by

shitalhbhalerao
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5882

Develop

AI Operations Management -
Containerized
Version : 24.4

PDF Generated on : 12/19/2024

The Information Company

© Copyright 2024 Open Text


AI Operations Management - Containerized 24.4

Table of Contents
1. Develop 71

1.1. Develop OBM 72

1.1.1. Extending OBM 73

1.1.2. Web Service Interfaces 74

1.1.2.1. Reference information for all web services 75

1.1.2.2. Action Web Service Interface 82

1.1.2.2.1. Action Web Service request reference 84

1.1.2.2.2. Examples 87

1.1.2.2.3. Action Web Service troubleshooting 89

1.1.2.3. Downtime Web Service Interface 90

1.1.2.3.1. Downtime schedule examples 94

1.1.2.3.2. Import downtime data from an external source 95

1.1.2.3.3. Downtime Filters 97

1.1.2.3.4. Downtime Web Service troubleshooting 98

1.1.2.4. Event Synchronization Web Service interface 99

1.1.2.4.1. Forward events and event changes from OPR client 100

1.1.2.4.2. Synchronize event changes back from external client 102

1.1.2.4.3. Event attributes that support back synchronization 105

1.1.2.4.4. Event update: Logfile Adapter examples 106

1.1.2.4.5. Event change creation: Logfile Adapter examples 108

1.1.2.4.6. Event update to event_list example 114

1.1.2.4.7. Event Submit Examples 115

1.1.2.4.8. Event change creation for event_change_list examples 117

1.1.2.4.9. Event synchronization web service troubleshooting 118

1.1.2.5. Event Web Service Interface 119

1.1.2.6. Monitoring Automation Web Service Interface 120

1.1.2.6.1. Use the Monitoring Automation Web Service interface 121

1.1.2.6.2. Monitoring Automation Web Service interface reference 129

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

1.1.2.6.3. Examples 133

1.1.2.7. Status Web Service Interface 138

1.1.2.8. Tool Execution Web Service Interface 140

1.1.2.8.1. Tool Execution Web Service request reference 142

1.1.2.9. User Management Web Services Interface 149

1.1.2.9.1. User Management Web Services request reference 151

1.1.2.9.2. Examples 154

1.1.2.9.3. User Management Web Service troubleshooting 159

1.1.3. Groovy scripts 160

1.1.3.1. Best practices 162

1.1.3.2. Development and deployment of scripts 165

1.1.3.2.1. View script log messages 166

1.1.3.2.2. Event Processing Interface scripts 167

1.1.3.2.3. Custom Action scripts 172

1.1.3.2.4. Certificates Scripts 174

1.1.3.2.5. Service Health scripts 176

1.1.3.2.6. Topology Synchronization scripts 177

1.1.3.2.7. Event forwarding scripts 179

1.1.3.2.8. External Instruction Retrieval Scripts 182

1.1.3.3. Reference information 186

1.1.3.3.1. Groovy console 187

1.1.3.3.2. Available APIs 190

1.1.4. Service Health 192

1.1.4.1. Service Health Rules API 193

1.1.4.1.1. API Group and Sibling Rule 194

1.1.4.1.2. API Sample Rule 196

1.1.4.1.3. API Duration-Based Sample Rule 197

1.1.4.1.4. Create rules with the Rules API 198

1.1.4.1.5. Define an API rule in the CI Customizations page 199

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.6. Create a text file-based API rule 200

1.1.4.1.7. Define an API rule in the rule repository 204

1.1.4.1.8. Work with tooltip entries 205

1.1.4.1.9. Write to log files from the Rules API code 206

1.1.4.1.10. Include a CI property in Rules API calculations 207

1.1.4.1.11. Examples - API Sample Rule 208

1.1.4.1.11.1. Example - Average Availability Rule 209

1.1.4.1.11.2. Example - Average Performance Rule 210

1.1.4.1.12. Example - Average Performance Rule Using a Rule Parameter Filter 211

1.1.4.1.13. Examples - API Group and Sibling Rule 213

1.1.4.1.13.1. Example - Worst Child Rule 214

1.1.4.1.13.2. Example - Worst Sibling Status Rule 215

1.1.4.1.13.3. Example - Specific Child CI Group Rule 216

1.1.4.1.13.4. Example - Sibling Rule Based on Availability and Performance KPIs 217

1.1.4.1.13.5. Example - Group Average Value by CI Type 218

1.1.4.1.13.6. Example - Worst Health Indicator Rule 219

1.1.4.1.13.7. Example - Using Groovy Closure 220

1.1.4.2. Service Health External APIs 221

1.1.4.2.1. Retrieve Indicator Data API 222

1.1.4.2.2. Reset Health Indicator State API 226

1.1.4.2.3. Service Health Database Query API 227

1.1.5. RTSM Developer Reference 229

1.1.5.1. Creating Discovery and Integration Adapters 230

1.1.5.1.1. Adapter Development and Writing 231

1.1.5.1.1.1. Adapter Development and Writing Overview 232

1.1.5.1.1.2. Content Creation 233

1.1.5.1.1.2.1. The Adapter Development Cycle 234

1.1.5.1.1.2.2. Data Flow Management and Integration 236

1.1.5.1.1.2.3. Associating Business Value with Discovery Development 237

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

1.1.5.1.1.2.4. Researching Integration Requirements 238

1.1.5.1.1.3. Developing Integration Content 240

1.1.5.1.1.4. Developing Discovery Content 242

1.1.5.1.1.4.1. Discovery Adapters and Related Components 243

1.1.5.1.1.4.2. Separating Adapters 244

1.1.5.1.1.5. Implement a Discovery Adapter 245

1.1.5.1.1.6. Step 1: Create an Adapter 247

1.1.5.1.1.7. Step 2: Assign a Job to the Adapter 251

1.1.5.1.1.8. Step 3: Create Jython Code 252

1.1.5.1.1.9. Configure Remote Process Execution 253

1.1.5.1.2. Developing Jython Adapters 254

1.1.5.1.2.1. Data Flow Management API Reference 255

1.1.5.1.2.2. Create Jython Code 256

1.1.5.1.2.2.1. Use External Java JAR Files within Jython 257

1.1.5.1.2.2.2. Execution of the Code 258

1.1.5.1.2.2.3. Modifying Out-of-the-Box Scripts 259

1.1.5.1.2.2.4. Structure of the Jython File 260

1.1.5.1.2.2.5. Results Generation by the Jython Script 262

1.1.5.1.2.2.6. The Framework Instance 264

1.1.5.1.2.2.7. Finding the Correct Credentials (for Connection Adapters) 267

1.1.5.1.2.2.8. Handling Exceptions from Java 270

1.1.5.1.2.3. Support Localization in Jython Adapters 271

1.1.5.1.2.3.1. Add Support for a New Language 272

1.1.5.1.2.3.2. Change the Default Language 273

1.1.5.1.2.3.3. Determine the Character Set for Encoding 274

1.1.5.1.2.3.4. Define a New Job to Operate With Localized Data 275

1.1.5.1.2.3.5. Decode Commands Without a Keyword 276

1.1.5.1.2.3.6. Work with Resource Bundles 277

1.1.5.1.2.3.7. API Reference 278

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

1.1.5.1.2.4. Record DFM Code 280

1.1.5.1.2.5. Jython Libraries and Utilities 282

1.1.5.1.3. Developing Generic Database Adapters 284

1.1.5.1.3.1. Prepare the Adapter Package 285

1.1.5.1.3.2. View the Results 286

1.1.5.1.3.3. Troubleshooting and Limitations 287

1.1.5.1.4. Developing Push Adapters 288

1.1.5.1.4.1. Developing and Deploying Push Adapters 289

1.1.5.1.4.2. Build an Adapter Package 290

1.1.5.1.4.3. Create Mappings 292

1.1.5.1.4.3.1. Write Jython Scripts 295

1.1.5.1.4.4. Support Differential Synchronization 296

1.1.5.1.4.5. Generic XML Push Adapter 298

1.1.5.1.4.6. Generic Web Service Push Adapter 299

1.1.5.1.4.7. Mapping File Reference 303

1.1.5.1.4.8. Mapping File Schema 305

1.1.5.1.4.9. Mapping Results Schema 313

1.1.5.1.4.10. Customization 315

1.1.5.1.5. Developing Enhanced Generic Push Adapters 316

1.1.5.1.5.1. Overview 317

1.1.5.1.5.2. The Mapping File 318

1.1.5.1.5.3. The Groovy Traveler 320

1.1.5.1.5.4. Write Groovy Scripts 323

1.1.5.1.5.5. Implement PushConnector Interface 324

1.1.5.1.5.6. Build an Adapter Package 327

1.1.5.1.5.7. Mapping File Schema 328

1.1.5.1.6. View KPIs in external applications 336

1.1.5.2. Using APIs 337

1.1.5.2.1. APIs Overview 338

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

1.1.5.2.2. RTSM Java API 339

1.1.5.2.2.1. Conventions 341

1.1.5.2.2.2. Using the RTSM Java API 342

1.1.5.2.2.3. General Structure of an Application 343

1.1.5.2.2.4. Put the API Jar File in the Classpath 345

1.1.5.2.2.5. RTSM Java API Use Cases 346

1.1.5.2.2.6. Performance Improvement with a Bidirectional GlobalID - UcmdbID 347

Mapping Cache
1.1.5.2.2.7. Examples 348

1.1.5.2.3. RTSM REST API 349

1.1.5.2.3.1. Standalone Deployment 351

1.1.5.2.3.1.1. Configuration 352

1.1.5.2.3.2. Using REST API 353

1.1.5.2.3.2.1. A Usage Example 355

1.1.5.2.3.2.2. Generate Change Report 356

1.1.5.2.3.2.3. Sample Data Model 357

1.1.5.2.3.2.4. Insert Topology 358

1.1.5.2.3.2.5. Get CI 359

1.1.5.2.3.2.6. Update CI 360

1.1.5.2.3.2.7. Delete CI 361

1.1.5.2.3.2.8. Get Related CIs 362

1.1.5.2.3.2.9. Get Relation 363

1.1.5.2.3.2.10. Delete Relation 364

1.1.5.2.3.2.11. Sample Topology Query 365

1.1.5.2.3.2.12. Execute Query by Name 366

1.1.5.2.3.2.13. Execute Query by Definition 367

1.1.5.2.3.2.14. Run Impact Analysis 368

1.1.5.2.3.3. Multiple CMDB Calls 369

1.1.5.2.3.3.1. Converting UCMDB IDs to Global Ids 370

1.1.5.2.3.3.2. Converting Global IDs to UCMDB Ids 371

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.4. History Changes 372

1.1.5.2.3.5. Step By Step: How to Retrieve CIs Using REST API 373

1.1.5.2.4. RTSM Web Service API 378

1.1.5.2.4.1. Conventions 379

1.1.5.2.4.2. RTSM Web Service API Reference 380

1.1.5.2.4.3. RTSM Impact Analysis Methods 381

1.1.5.2.4.3.1. calculateImpact 382

1.1.5.2.4.3.2. getImpactPath 383

1.1.5.2.4.3.3. getImpactRulesByNamePrefix 384

1.1.5.2.4.4. Examples 385

1.1.5.2.5. Internal-Global ID Conversion API 386

1.1.5.2.5.1. Using the Internal-Global ID Conversion API 387

1.1.5.2.5.2. How to Convert RTSM Internal IDs to Global IDs 388

1.1.5.2.5.3. How to Convert Global IDs to RTSM Internal IDs 389

1.2. Develop Stakeholder Dashboards and reports 390

1.2.1. Create custom widgets 391

1.2.2. Modify the Visio shape 392

1.2.3. Define the custom widget code 394

1.3. Develop Custom Data Integration 400

1.3.1. Custom metric ingestion 401

1.3.1.1. Custom metric ingestion using CMI tools and Agent Metric Collector 402

1.3.1.1.1. Guidelines to create custom content 405

1.3.1.1.2. Transform data using metric transformation 406

1.3.1.1.3. Ingest custom metrics into OPTIC Data Lake 408

1.3.1.1.4. Modify the workbooks 414

1.3.1.1.5. Metrics override 417

1.3.1.1.6. Manage custom content 419

1.3.1.2. Custom metric ingestion using the streaming policies 421

1.3.2. Open data ingestion 423

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

1.3.2.1. Plan 424

1.3.2.2. Data model guidelines 425

1.3.2.3. Prepare 429

1.3.2.4. Get started 430

1.3.2.4.1. Open data ingestion API tutorial for streaming 436

1.3.2.4.1.1. Sample JSON files 453

1.3.2.5. Send the data to OPTIC Data Lake 467

1.3.2.6. Use APIs 468

1.3.2.6.1. OPTIC DL Administration REST Interface 469

1.3.2.6.2. OPTIC DL HTTP Receiver Interface 472

1.3.2.6.3. OPTIC DL Data Access API 474

1.3.2.7. Enable Troubleshoot Performance Dashboard 475

1.3.2.8. Create custom BVD reports 481

1.4. AI Operations Management Data Model 484

1.4.1. Schema updates 486

1.4.2. Enterprise application 487

1.4.2.1. Management Pack for IBM WebSphere Application Server 493

1.4.2.1.1. opsb_websphere_ejb 494

1.4.2.1.2. opsb_websphere_ejb_1d 496

1.4.2.1.3. opsb_websphere_ejb_1h 499

1.4.2.1.4. opsb_websphere_ejb_descriptor 502

1.4.2.1.5. opsb_websphere_ejb_descriptor_1d 504

1.4.2.1.6. opsb_websphere_ejb_descriptor_1h 507

1.4.2.1.7. opsb_websphere_jdbc 510

1.4.2.1.8. opsb_websphere_jdbc_1d 512

1.4.2.1.9. opsb_websphere_jdbc_1h 516

1.4.2.1.10. opsb_websphere_jdbc_descriptor 520

1.4.2.1.11. opsb_websphere_jdbc_descriptor_1d 522

1.4.2.1.12. opsb_websphere_jdbc_descriptor_1h 525

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

1.4.2.1.13. opsb_websphere_jvm_perf 528

1.4.2.1.14. opsb_websphere_jvm_perf_1d 530

1.4.2.1.15. opsb_websphere_jvm_perf_1h 533

1.4.2.1.16. opsb_websphere_server_status 536

1.4.2.1.17. opsb_websphere_server_status_1d 537

1.4.2.1.18. opsb_websphere_server_status_1h 539

1.4.2.1.19. opsb_websphere_servlet 541

1.4.2.1.20. opsb_websphere_servlet_1d 543

1.4.2.1.21. opsb_websphere_servlet_1h 545

1.4.2.1.22. opsb_websphere_servlet_session_module 547

1.4.2.1.23. opsb_websphere_servlet_session_module_1d 549

1.4.2.1.24. opsb_websphere_servlet_session_module_1h 551

1.4.2.1.25. opsb_websphere_thread 553

1.4.2.1.26. opsb_websphere_thread_1d 555

1.4.2.1.27. opsb_websphere_thread_1h 558

1.4.2.1.28. opsb_websphere_thread_descriptor 561

1.4.2.1.29. opsb_websphere_thread_descriptor_1d 563

1.4.2.1.30. opsb_websphere_thread_descriptor_1h 566

1.4.2.1.31. opsb_websphere_transact 569

1.4.2.1.32. opsb_websphere_transact_1d 571

1.4.2.1.33. opsb_websphere_transact_1h 574

1.4.2.1.34. opsb_websphere_webapp 577

1.4.2.1.35. opsb_websphere_webapp_1d 579

1.4.2.1.36. opsb_websphere_webapp_1h 581

1.4.2.2. Management Pack for Jboss Application Server 583

1.4.2.2.1. opsb_jboss_appstatus 584

1.4.2.2.2. opsb_jboss_availability 585

1.4.2.2.3. opsb_jboss_availability_1d 586

1.4.2.2.4. opsb_jboss_availability_1h 587

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

1.4.2.2.5. opsb_jboss_gc 589

1.4.2.2.6. opsb_jboss_gc_1d 590

1.4.2.2.7. opsb_jboss_gc_1h 591

1.4.2.2.8. opsb_jboss_j2eeejbmsg 592

1.4.2.2.9. opsb_jboss_j2eeejbmsg_1d 594

1.4.2.2.10. opsb_jboss_j2eeejbmsg_1h 596

1.4.2.2.11. opsb_jboss_j2eeejbstful 598

1.4.2.2.12. opsb_jboss_j2eeejbstful_1d 600

1.4.2.2.13. opsb_jboss_j2eeejbstful_1h 602

1.4.2.2.14. opsb_jboss_j2eeejbstless 604

1.4.2.2.15. opsb_jboss_j2eeejbstless_1d 606

1.4.2.2.16. opsb_jboss_j2eeejbstless_1h 608

1.4.2.2.17. opsb_jboss_j2eeservlet 610

1.4.2.2.18. opsb_jboss_j2eeservlet_1d 612

1.4.2.2.19. opsb_jboss_j2eeservlet_1h 613

1.4.2.2.20. opsb_jboss_j2eewebapp 614

1.4.2.2.21. opsb_jboss_j2eewebapp_1d 616

1.4.2.2.22. opsb_jboss_j2eewebapp_1h 618

1.4.2.2.23. opsb_jboss_jarejbmessage 620

1.4.2.2.24. opsb_jboss_jarejbmessage_1d 622

1.4.2.2.25. opsb_jboss_jarejbmessage_1h 624

1.4.2.2.26. opsb_jboss_jarejbstateful 626

1.4.2.2.27. opsb_jboss_jarejbstateful_1d 628

1.4.2.2.28. opsb_jboss_jarejbstateful_1h 630

1.4.2.2.29. opsb_jboss_jarejbstateles 632

1.4.2.2.30. opsb_jboss_jarejbstateles_1d 634

1.4.2.2.31. opsb_jboss_jarejbstateles_1h 636

1.4.2.2.32. opsb_jboss_jdbc 638

1.4.2.2.33. opsb_jboss_jdbc_1d 640

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

1.4.2.2.34. opsb_jboss_jdbc_1h 642

1.4.2.2.35. opsb_jboss_jdbcpool 644

1.4.2.2.36. opsb_jboss_jdbcpool_1d 646

1.4.2.2.37. opsb_jboss_jdbcpool_1h 648

1.4.2.2.38. opsb_jboss_jmsqueue 650

1.4.2.2.39. opsb_jboss_jmsqueue_1d 652

1.4.2.2.40. opsb_jboss_jmsqueue_1h 654

1.4.2.2.41. opsb_jboss_jmstopic 656

1.4.2.2.42. opsb_jboss_jmstopic_1d 658

1.4.2.2.43. opsb_jboss_jmstopic_1h 660

1.4.2.2.44. opsb_jboss_jvm 662

1.4.2.2.45. opsb_jboss_jvm_1d 663

1.4.2.2.46. opsb_jboss_jvm_1h 665

1.4.2.2.47. opsb_jboss_transactions 667

1.4.2.2.48. opsb_jboss_transactions_1d 669

1.4.2.2.49. opsb_jboss_transactions_1h 672

1.4.2.2.50. opsb_jboss_webapp 675

1.4.2.2.51. opsb_jboss_webapp_1d 677

1.4.2.2.52. opsb_jboss_webapp_1h 679

1.4.2.2.53. opsb_jboss_webconhttp 681

1.4.2.2.54. opsb_jboss_webconhttp_1d 682

1.4.2.2.55. opsb_jboss_webconhttp_1h 684

1.4.2.2.56. opsb_jboss_webservlet 686

1.4.2.2.57. opsb_jboss_webservlet_1d 687

1.4.2.2.58. opsb_jboss_webservlet_1h 689

1.4.2.3. Management Pack for Microsoft Active Directory 691

1.4.2.3.1. opsb_ad_availability 692

1.4.2.3.2. opsb_ad_availability_1d 693

1.4.2.3.3. opsb_ad_availability_1h 695

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

1.4.2.3.4. opsb_ad_database_cache 697

1.4.2.3.5. opsb_ad_database_cache_1d 698

1.4.2.3.6. opsb_ad_database_cache_1h 699

1.4.2.3.7. opsb_ad_dfs_replicated_folder 700

1.4.2.3.8. opsb_ad_dfs_replicated_folder_1d 702

1.4.2.3.9. opsb_ad_dfs_replicated_folder_1h 704

1.4.2.3.10. opsb_ad_dfs_replication_conn 706

1.4.2.3.11. opsb_ad_dfs_replication_conn_1d 708

1.4.2.3.12. opsb_ad_dfs_replication_conn_1h 710

1.4.2.3.13. opsb_ad_directory_services 712

1.4.2.3.14. opsb_ad_directory_services_1d 714

1.4.2.3.15. opsb_ad_directory_services_1h 717

1.4.2.3.16. opsb_ad_dit_db_disk 720

1.4.2.3.17. opsb_ad_dit_db_disk_1d 721

1.4.2.3.18. opsb_ad_dit_db_disk_1h 722

1.4.2.3.19. opsb_ad_dit_db_filesize 723

1.4.2.3.20. opsb_ad_dit_db_filesize_1d 724

1.4.2.3.21. opsb_ad_dit_db_filesize_1h 725

1.4.2.3.22. opsb_ad_dit_log_disk 726

1.4.2.3.23. opsb_ad_dit_log_disk_1d 727

1.4.2.3.24. opsb_ad_dit_log_disk_1h 729

1.4.2.3.25. opsb_ad_dns 731

1.4.2.3.26. opsb_ad_dns_1d 732

1.4.2.3.27. opsb_ad_dns_1h 733

1.4.2.3.28. opsb_ad_federation_server 734

1.4.2.3.29. opsb_ad_federation_server_1d 735

1.4.2.3.30. opsb_ad_federation_server_1h 736

1.4.2.3.31. opsb_ad_fsmo 737

1.4.2.3.32. opsb_ad_fsmo_1d 738

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

1.4.2.3.33. opsb_ad_fsmo_1h 739

1.4.2.3.34. opsb_ad_fsmo_role_movement 740

1.4.2.3.35. opsb_ad_fsmo_role_movement_1d 741

1.4.2.3.36. opsb_ad_fsmo_role_movement_1h 742

1.4.2.3.37. opsb_ad_gc_replication 743

1.4.2.3.38. opsb_ad_gc_replication_1d 744

1.4.2.3.39. opsb_ad_gc_replication_1h 745

1.4.2.3.40. opsb_ad_khi_memory 746

1.4.2.3.41. opsb_ad_khi_memory_1d 747

1.4.2.3.42. opsb_ad_khi_memory_1h 748

1.4.2.3.43. opsb_ad_khi_network_interface 749

1.4.2.3.44. opsb_ad_khi_network_interface_1d 750

1.4.2.3.45. opsb_ad_khi_network_interface_1h 752

1.4.2.3.46. opsb_ad_khi_physical_disk 754

1.4.2.3.47. opsb_ad_khi_physical_disk_1d 755

1.4.2.3.48. opsb_ad_khi_physical_disk_1h 756

1.4.2.3.49. opsb_ad_khi_processor_info 757

1.4.2.3.50. opsb_ad_khi_processor_info_1d 758

1.4.2.3.51. opsb_ad_khi_processor_info_1h 759

1.4.2.3.52. opsb_ad_ntds 760

1.4.2.3.53. opsb_ad_ntds_1d 762

1.4.2.3.54. opsb_ad_ntds_1h 764

1.4.2.3.55. opsb_ad_ntds_process 766

1.4.2.3.56. opsb_ad_ntds_process_1d 767

1.4.2.3.57. opsb_ad_ntds_process_1h 769

1.4.2.3.58. opsb_ad_process 771

1.4.2.3.59. opsb_ad_process_1d 773

1.4.2.3.60. opsb_ad_process_1h 775

1.4.2.3.61. opsb_ad_replication_latency 777

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

1.4.2.3.62. opsb_ad_replication_latency_1d 779

1.4.2.3.63. opsb_ad_replication_latency_1h 780

1.4.2.3.64. opsb_ad_response_time 781

1.4.2.3.65. opsb_ad_response_time_1d 782

1.4.2.3.66. opsb_ad_response_time_1h 784

1.4.2.3.67. opsb_ad_service_health 786

1.4.2.3.68. opsb_ad_service_health_1d 787

1.4.2.3.69. opsb_ad_service_health_1h 788

1.4.2.3.70. opsb_ad_smb_conn_status 790

1.4.2.3.71. opsb_ad_smb_conn_status_1d 791

1.4.2.3.72. opsb_ad_smb_conn_status_1h 792

1.4.2.3.73. opsb_ad_sysvol 793

1.4.2.3.74. opsb_ad_sysvol_1d 794

1.4.2.3.75. opsb_ad_sysvol_1h 795

1.4.2.3.76. opsb_ad_trust 796

1.4.2.3.77. opsb_ad_trust_1d 798

1.4.2.3.78. opsb_ad_trust_1h 799

1.4.2.4. Management Pack for Microsoft Exchange Server 800

1.4.2.4.1. opsb_exch_active_manager 802

1.4.2.4.2. opsb_exch_active_manager_1d 803

1.4.2.4.3. opsb_exch_active_manager_1h 804

1.4.2.4.4. opsb_exch_activesync_connection 805

1.4.2.4.5. opsb_exch_activesync_connection_1d 807

1.4.2.4.6. opsb_exch_activesync_connection_1h 808

1.4.2.4.7. opsb_exch_activesync_perf 809

1.4.2.4.8. opsb_exch_activesync_perf_1d 811

1.4.2.4.9. opsb_exch_activesync_perf_1h 814

1.4.2.4.10. opsb_exch_asp_dotnet 817

1.4.2.4.11. opsb_exch_asp_dotnet_1d 818

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

1.4.2.4.12. opsb_exch_asp_dotnet_1h 819

1.4.2.4.13. opsb_exch_availability 820

1.4.2.4.14. opsb_exch_availability_1d 821

1.4.2.4.15. opsb_exch_availability_1h 822

1.4.2.4.16. opsb_exch_blocked_emails 824

1.4.2.4.17. opsb_exch_blocked_emails_1d 826

1.4.2.4.18. opsb_exch_blocked_emails_1h 827

1.4.2.4.19. opsb_exch_blocked_recipient 828

1.4.2.4.20. opsb_exch_blocked_recipient_1d 829

1.4.2.4.21. opsb_exch_blocked_recipient_1h 830

1.4.2.4.22. opsb_exch_content_filter_agent 831

1.4.2.4.23. opsb_exch_content_filter_agent_1d 833

1.4.2.4.24. opsb_exch_content_filter_agent_1h 836

1.4.2.4.25. opsb_exch_eac 839

1.4.2.4.26. opsb_exch_hub_transport_dsn 840

1.4.2.4.27. opsb_exch_hub_transport_dsn_1d 842

1.4.2.4.28. opsb_exch_hub_transport_dsn_1h 844

1.4.2.4.29. opsb_exch_imap4_perf 846

1.4.2.4.30. opsb_exch_imap4_perf_1d 848

1.4.2.4.31. opsb_exch_imap4_perf_1h 852

1.4.2.4.32. opsb_exch_info_store_client 856

1.4.2.4.33. opsb_exch_info_store_client_1d 857

1.4.2.4.34. opsb_exch_info_store_client_1h 858

1.4.2.4.35. opsb_exch_mail_flow_check 859

1.4.2.4.36. opsb_exch_mail_flow_check_1d 861

1.4.2.4.37. opsb_exch_mail_flow_check_1h 862

1.4.2.4.38. opsb_exch_mailbox_database_perf 863

1.4.2.4.39. opsb_exch_mailbox_database_perf_1d 865

1.4.2.4.40. opsb_exch_mailbox_database_perf_1h 869

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

1.4.2.4.41. opsb_exch_mailbox_details 873

1.4.2.4.42. opsb_exch_mailbox_details_1d 875

1.4.2.4.43. opsb_exch_mailbox_details_1h 877

1.4.2.4.44. opsb_exch_mailbox_summary_data 879

1.4.2.4.45. opsb_exch_mailbox_summary_data_1d 881

1.4.2.4.46. opsb_exch_mailbox_summary_data_1h 883

1.4.2.4.47. opsb_exch_managed_service 885

1.4.2.4.48. opsb_exch_mapi_connectivity 886

1.4.2.4.49. opsb_exch_mapi_connectivity_1d 887

1.4.2.4.50. opsb_exch_mapi_connectivity_1h 888

1.4.2.4.51. opsb_exch_memory_info 889

1.4.2.4.52. opsb_exch_memory_info_1d 890

1.4.2.4.53. opsb_exch_memory_info_1h 891

1.4.2.4.54. opsb_exch_network_interface 892

1.4.2.4.55. opsb_exch_network_interface_1d 893

1.4.2.4.56. opsb_exch_network_interface_1h 895

1.4.2.4.57. opsb_exch_owa_connection_check 897

1.4.2.4.58. opsb_exch_owa_connection_check_1d 899

1.4.2.4.59. opsb_exch_owa_connection_check_1h 900

1.4.2.4.60. opsb_exch_owa_perf 901

1.4.2.4.61. opsb_exch_owa_perf_1d 903

1.4.2.4.62. opsb_exch_owa_perf_1h 905

1.4.2.4.63. opsb_exch_owa_server 907

1.4.2.4.64. opsb_exch_physical_disk 908

1.4.2.4.65. opsb_exch_physical_disk_1d 909

1.4.2.4.66. opsb_exch_physical_disk_1h 910

1.4.2.4.67. opsb_exch_pop3_perf 911

1.4.2.4.68. opsb_exch_pop3_perf_1d 913

1.4.2.4.69. opsb_exch_pop3_perf_1h 917

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

1.4.2.4.70. opsb_exch_processor_info 921

1.4.2.4.71. opsb_exch_processor_info_1d 922

1.4.2.4.72. opsb_exch_processor_info_1h 923

1.4.2.4.73. opsb_exch_processor_time 924

1.4.2.4.74. opsb_exch_processor_time_1d 925

1.4.2.4.75. opsb_exch_processor_time_1h 926

1.4.2.4.76. opsb_exch_public_folder_db 927

1.4.2.4.77. opsb_exch_public_folder_db_1d 929

1.4.2.4.78. opsb_exch_public_folder_db_1h 931

1.4.2.4.79. opsb_exch_public_folder_details 933

1.4.2.4.80. opsb_exch_public_folder_details_1d 935

1.4.2.4.81. opsb_exch_public_folder_details_1h 937

1.4.2.4.82. opsb_exch_rpc_client_perf 939

1.4.2.4.83. opsb_exch_rpc_client_perf_1d 941

1.4.2.4.84. opsb_exch_rpc_client_perf_1h 944

1.4.2.4.85. opsb_exch_service_status 947

1.4.2.4.86. opsb_exch_service_status_1d 948

1.4.2.4.87. opsb_exch_service_status_1h 949

1.4.2.4.88. opsb_exch_smtp_receive 950

1.4.2.4.89. opsb_exch_smtp_receive_1d 952

1.4.2.4.90. opsb_exch_smtp_receive_1h 955

1.4.2.4.91. opsb_exch_smtp_send_new 958

1.4.2.4.92. opsb_exch_smtp_send_new_1d 960

1.4.2.4.93. opsb_exch_smtp_send_new_1h 964

1.4.2.4.94. opsb_exch_smtp_send_old 968

1.4.2.4.95. opsb_exch_smtp_send_old_1d 970

1.4.2.4.96. opsb_exch_smtp_send_old_1h 974

1.4.2.4.97. opsb_exch_store_infomation_perf 978

1.4.2.4.98. opsb_exch_store_infomation_perf_1d 980

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

1.4.2.4.99. opsb_exch_store_infomation_perf_1h 982

1.4.2.4.100. opsb_exch_store_interface_perf 984

1.4.2.4.101. opsb_exch_store_interface_perf_1d 986

1.4.2.4.102. opsb_exch_store_interface_perf_1h 989

1.4.2.4.103. opsb_exch_top_destination 992

1.4.2.4.104. opsb_exch_top_destination_1d 994

1.4.2.4.105. opsb_exch_top_destination_1h 996

1.4.2.4.106. opsb_exch_top_recipient_details 998

1.4.2.4.107. opsb_exch_top_recipient_details_1d 999

1.4.2.4.108. opsb_exch_top_recipient_details_1h 1000

1.4.2.4.109. opsb_exch_top_sender 1001

1.4.2.4.110. opsb_exch_top_sender_1d 1002

1.4.2.4.111. opsb_exch_top_sender_1h 1003

1.4.2.4.112. opsb_exch_top_source 1004

1.4.2.4.113. opsb_exch_top_source_1d 1006

1.4.2.4.114. opsb_exch_top_source_1h 1007

1.4.2.4.115. opsb_exch_transport_queue_info 1008

1.4.2.4.116. opsb_exch_transport_queue_info_1d 1009

1.4.2.4.117. opsb_exch_transport_queue_info_1h 1010

1.4.2.4.118. opsb_exch_transport_queue_perf 1011

1.4.2.4.119. opsb_exch_transport_queue_perf_1d 1013

1.4.2.4.120. opsb_exch_transport_queue_perf_1h 1016

1.4.2.4.121. opsb_exch_webserver_connection 1019

1.4.2.4.122. opsb_exch_webserver_connection_1d 1021

1.4.2.4.123. opsb_exch_webserver_connection_1h 1023

1.4.2.4.124. opsb_exch_webserver_url_monitor 1025

1.4.2.4.125. opsb_exch_workload_management 1026

1.4.2.4.126. opsb_exch_workload_management_1d 1027

1.4.2.4.127. opsb_exch_workload_management_1h 1028

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

1.4.2.5. Management Pack for Microsoft SQL Server 1029

1.4.2.5.1. opsb_mssql_virtual_device_size 1030

1.4.2.5.2. opsb_mssql_virtual_device_size_1h 1031

1.4.2.5.3. opsb_mssql_virtual_device_size_1d 1032

1.4.2.5.4. opsb_mssql_table_size 1033

1.4.2.5.5. opsb_mssql_table_size_1h 1034

1.4.2.5.6. opsb_mssql_table_size_1d 1035

1.4.2.5.7. opsb_mssql_server_workload 1036

1.4.2.5.8. opsb_mssql_server_workload_1h 1037

1.4.2.5.9. opsb_mssql_server_workload_1d 1038

1.4.2.5.10. opsb_mssql_server_status 1039

1.4.2.5.11. opsb_mssql_server_status_1h 1040

1.4.2.5.12. opsb_mssql_server_status_1d 1042

1.4.2.5.13. opsb_mssql_server_perf 1043

1.4.2.5.14. opsb_mssql_server_perf_1h 1047

1.4.2.5.15. opsb_mssql_server_perf_1d 1056

1.4.2.5.16. opsb_mssql_server_fault 1065

1.4.2.5.17. opsb_mssql_server_fault_1h 1066

1.4.2.5.18. opsb_mssql_server_fault_1d 1067

1.4.2.5.19. opsb_mssql_server_conf 1068

1.4.2.5.20. opsb_mssql_server_conf_1h 1070

1.4.2.5.21. opsb_mssql_server_conf_1d 1072

1.4.2.5.22. opsb_mssql_server_admin 1074

1.4.2.5.23. opsb_mssql_server_admin_1h 1076

1.4.2.5.24. opsb_mssql_server_admin_1d 1078

1.4.2.5.25. opsb_mssql_filegroup_size 1080

1.4.2.5.26. opsb_mssql_filegroup_size_1h 1081

1.4.2.5.27. opsb_mssql_filegroup_size_1d 1082

1.4.2.5.28. opsb_mssql_db_status 1083

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

1.4.2.5.29. opsb_mssql_db_status_1h 1084

1.4.2.5.30. opsb_mssql_db_status_1d 1086

1.4.2.5.31. opsb_mssql_db_size 1087

1.4.2.5.32. opsb_mssql_db_size_1h 1088

1.4.2.5.33. opsb_mssql_db_size_1d 1089

1.4.2.6. Management Pack for PostgreSQL 1090

1.4.2.6.1. opsb_postgres_db_conn_status 1091

1.4.2.6.2. opsb_postgres_db_conn_status_1d 1092

1.4.2.6.3. opsb_postgres_db_conn_status_1h 1093

1.4.2.6.4. opsb_postgres_db_stat 1095

1.4.2.6.5. opsb_postgres_db_stat_1d 1097

1.4.2.6.6. opsb_postgres_db_stat_1h 1099

1.4.2.7. Management Pack for Oracle Database 1101

1.4.2.7.1. opsb_ora_users_sessions 1102

1.4.2.7.2. opsb_ora_users_sessions_1h 1103

1.4.2.7.3. opsb_ora_users_sessions_1d 1104

1.4.2.7.4. opsb_ora_tablespace_metrics 1105

1.4.2.7.5. opsb_ora_tablespace_metrics_1h 1106

1.4.2.7.6. opsb_ora_tablespace_metrics_1d 1107

1.4.2.7.7. opsb_ora_storage_metrics 1108

1.4.2.7.8. opsb_ora_storage_metrics_1h 1110

1.4.2.7.9. opsb_ora_storage_metrics_1d 1112

1.4.2.7.10. opsb_ora_segment_space_util 1114

1.4.2.7.11. opsb_ora_segment_space_util_1h 1115

1.4.2.7.12. opsb_ora_segment_space_util_1d 1116

1.4.2.7.13. opsb_ora_replication_metrics 1117

1.4.2.7.14. opsb_ora_replication_metrics_1h 1119

1.4.2.7.15. opsb_ora_replication_metrics_1d 1121

1.4.2.7.16. opsb_ora_query_perf 1123

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

1.4.2.7.17. opsb_ora_query_perf_1h 1125

1.4.2.7.18. opsb_ora_query_perf_1d 1127

1.4.2.7.19. opsb_ora_perf 1129

1.4.2.7.20. opsb_ora_perf_1h 1131

1.4.2.7.21. opsb_ora_perf_1d 1136

1.4.2.7.22. opsb_ora_io_perf 1141

1.4.2.7.23. opsb_ora_io_perf_1h 1143

1.4.2.7.24. opsb_ora_io_perf_1d 1145

1.4.2.7.25. opsb_ora_instance_status 1147

1.4.2.7.26. opsb_ora_instance_status_1h 1148

1.4.2.7.27. opsb_ora_instance_status_1d 1150

1.4.2.7.28. opsb_ora_db_space_util 1151

1.4.2.7.29. opsb_ora_db_space_util_1h 1152

1.4.2.7.30. opsb_ora_db_space_util_1d 1153

1.4.2.7.31. opsb_ora_dataguard_status 1154

1.4.2.7.32. opsb_ora_dataguard_status_1h 1155

1.4.2.7.33. opsb_ora_dataguard_status_1d 1157

1.4.2.8. Management Pack for Oracle Weblogic 1158

1.4.2.8.1. opsb_weblogic_cluster 1159

1.4.2.8.2. opsb_weblogic_cluster_1d 1160

1.4.2.8.3. opsb_weblogic_cluster_1h 1162

1.4.2.8.4. opsb_weblogic_cluster_status 1164

1.4.2.8.5. opsb_weblogic_ejb_cache 1165

1.4.2.8.6. opsb_weblogic_ejb_cache_1d 1166

1.4.2.8.7. opsb_weblogic_ejb_cache_1h 1168

1.4.2.8.8. opsb_weblogic_ejb_pool 1170

1.4.2.8.9. opsb_weblogic_ejb_pool_1d 1172

1.4.2.8.10. opsb_weblogic_ejb_pool_1h 1175

1.4.2.8.11. opsb_weblogic_ejb_transaction 1178

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

1.4.2.8.12. opsb_weblogic_ejb_transaction_1d 1180

1.4.2.8.13. opsb_weblogic_ejb_transaction_1h 1182

1.4.2.8.14. opsb_weblogic_gridlink 1184

1.4.2.8.15. opsb_weblogic_gridlink_1d 1186

1.4.2.8.16. opsb_weblogic_gridlink_1h 1188

1.4.2.8.17. opsb_weblogic_gridlink_state 1190

1.4.2.8.18. opsb_weblogic_jca_conn_pool 1191

1.4.2.8.19. opsb_weblogic_jca_conn_pool_1d 1193

1.4.2.8.20. opsb_weblogic_jca_conn_pool_1h 1195

1.4.2.8.21. opsb_weblogic_jdbc 1197

1.4.2.8.22. opsb_weblogic_jdbc_1d 1199

1.4.2.8.23. opsb_weblogic_jdbc_1h 1202

1.4.2.8.24. opsb_weblogic_jdk_gc 1205

1.4.2.8.25. opsb_weblogic_jdk_gc_1d 1206

1.4.2.8.26. opsb_weblogic_jdk_gc_1h 1207

1.4.2.8.27. opsb_weblogic_jdk_total_gc 1208

1.4.2.8.28. opsb_weblogic_jdk_total_gc_1d 1209

1.4.2.8.29. opsb_weblogic_jdk_total_gc_1h 1210

1.4.2.8.30. opsb_weblogic_jms 1211

1.4.2.8.31. opsb_weblogic_jms_1d 1213

1.4.2.8.32. opsb_weblogic_jms_1h 1216

1.4.2.8.33. opsb_weblogic_jms_module_state 1219

1.4.2.8.34. opsb_weblogic_jms_module_state_1d 1220

1.4.2.8.35. opsb_weblogic_jms_module_state_1h 1221

1.4.2.8.36. opsb_weblogic_jms_processed_msg 1222

1.4.2.8.37. opsb_weblogic_jms_processed_msg_1d 1223

1.4.2.8.38. opsb_weblogic_jms_processed_msg_1h 1224

1.4.2.8.39. opsb_weblogic_jms_util 1225

1.4.2.8.40. opsb_weblogic_jms_util_1d 1226

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

1.4.2.8.41. opsb_weblogic_jms_util_1h 1228

1.4.2.8.42. opsb_weblogic_jvm 1230

1.4.2.8.43. opsb_weblogic_jvm_1d 1231

1.4.2.8.44. opsb_weblogic_jvm_1h 1233

1.4.2.8.45. opsb_weblogic_maxthreadsconst 1235

1.4.2.8.46. opsb_weblogic_maxthreadsconst_1d 1236

1.4.2.8.47. opsb_weblogic_maxthreadsconst_1h 1238

1.4.2.8.48. opsb_weblogic_minthreadsconst 1240

1.4.2.8.49. opsb_weblogic_minthreadsconst_1d 1242

1.4.2.8.50. opsb_weblogic_minthreadsconst_1h 1244

1.4.2.8.51. opsb_weblogic_security 1246

1.4.2.8.52. opsb_weblogic_security_1d 1247

1.4.2.8.53. opsb_weblogic_security_1h 1249

1.4.2.8.54. opsb_weblogic_server_status 1251

1.4.2.8.55. opsb_weblogic_server_status_1d 1252

1.4.2.8.56. opsb_weblogic_server_status_1h 1254

1.4.2.8.57. opsb_weblogic_servlet_session 1256

1.4.2.8.58. opsb_weblogic_servlet_session_1d 1257

1.4.2.8.59. opsb_weblogic_servlet_session_1h 1259

1.4.2.8.60. opsb_weblogic_servlets 1261

1.4.2.8.61. opsb_weblogic_servlets_1d 1262

1.4.2.8.62. opsb_weblogic_servlets_1h 1264

1.4.2.8.63. opsb_weblogic_threadpool 1266

1.4.2.8.64. opsb_weblogic_threadpool_1d 1268

1.4.2.8.65. opsb_weblogic_threadpool_1h 1271

1.4.2.8.66. opsb_weblogic_transaction 1274

1.4.2.8.67. opsb_weblogic_transaction_1d 1276

1.4.2.8.68. opsb_weblogic_transaction_1h 1279

1.4.2.8.69. opsb_weblogic_xml_cache 1282

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

1.4.2.8.70. opsb_weblogic_xml_cache_1d 1283

1.4.2.8.71. opsb_weblogic_xml_cache_1h 1284

1.4.2.9. Management Pack for SAP 1285

1.4.2.9.1. opsb_sap_app_thread_1d 1286

1.4.2.9.2. opsb_sap_app_thread_1h 1289

1.4.2.9.3. opsb_sap_app_thread 1292

1.4.2.9.4. opsb_sap_buffer_perf_1d 1294

1.4.2.9.5. opsb_sap_buffer_perf_1h 1296

1.4.2.9.6. opsb_sap_buffer_perf 1298

1.4.2.9.7. opsb_sap_config_mgr_cls_loader_1d 1300

1.4.2.9.8. opsb_sap_config_mgr_cls_loader_1h 1302

1.4.2.9.9. opsb_sap_config_mgr_cls_loader 1304

1.4.2.9.10. opsb_sap_connection_status_1d 1305

1.4.2.9.11. opsb_sap_connection_status_1h 1307

1.4.2.9.12. opsb_sap_connection_status 1309

1.4.2.9.13. opsb_sap_db_info_perf_1d 1310

1.4.2.9.14. opsb_sap_db_info_perf_1h 1313

1.4.2.9.15. opsb_sap_db_info_perf 1316

1.4.2.9.16. opsb_sap_doc_status_perf_1d 1318

1.4.2.9.17. opsb_sap_doc_status_perf_1h 1320

1.4.2.9.18. opsb_sap_doc_status_perf 1322

1.4.2.9.19. opsb_sap_ep_perf_1d 1324

1.4.2.9.20. opsb_sap_ep_perf_1h 1327

1.4.2.9.21. opsb_sap_ep_perf 1330

1.4.2.9.22. opsb_sap_http_provider_1d 1332

1.4.2.9.23. opsb_sap_http_provider_1h 1334

1.4.2.9.24. opsb_sap_http_provider 1336

1.4.2.9.25. opsb_sap_icm_perf_1d 1337

1.4.2.9.26. opsb_sap_icm_perf_1h 1340

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

1.4.2.9.27. opsb_sap_icm_perf 1343

1.4.2.9.28. opsb_sap_icm_status_1d 1345

1.4.2.9.29. opsb_sap_icm_status_1h 1346

1.4.2.9.30. opsb_sap_icm_status 1348

1.4.2.9.31. opsb_sap_jms_perf_1d 1349

1.4.2.9.32. opsb_sap_jms_perf_1h 1350

1.4.2.9.33. opsb_sap_jms_perf 1351

1.4.2.9.34. opsb_sap_jmx_adapter_1d 1352

1.4.2.9.35. opsb_sap_jmx_adapter_1h 1354

1.4.2.9.36. opsb_sap_jmx_adapter 1356

1.4.2.9.37. opsb_sap_jndi_registry_1d 1357

1.4.2.9.38. opsb_sap_jndi_registry_1h 1358

1.4.2.9.39. opsb_sap_jndi_registry 1359

1.4.2.9.40. opsb_sap_job_repository_perf_1d 1360

1.4.2.9.41. opsb_sap_job_repository_perf_1h 1362

1.4.2.9.42. opsb_sap_job_repository_perf 1364

1.4.2.9.43. opsb_sap_log_config_1d 1366

1.4.2.9.44. opsb_sap_log_config_1h 1368

1.4.2.9.45. opsb_sap_log_config 1370

1.4.2.9.46. opsb_sap_memory_1d 1371

1.4.2.9.47. opsb_sap_memory_1h 1373

1.4.2.9.48. opsb_sap_memory_perf_1d 1375

1.4.2.9.49. opsb_sap_memory_perf_1h 1377

1.4.2.9.50. opsb_sap_memory_perf 1379

1.4.2.9.51. opsb_sap_memory 1381

1.4.2.9.52. opsb_sap_message_server_1d 1383

1.4.2.9.53. opsb_sap_message_server_1h 1384

1.4.2.9.54. opsb_sap_message_server 1385

1.4.2.9.55. opsb_sap_p4_and_iiop_provider_1d 1386

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

1.4.2.9.56. opsb_sap_p4_and_iiop_provider_1h 1388

1.4.2.9.57. opsb_sap_p4_and_iiop_provider 1390

1.4.2.9.58. opsb_sap_schedule_config_1h 1391

1.4.2.9.59. opsb_sap_session_manager_1d 1392

1.4.2.9.60. opsb_sap_session_manager_1h 1394

1.4.2.9.61. opsb_sap_session_manager 1396

1.4.2.9.62. opsb_sap_spool_perf_1d 1398

1.4.2.9.63. opsb_sap_spool_perf_1h 1400

1.4.2.9.64. opsb_sap_spool_perf 1402

1.4.2.9.65. opsb_sap_stat_record_perf_1d 1404

1.4.2.9.66. opsb_sap_stat_record_perf_1h 1406

1.4.2.9.67. opsb_sap_stat_record_perf 1408

1.4.2.9.68. opsb_sap_system_thread_1d 1409

1.4.2.9.69. opsb_sap_system_thread_1h 1412

1.4.2.9.70. opsb_sap_system_thread 1415

1.4.2.9.71. opsb_sap_system_up_perf_1d 1417

1.4.2.9.72. opsb_sap_system_up_perf_1h 1419

1.4.2.9.73. opsb_sap_system_up_perf 1421

1.4.2.9.74. opsb_sap_transaction_status_1d 1422

1.4.2.9.75. opsb_sap_transaction_status_1h 1424

1.4.2.9.76. opsb_sap_transaction_status 1426

1.4.2.9.77. opsb_sap_update_perf_1d 1428

1.4.2.9.78. opsb_sap_update_perf_1h 1430

1.4.2.9.79. opsb_sap_update_perf 1432

1.4.2.9.80. opsb_sap_user_perf_1d 1434

1.4.2.9.81. opsb_sap_user_perf_1h 1435

1.4.2.9.82. opsb_sap_user_perf 1436

1.4.2.9.83. opsb_sap_web_container_1d 1437

1.4.2.9.84. opsb_sap_web_container_1h 1438

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

1.4.2.9.85. opsb_sap_web_container 1439

1.4.2.9.86. opsb_sap_work_process_perf_1d 1440

1.4.2.9.87. opsb_sap_work_process_perf_1h 1444

1.4.2.9.88. opsb_sap_work_process_perf 1448

1.4.2.9.89. opsb_sap_workload_sum_perf_1d 1450

1.4.2.9.90. opsb_sap_workload_sum_perf_1h 1453

1.4.2.9.91. opsb_sap_workload_sum_perf 1456

1.4.2.10. Management Pack for Microsoft365 1458

1.4.2.10.1. opsb_ms365_onedrive 1459

1.4.2.10.2. opsb_ms365_outlook 1461

1.4.2.10.3. opsb_ms365_service_health 1463

1.4.2.10.4. opsb_ms365_service_health_1d 1464

1.4.2.10.5. opsb_ms365_service_health_1h 1466

1.4.2.10.6. opsb_ms365_sharepoint 1468

1.4.2.10.7. opsb_ms365_teams 1470

1.4.2.11. Operations Bridge Unified Content for MySQL 1472

1.4.2.11.1. opsb_mysql_myisam_key_cache_status 1473

1.4.2.11.2. opsb_mysql_innodb_system_tablespace 1474

1.4.2.11.3. opsb_mysql_innodb_replication_transact_stat 1476

1.4.2.11.4. opsb_mysql_innodb_replication_coord_stat 1478

1.4.2.11.5. opsb_mysql_innodb_replication_conn_stat 1479

1.4.2.11.6. opsb_mysql_innodb_disk_io_status 1480

1.4.2.11.7. opsb_mysql_innodb_cluster_status 1481

1.4.2.11.8. opsb_mysql_innodb_cluster_member_status 1482

1.4.2.11.9. opsb_mysql_innodb_clusterset_status 1483

1.4.2.11.10. opsb_mysql_innodb_clusterset_replica_status 1484

1.4.2.11.11. opsb_mysql_innodb_bufferpool_status 1486

1.4.2.11.12. opsb_mysql_server_uptime_status_1h 1487

1.4.2.11.13. opsb_mysql_network_traffic_status_1h 1488

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

1.4.2.11.14. opsb_mysql_myisam_key_cache_status_1h 1490

1.4.2.11.15. opsb_mysql_innodb_system_tablespace_1h 1492

1.4.2.11.16. opsb_mysql_innodb_replication_transact_stat_1h 1494

1.4.2.11.17. opsb_mysql_innodb_replication_coord_stat_1h 1496

1.4.2.11.18. opsb_mysql_innodb_replication_conn_stat_1h 1498

1.4.2.11.19. opsb_mysql_innodb_disk_io_status_1h 1500

1.4.2.11.20. opsb_mysql_innodb_cluster_status_1h 1502

1.4.2.11.21. opsb_mysql_innodb_cluster_member_status_1h 1503

1.4.2.11.22. opsb_mysql_innodb_clusterset_status_1h 1505

1.4.2.11.23. opsb_mysql_innodb_clusterset_replica_status_1h 1507

1.4.2.11.24. opsb_mysql_innodb_bufferpool_status_1h 1509

1.4.2.11.25. opsb_mysql_server_uptime_status_1d 1511

1.4.2.11.26. opsb_mysql_network_traffic_status_1d 1512

1.4.2.11.27. opsb_mysql_myisam_key_cache_status_1d 1514

1.4.2.11.28. opsb_mysql_innodb_system_tablespace_1d 1516

1.4.2.11.29. opsb_mysql_innodb_replication_transact_stat_1d 1518

1.4.2.11.30. opsb_mysql_innodb_replication_coord_stat_1d 1520

1.4.2.11.31. opsb_mysql_innodb_replication_conn_stat_1d 1522

1.4.2.11.32. opsb_mysql_innodb_disk_io_status_1d 1524

1.4.2.11.33. opsb_mysql_innodb_cluster_status_1d 1526

1.4.2.11.34. opsb_mysql_innodb_cluster_member_status_1d 1527

1.4.2.11.35. opsb_mysql_innodb_clusterset_status_1d 1529

1.4.2.11.36. opsb_mysql_innodb_clusterset_replica_status_1d 1531

1.4.2.11.37. opsb_mysql_innodb_bufferpool_status_1d 1533

1.4.2.11.38. opsb_mysql_network_traffic_status 1535

1.4.2.11.39. opsb_mysql_server_uptime_status 1536

1.4.2.11.40. opsb_mysql_command_status 1537

1.4.2.11.41. opsb_mysql_connection_status 1538

1.4.2.11.42. opsb_mysql_tmp_table_status 1539

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

1.4.2.11.43. opsb_mysql_thread_status 1540

1.4.2.11.44. opsb_mysql_tablelocks_status 1541

1.4.2.11.45. opsb_mysql_queries_status 1542

1.4.2.11.46. opsb_mysql_open_tables_status 1543

1.4.2.11.47. opsb_mysql_open_streams_status 1544

1.4.2.11.48. opsb_mysql_open_files_status 1545

1.4.2.11.49. opsb_mysql_open_files_status_1d 1546

1.4.2.11.50. opsb_mysql_open_streams_status_1d 1547

1.4.2.11.51. opsb_mysql_open_tables_status_1d 1548

1.4.2.11.52. opsb_mysql_queries_status_1d 1549

1.4.2.11.53. opsb_mysql_tablelocks_status_1d 1550

1.4.2.11.54. opsb_mysql_thread_status_1d 1551

1.4.2.11.55. opsb_mysql_tmp_table_status_1d 1552

1.4.2.11.56. opsb_mysql_command_status_1d 1553

1.4.2.11.57. opsb_mysql_connection_status_1d 1554

1.4.2.11.58. opsb_mysql_open_files_status_1h 1555

1.4.2.11.59. opsb_mysql_open_streams_status_1h 1556

1.4.2.11.60. opsb_mysql_open_tables_status_1h 1557

1.4.2.11.61. opsb_mysql_queries_status_1h 1558

1.4.2.11.62. opsb_mysql_tablelocks_status_1h 1559

1.4.2.11.63. opsb_mysql_thread_status_1h 1560

1.4.2.11.64. opsb_mysql_tmp_table_status_1h 1561

1.4.2.11.65. opsb_mysql_command_status_1h 1562

1.4.2.11.66. opsb_mysql_connection_status_1h 1563

1.4.2.12. Operations Bridge Unified Content for Cassandra 1564

1.4.2.12.1. opsb_cassandra_buffer_pool 1565

1.4.2.12.2. opsb_cassandra_buffer_pool_1d 1566

1.4.2.12.3. opsb_cassandra_buffer_pool_1h 1567

1.4.2.12.4. opsb_cassandra_buffer_pool_networking 1568

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

1.4.2.12.5. opsb_cassandra_buffer_pool_networking_1d 1570

1.4.2.12.6. opsb_cassandra_buffer_pool_networking_1h 1572

1.4.2.12.7. opsb_cassandra_client_connections 1574

1.4.2.12.8. opsb_cassandra_client_connections_1d 1575

1.4.2.12.9. opsb_cassandra_client_connections_1h 1576

1.4.2.12.10. opsb_cassandra_client_request_read 1577

1.4.2.12.11. opsb_cassandra_client_request_read_1d 1578

1.4.2.12.12. opsb_cassandra_client_request_read_1h 1579

1.4.2.12.13. opsb_cassandra_client_request_write 1580

1.4.2.12.14. opsb_cassandra_client_request_write_1d 1581

1.4.2.12.15. opsb_cassandra_client_request_write_1h 1582

1.4.2.12.16. opsb_cassandra_cluster_availability 1583

1.4.2.12.17. opsb_cassandra_cluster_availability_1d 1584

1.4.2.12.18. opsb_cassandra_cluster_availability_1h 1585

1.4.2.12.19. opsb_cassandra_cluster_state 1586

1.4.2.12.20. opsb_cassandra_cluster_state_1d 1587

1.4.2.12.21. opsb_cassandra_cluster_state_1h 1588

1.4.2.12.22. opsb_cassandra_commit_log 1589

1.4.2.12.23. opsb_cassandra_commit_log_1d 1590

1.4.2.12.24. opsb_cassandra_commit_log_1h 1592

1.4.2.12.25. opsb_cassandra_compaction 1594

1.4.2.12.26. opsb_cassandra_compaction_1d 1595

1.4.2.12.27. opsb_cassandra_compaction_1h 1596

1.4.2.12.28. opsb_cassandra_datacenter_availability 1597

1.4.2.12.29. opsb_cassandra_datacenter_availability_1d 1598

1.4.2.12.30. opsb_cassandra_datacenter_availability_1h 1599

1.4.2.12.31. opsb_cassandra_dropped_message_read 1600

1.4.2.12.32. opsb_cassandra_dropped_message_read_1d 1601

1.4.2.12.33. opsb_cassandra_dropped_message_read_1h 1603

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.34. opsb_cassandra_garbage_collection 1605

1.4.2.12.35. opsb_cassandra_garbage_collection_1d 1606

1.4.2.12.36. opsb_cassandra_garbage_collection_1h 1607

1.4.2.12.37. opsb_cassandra_node_availability 1608

1.4.2.12.38. opsb_cassandra_node_availability_1d 1609

1.4.2.12.39. opsb_cassandra_node_availability_1h 1610

1.4.2.12.40. opsb_cassandra_sstables_index 1611

1.4.2.12.41. opsb_cassandra_sstables_index_1d 1612

1.4.2.12.42. opsb_cassandra_sstables_index_1h 1613

1.4.2.12.43. opsb_cassandra_storage 1614

1.4.2.12.44. opsb_cassandra_storage_1d 1615

1.4.2.12.45. opsb_cassandra_storage_1h 1616

1.4.2.12.46. opsb_cassandra_threadpools_internal_compaction_executor 1617

1.4.2.12.47. opsb_cassandra_threadpools_internal_compaction_executor_1d 1618

1.4.2.12.48. opsb_cassandra_threadpools_internal_compaction_executor_1h 1619

1.4.2.12.49. opsb_cassandra_threadpools_internal_gossip_stage 1620

1.4.2.12.50. opsb_cassandra_threadpools_internal_gossip_stage_1d 1621

1.4.2.12.51. opsb_cassandra_threadpools_internal_gossip_stage_1h 1622

1.4.2.12.52. opsb_cassandra_threadpools_internal_memtable_reclaim_memory 1623

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

1.4.2.13.1. opsb_hana_column_partition 1627

1.4.2.13.2. opsb_hana_column_partition_1d 1629

1.4.2.13.3. opsb_hana_column_partition_1h 1630

1.4.2.13.4. opsb_hana_current_mem_usg_rate 1631

1.4.2.13.5. opsb_hana_current_mem_usg_rate_1d 1633

1.4.2.13.6. opsb_hana_current_mem_usg_rate_1h 1634

1.4.2.13.7. opsb_hana_data_backup_page 1635

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

1.4.2.13.8. opsb_hana_data_backup_page_1d 1636

1.4.2.13.9. opsb_hana_data_backup_page_1h 1637

1.4.2.13.10. opsb_hana_db_allocation 1638

1.4.2.13.11. opsb_hana_db_allocation_1d 1639

1.4.2.13.12. opsb_hana_db_allocation_1h 1640

1.4.2.13.13. opsb_hana_db_connection_status 1641

1.4.2.13.14. opsb_hana_db_connection_status_1d 1642

1.4.2.13.15. opsb_hana_db_connection_status_1h 1643

1.4.2.13.16. opsb_hana_db_resource_usage 1645

1.4.2.13.17. opsb_hana_db_resource_usage_1d 1647

1.4.2.13.18. opsb_hana_db_resource_usage_1h 1649

1.4.2.13.19. opsb_hana_db_transactions 1651

1.4.2.13.20. opsb_hana_db_transactions_1d 1653

1.4.2.13.21. opsb_hana_db_transactions_1h 1655

1.4.2.13.22. opsb_hana_delta_storage_memory 1657

1.4.2.13.23. opsb_hana_delta_storage_memory_1d 1659

1.4.2.13.24. opsb_hana_delta_storage_memory_1h 1661

1.4.2.13.25. opsb_hana_disk_usage 1663

1.4.2.13.26. opsb_hana_disk_usage_1d 1665

1.4.2.13.27. opsb_hana_disk_usage_1h 1667

1.4.2.13.28. opsb_hana_execution_count 1669

1.4.2.13.29. opsb_hana_execution_count_1d 1671

1.4.2.13.30. opsb_hana_execution_count_1h 1672

1.4.2.13.31. opsb_hana_heap_memory 1673

1.4.2.13.32. opsb_hana_heap_memory_1d 1675

1.4.2.13.33. opsb_hana_heap_memory_1h 1677

1.4.2.13.34. opsb_hana_license_usage 1679

1.4.2.13.35. opsb_hana_license_usage_1d 1680

1.4.2.13.36. opsb_hana_license_usage_1h 1682

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

1.4.2.13.37. opsb_hana_log_backup_status 1684

1.4.2.13.38. opsb_hana_log_backup_status_1d 1685

1.4.2.13.39. opsb_hana_log_backup_status_1h 1686

1.4.2.13.40. opsb_hana_replication_status 1687

1.4.2.13.41. opsb_hana_replication_status_1d 1688

1.4.2.13.42. opsb_hana_replication_status_1h 1689

1.4.2.13.43. opsb_hana_service_cpu_usage 1690

1.4.2.13.44. opsb_hana_service_cpu_usage_1d 1692

1.4.2.13.45. opsb_hana_service_cpu_usage_1h 1694

1.4.2.13.46. opsb_hana_service_status 1696

1.4.2.13.47. opsb_hana_service_status_1d 1698

1.4.2.13.48. opsb_hana_service_status_1h 1699

1.4.2.13.49. opsb_hana_shared_memory 1701

1.4.2.13.50. opsb_hana_shared_memory_1d 1703

1.4.2.13.51. opsb_hana_shared_memory_1h 1705

1.4.2.13.52. opsb_hana_system_statistics 1707

1.4.2.13.53. opsb_hana_system_statistics_1d 1708

1.4.2.13.54. opsb_hana_system_statistics_1h 1709

1.4.2.13.55. opsb_hana_table_record 1710

1.4.2.13.56. opsb_hana_table_record_1d 1711

1.4.2.13.57. opsb_hana_table_record_1h 1712

1.4.3. Service Health 1713

1.4.3.1. opr_hi_status 1714

1.4.3.2. opr_kpi_status 1715

1.4.3.3. opr_hi_duration_1h 1716

1.4.3.4. opr_hi_duration_1d 1717

1.4.3.5. opr_hi_severity_1h 1718

1.4.3.6. opr_hi_severity_1d 1719

1.4.3.7. opr_kpi_status_1h 1720

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

1.4.3.8. opr_kpi_status_1d 1721

1.4.3.9. opsb_internal_service_health_schedule_config_1h 1722

1.4.3.10. opsb_internal_service_health_schedule_config_1d 1723

1.4.4. Scheduled Downtime 1724

1.4.4.1. opr_downtime_latest 1725

1.4.5. System Infrastructure 1726

1.4.5.1. Aligned dataset 1727

1.4.5.1.1. opsb_sysinfra_node 1728

1.4.5.1.2. opsb_sysinfra_cpu 1729

1.4.5.1.3. opsb_sysinfra_disk 1730

1.4.5.1.4. opsb_sysinfra_filesys 1731

1.4.5.1.5. opsb_sysinfra_netif 1732

1.4.5.1.6. opsb_sysinfra_avail 1733

1.4.5.1.7. opsb_sysinfra_node_1h 1734

1.4.5.1.8. opsb_sysinfra_cpu_1h 1736

1.4.5.1.9. opsb_sysinfra_disk_1h 1737

1.4.5.1.10. opsb_sysinfra_filesys_1h 1738

1.4.5.1.11. opsb_sysinfra_netif_1h 1739

1.4.5.1.12. opsb_sysinfra_avail_1h 1741

1.4.5.1.13. opsb_sysinfra_node_1d 1742

1.4.5.1.14. opsb_sysinfra_cpu_1d 1744

1.4.5.1.15. opsb_sysinfra_disk_1d 1745

1.4.5.1.16. opsb_sysinfra_filesys_1d 1746

1.4.5.1.17. opsb_sysinfra_netif_1d 1747

1.4.5.1.18. opsb_sysinfra_avail_1d 1749

1.4.5.1.19. opsb_sysinfra_node_forecast 1750

1.4.5.1.20. opsb_sysinfra_filesys_forecast 1751

1.4.5.2. Operations Agent dataset 1752

1.4.5.2.1. opsb_agent_application 1753

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

1.4.5.2.2. opsb_agent_node 1755

1.4.5.2.3. opsb_agent_cpu 1762

1.4.5.2.4. opsb_agent_disk 1764

1.4.5.2.5. opsb_agent_filesys 1766

1.4.5.2.6. opsb_agent_netif 1768

1.4.5.2.7. opsb_agent_node_1h 1770

1.4.5.2.8. opsb_agent_cpu_1h 1793

1.4.5.2.9. opsb_agent_disk_1h 1797

1.4.5.2.10. opsb_agent_filesys_1h 1802

1.4.5.2.11. opsb_agent_netif_1h 1804

1.4.5.2.12. opsb_agent_node_1d 1807

1.4.5.2.13. opsb_agent_cpu_1d 1830

1.4.5.2.14. opsb_agent_disk_1d 1834

1.4.5.2.15. opsb_agent_filesys_1d 1839

1.4.5.2.16. opsb_agent_netif_1d 1841

1.4.5.2.17. opsb_agent_node_forecast 1844

1.4.5.2.18. opsb_agent_filesys_forecast 1852

1.4.5.3. SiteScope dataset 1853

1.4.5.3.1. opsb_agentless_node 1854

1.4.5.3.2. opsb_agentless_cpu 1856

1.4.5.3.3. opsb_agentless_disk 1857

1.4.5.3.4. opsb_agentless_filesys 1858

1.4.5.3.5. opsb_agentless_netif 1859

1.4.5.3.6. opsb_agentless_generic 1861

1.4.5.3.7. opsb_agentless_node_1h 1862

1.4.5.3.8. opsb_agentless_cpu_1h 1865

1.4.5.3.9. opsb_agentless_disk_1h 1866

1.4.5.3.10. opsb_agentless_filesys_1h 1868

1.4.5.3.11. opsb_agentless_netif_1h 1870

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

1.4.5.3.12. opsb_agentless_generic_1h 1873

1.4.5.3.13. opsb_agentless_node_1d 1874

1.4.5.3.14. opsb_agentless_cpu_1d 1877

1.4.5.3.15. opsb_agentless_disk_1d 1878

1.4.5.3.16. opsb_agentless_filesys_1d 1880

1.4.5.3.17. opsb_agentless_netif_1d 1882

1.4.5.3.18. opsb_agentless_generic_1d 1885

1.4.5.3.19. opsb_agentless_node_forecast 1886

1.4.5.3.20. opsb_agentless_filesys_forecast 1887

1.4.6. Event 1888

1.4.6.1. opr_event 1889

1.4.6.2. opr_event_annotation 1892

1.4.6.3. opsb_event_ci_summary_1h 1893

1.4.6.4. opsb_event_cit_summary_1h 1895

1.4.6.5. opsb_event_eti_summary_1h 1897

1.4.6.6. opsb_event_policy_summary_1h 1899

1.4.6.7. opsb_event_summary_1h 1901

1.4.6.8. opsb_event_user_group_summary_1h 1903

1.4.6.9. opsb_event_user_summary_1h 1905

1.4.6.10. opsb_event_ci_summary_1d 1907

1.4.6.11. opsb_event_cit_summary_1d 1909

1.4.6.12. opsb_event_eti_summary_1d 1911

1.4.6.13. opsb_event_policy_summary_1d 1913

1.4.6.14. opsb_event_summary_1d 1915

1.4.6.15. opsb_event_user_group_summary_1d 1917

1.4.6.16. opsb_event_user_summary_1d 1919

1.4.7. Real User Monitoring 1921

1.4.7.1. opsb_rum_action 1922

1.4.7.2. opsb_rum_crash 1925

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

1.4.7.3. opsb_rum_event 1927

1.4.7.4. opsb_rum_page 1929

1.4.7.5. opsb_rum_request 1932

1.4.7.6. opsb_rum_session 1933

1.4.7.7. opsb_rum_tcp 1935

1.4.7.8. opsb_rum_trans 1937

1.4.7.9. opsb_rum_page_1d 1939

1.4.7.10. opsb_rum_page_1h 1943

1.4.7.11. opsb_rum_action_1d 1947

1.4.7.12. opsb_rum_action_1h 1951

1.4.7.13. opsb_rum_request_1d 1955

1.4.7.14. opsb_rum_request_1h 1958

1.4.7.15. opsb_rum_session_1d 1961

1.4.7.16. opsb_rum_session_1h 1965

1.4.7.17. opsb_rum_tcp_1d 1969

1.4.7.18. opsb_rum_tcp_1h 1977

1.4.7.19. opsb_rum_trans_1d 1985

1.4.7.20. opsb_rum_trans_1h 1988

1.4.8. Synthetic Transaction 1991

1.4.8.1. opsb_synthetic_trans 1992

1.4.8.2. opsb_synthetic_trans_components 1995

1.4.8.3. opsb_synthetic_trans_errors 1997

1.4.8.4. opsb_synthetic_trans_trc_hop 1999

1.4.8.5. opsb_synthetic_trans_trc_path 2000

1.4.8.6. opsb_synthetic_trans_1d 2001

1.4.8.7. opsb_synthetic_trans_1h 2008

1.4.8.8. opsb_synthetic_trans_components_1d 2015

1.4.8.9. opsb_synthetic_trans_components_1h 2019

1.4.8.10. opsb_synthetic_trans_errors_1d 2023

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

1.4.8.11. opsb_synthetic_trans_errors_1h 2024

1.4.8.12. opsb_synthetic_trans_trc_hop_1d 2025

1.4.8.13. opsb_synthetic_trans_trc_hop_1h 2026

1.4.8.14. opsb_synthetic_trans_trc_path_1d 2027

1.4.8.15. opsb_synthetic_trans_trc_path_1h 2029

1.4.9. Enterprise Management Systems 2031

1.4.9.1. VMware vRealize Operations Manager 2033

1.4.9.1.1. opsb_vrops_cluster_badge_v2_1d 2034

1.4.9.1.2. opsb_vrops_cluster_cpu_v2_1d 2035

1.4.9.1.3. opsb_vrops_cluster_disk_v2_1d 2037

1.4.9.1.4. opsb_vrops_cluster_memory_v2_1d 2039

1.4.9.1.5. opsb_vrops_cluster_nw_v2_1d 2041

1.4.9.1.6. opsb_vrops_cluster_summ_v2_1d 2042

1.4.9.1.7. opsb_vrops_datacenter_badge_v2_1d 2044

1.4.9.1.8. opsb_vrops_datacenter_cpu_v2_1d 2045

1.4.9.1.9. opsb_vrops_datacenter_disk_v2_1d 2047

1.4.9.1.10. opsb_vrops_datacenter_memory_v2_1d 2049

1.4.9.1.11. opsb_vrops_datacenter_nw_v2_1d 2051

1.4.9.1.12. opsb_vrops_datacenter_summ_v2_1d 2052

1.4.9.1.13. opsb_vrops_datastore_v2_1d 2054

1.4.9.1.14. opsb_vrops_host_badge_v2_1d 2055

1.4.9.1.15. opsb_vrops_host_cpu_v2_1d 2056

1.4.9.1.16. opsb_vrops_host_disk_v2_1d 2058

1.4.9.1.17. opsb_vrops_host_memory_v2_1d 2060

1.4.9.1.18. opsb_vrops_host_nw_v2_1d 2062

1.4.9.1.19. opsb_vrops_host_summ_v2_1d 2064

1.4.9.1.20. opsb_vrops_system_v2_1d 2066

1.4.9.1.21. opsb_vrops_vcenter_cpu_v2_1d 2068

1.4.9.1.22. opsb_vrops_vcenter_disk_v2_1d 2070

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

1.4.9.1.23. opsb_vrops_vcenter_memory_v2_1d 2072

1.4.9.1.24. opsb_vrops_vcenter_nw_v2_1d 2074

1.4.9.1.25. opsb_vrops_vm_badge_v2_1d 2075

1.4.9.1.26. opsb_vrops_vm_cpu_v2_1d 2076

1.4.9.1.27. opsb_vrops_vm_disk_v2_1d 2078

1.4.9.1.28. opsb_vrops_vm_memory_v2_1d 2080

1.4.9.1.29. opsb_vrops_vm_nw_v2_1d 2082

1.4.9.1.30. opsb_vrops_vm_summ_v2_1d 2084

1.4.9.1.31. opsb_vrops_cluster_badge_v2_1h 2085

1.4.9.1.32. opsb_vrops_cluster_cpu_v2_1h 2086

1.4.9.1.33. opsb_vrops_cluster_disk_v2_1h 2088

1.4.9.1.34. opsb_vrops_cluster_memory_v2_1h 2090

1.4.9.1.35. opsb_vrops_cluster_nw_v2_1h 2092

1.4.9.1.36. opsb_vrops_cluster_summ_v2_1h 2093

1.4.9.1.37. opsb_vrops_datacenter_badge_v2_1h 2095

1.4.9.1.38. opsb_vrops_datacenter_cpu_v2_1h 2096

1.4.9.1.39. opsb_vrops_datacenter_disk_v2_1h 2098

1.4.9.1.40. opsb_vrops_datacenter_memory_v2_1h 2100

1.4.9.1.41. opsb_vrops_datacenter_nw_v2_1h 2102

1.4.9.1.42. opsb_vrops_datacenter_summ_v2_1h 2103

1.4.9.1.43. opsb_vrops_datastore_v2_1h 2105

1.4.9.1.44. opsb_vrops_host_badge_v2_1h 2106

1.4.9.1.45. opsb_vrops_host_cpu_v2_1h 2107

1.4.9.1.46. opsb_vrops_host_disk_v2_1h 2109

1.4.9.1.47. opsb_vrops_host_memory_v2_1h 2111

1.4.9.1.48. opsb_vrops_host_nw_v2_1h 2113

1.4.9.1.49. opsb_vrops_host_summ_v2_1h 2115

1.4.9.1.50. opsb_vrops_system_v2_1h 2117

1.4.9.1.51. opsb_vrops_vcenter_cpu_v2_1h 2119

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

1.4.9.1.52. opsb_vrops_vcenter_disk_v2_1h 2121

1.4.9.1.53. opsb_vrops_vcenter_memory_v2_1h 2123

1.4.9.1.54. opsb_vrops_vcenter_nw_v2_1h 2125

1.4.9.1.55. opsb_vrops_vm_badge_v2_1h 2126

1.4.9.1.56. opsb_vrops_vm_cpu_v2_1h 2127

1.4.9.1.57. opsb_vrops_vm_disk_v2_1h 2129

1.4.9.1.58. opsb_vrops_vm_memory_v2_1h 2131

1.4.9.1.59. opsb_vrops_vm_nw_v2_1h 2133

1.4.9.1.60. opsb_vrops_vm_summ_v2_1h 2135

1.4.9.1.61. opsb_vrops_cluster_badge_v2 2136

1.4.9.1.62. opsb_vrops_cluster_cpu_v2 2137

1.4.9.1.63. opsb_vrops_cluster_disk_v2 2139

1.4.9.1.64. opsb_vrops_cluster_memory_v2 2141

1.4.9.1.65. opsb_vrops_cluster_nw_v2 2143

1.4.9.1.66. opsb_vrops_cluster_summ_v2 2144

1.4.9.1.67. opsb_vrops_datacenter_badge_v2 2145

1.4.9.1.68. opsb_vrops_datacenter_cpu_v2 2146

1.4.9.1.69. opsb_vrops_datacenter_disk_v2 2148

1.4.9.1.70. opsb_vrops_datacenter_memory_v2 2149

1.4.9.1.71. opsb_vrops_datacenter_nw_v2 2151

1.4.9.1.72. opsb_vrops_datacenter_summ_v2 2152

1.4.9.1.73. opsb_vrops_datastore_v2 2153

1.4.9.1.74. opsb_vrops_host_badge_v2 2154

1.4.9.1.75. opsb_vrops_host_cpu_v2 2155

1.4.9.1.76. opsb_vrops_host_disk_v2 2157

1.4.9.1.77. opsb_vrops_host_memory_v2 2159

1.4.9.1.78. opsb_vrops_host_nw_v2 2161

1.4.9.1.79. opsb_vrops_host_summ_v2 2162

1.4.9.1.80. opsb_vrops_system_v2 2163

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

1.4.9.1.81. opsb_vrops_vcenter_cpu_v2 2164

1.4.9.1.82. opsb_vrops_vcenter_disk_v2 2165

1.4.9.1.83. opsb_vrops_vcenter_memory_v2 2166

1.4.9.1.84. opsb_vrops_vcenter_nw_v2 2167

1.4.9.1.85. opsb_vrops_vm_badge_v2 2168

1.4.9.1.86. opsb_vrops_vm_cpu_v2 2169

1.4.9.1.87. opsb_vrops_vm_disk_v2 2171

1.4.9.1.88. opsb_vrops_vm_memory_v2 2173

1.4.9.1.89. opsb_vrops_vm_nw_v2 2175

1.4.9.1.90. opsb_vrops_vm_summ_v2 2176

1.4.9.2. System Center Operations Manager 2177

1.4.9.2.1. opsb_scom_avail 2178

1.4.9.2.2. opsb_scom_disk 2179

1.4.9.2.3. opsb_scom_dns_server 2181

1.4.9.2.4. opsb_scom_exchange_server 2183

1.4.9.2.5. opsb_scom_network_adapter 2185

1.4.9.2.6. opsb_scom_node 2186

1.4.9.2.7. opsb_scom_processor 2188

1.4.9.2.8. opsb_scom_sql_avail_replica 2189

1.4.9.2.9. opsb_scom_sql_availability_replica 2190

1.4.9.2.10. opsb_scom_sql_container 2191

1.4.9.2.11. opsb_scom_sql_db 2192

1.4.9.2.12. opsb_scom_sql_db_engine 2194

1.4.9.2.13. opsb_scom_sql_resource_pool 2196

1.4.9.2.14. opsb_scom_avail_1d 2197

1.4.9.2.15. opsb_scom_disk_1d 2198

1.4.9.2.16. opsb_scom_dns_server_1d 2201

1.4.9.2.17. opsb_scom_exchange_server_1d 2205

1.4.9.2.18. opsb_scom_network_adapter_1d 2210

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

1.4.9.2.19. opsb_scom_node_1d 2212

1.4.9.2.20. opsb_scom_processor_1d 2217

1.4.9.2.21. opsb_scom_sql_avail_replica_1d 2219

1.4.9.2.22. opsb_scom_sql_container_1d 2222

1.4.9.2.23. opsb_scom_sql_db_1d 2224

1.4.9.2.24. opsb_scom_sql_db_engine_1d 2228

1.4.9.2.25. opsb_scom_sql_resource_pool_1d 2233

1.4.9.2.26. opsb_scom_avail_1h 2236

1.4.9.2.27. opsb_scom_disk_1h 2237

1.4.9.2.28. opsb_scom_dns_server_1h 2240

1.4.9.2.29. opsb_scom_exchange_server_1h 2244

1.4.9.2.30. opsb_scom_network_adapter_1h 2249

1.4.9.2.31. opsb_scom_node_1h 2251

1.4.9.2.32. opsb_scom_processor_1h 2256

1.4.9.2.33. opsb_scom_sql_avail_replica_1h 2258

1.4.9.2.34. opsb_scom_sql_container_1h 2261

1.4.9.2.35. opsb_scom_sql_db_1h 2263

1.4.9.2.36. opsb_scom_sql_db_engine_1h 2267

1.4.9.2.37. opsb_scom_sql_resource_pool_1h 2272

1.4.9.3. OneView Connector 2275

1.4.9.3.1. opsb_oneview_enclosures 2276

1.4.9.3.2. opsb_oneview_enclosures_1d 2277

1.4.9.3.3. opsb_oneview_enclosures_1h 2279

1.4.9.3.4. opsb_oneview_interconnects 2281

1.4.9.3.5. opsb_oneview_interconnects_1d 2282

1.4.9.3.6. opsb_oneview_interconnects_1h 2284

1.4.9.3.7. opsb_oneview_server_hardware 2286

1.4.9.3.8. opsb_oneview_server_hardware_1d 2287

1.4.9.3.9. opsb_oneview_server_hardware_1h 2289

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

1.4.10. Operations Bridge Integration Hub applications 2291

1.4.10.1. Operations Bridge Integration for AppDynamics 2292

1.4.10.1.1. opsb_ext_appdynamics_application_raw 2293

1.4.10.1.2. opsb_ext_appdynamics_disk_raw 2294

1.4.10.1.3. opsb_ext_appdynamics_netif_raw 2295

1.4.10.1.4. opsb_ext_appdynamics_node_raw 2296

1.4.10.1.5. opsb_ext_appdynamics_application_1h 2297

1.4.10.1.6. opsb_ext_appdynamics_disk_1h 2300

1.4.10.1.7. opsb_ext_appdynamics_netif_1h 2302

1.4.10.1.8. opsb_ext_appdynamics_node_1h 2304

1.4.10.1.9. opsb_ext_appdynamics_application_1d 2306

1.4.10.1.10. opsb_ext_appdynamics_disk_1d 2309

1.4.10.1.11. opsb_ext_appdynamics_netif_1d 2311

1.4.10.1.12. opsb_ext_appdynamics_node_1d 2313

1.4.10.2. Operations Bridge Integration for Datadog 2315

1.4.10.2.1. opsb_ext_datadog_host_raw 2316

1.4.10.2.2. opsb_ext_datadog_host_1h 2318

1.4.10.2.3. opsb_ext_datadog_host_1d 2322

1.4.10.3. Operations Bridge Integration for Dynatrace 2326

1.4.10.3.1. opsb_ext_dynatrace_app_browser_raw 2327

1.4.10.3.2. opsb_ext_dynatrace_app_user_type_raw 2328

1.4.10.3.3. opsb_ext_dynatrace_disk_raw 2329

1.4.10.3.4. opsb_ext_dynatrace_host_raw 2330

1.4.10.3.5. opsb_ext_dynatrace_netif_raw 2331

1.4.10.3.6. opsb_ext_dynatrace_service_raw 2333

1.4.10.3.7. opsb_ext_dynatrace_app_browser_1h 2335

1.4.10.3.8. opsb_ext_dynatrace_disk_1h 2337

1.4.10.3.9. opsb_ext_dynatrace_disk_1h 2339

1.4.10.3.10. opsb_ext_dynatrace_host_1h 2341

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

1.4.10.3.11. opsb_ext_dynatrace_netif_1h 2343

1.4.10.3.12. opsb_ext_dynatrace_service_1h 2346

1.4.10.3.13. opsb_ext_dynatrace_app_browser_1d 2350

1.4.10.3.14. opsb_ext_dynatrace_app_user_type_1d 2352

1.4.10.3.15. opsb_ext_dynatrace_disk_1d 2354

1.4.10.3.16. opsb_ext_dynatrace_host_1d 2356

1.4.10.3.17. opsb_ext_dynatrace_netif_1d 2358

1.4.10.3.18. opsb_ext_dynatrace_service_1d 2361

1.4.10.4. Operations Bridge Integration for New Relic 2366

1.4.10.4.1. opsb_ext_newrelic_app_raw 2367

1.4.10.4.2. opsb_ext_newrelic_app_host_raw 2369

1.4.10.4.3. opsb_ext_newrelic_app_1h 2371

1.4.10.4.4. opsb_ext_newrelic_app_host_1h 2376

1.4.10.4.5. opsb_ext_newrelic_app_1d 2379

1.4.10.4.6. opsb_ext_newrelic_app_host_1d 2384

1.4.10.5. Operations Bridge Integration for SolarWinds 2387

1.4.10.5.1. opsb_ext_solarwinds_cluster_raw 2388

1.4.10.5.2. opsb_ext_solarwinds_esxi_raw 2389

1.4.10.5.3. opsb_ext_solarwinds_host_raw 2390

1.4.10.5.4. opsb_ext_solarwinds_vm_raw 2391

1.4.10.5.5. opsb_ext_solarwinds_cluster_1h 2392

1.4.10.5.6. opsb_ext_solarwinds_esxi_1h 2393

1.4.10.5.7. opsb_ext_solarwinds_host_1h 2395

1.4.10.5.8. opsb_ext_solarwinds_vm_1h 2397

1.4.10.5.9. opsb_ext_solarwinds_cluster_1d 2399

1.4.10.5.10. opsb_ext_solarwinds_esxi_1d 2400

1.4.10.5.11. opsb_ext_solarwinds_host_1d 2402

1.4.10.5.12. opsb_ext_solarwinds_vm_1d 2404

1.4.11. CMDB 2406

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

1.4.11.1. Entity configurations 2407

1.4.11.1.1. cmdb_entity_abap_sap_central_services_latest 2409

1.4.11.1.2. cmdb_entity_activedirectory_latest 2411

1.4.11.1.3. cmdb_entity_adam_latest 2412

1.4.11.1.4. cmdb_entity_applicationresource_latest 2414

1.4.11.1.5. cmdb_entity_application_server_latest 2418

1.4.11.1.6. cmdb_entity_business_element_latest 2420

1.4.11.1.7. cmdb_entity_ci_collection_latest 2421

1.4.11.1.8. cmdb_entity_cluster_software_latest 2422

1.4.11.1.9. cmdb_entity_configuration_item_latest 2424

1.4.11.1.10. cmdb_entity_database_latest 2425

1.4.11.1.11. cmdb_entity_directory_server_latest 2427

1.4.11.1.12. cmdb_entity_domaincontroller_latest 2429

1.4.11.1.13. cmdb_entity_exchangesystem_latest 2431

1.4.11.1.14. cmdb_entity_failover_cluster_latest 2432

1.4.11.1.15. cmdb_entity_hypervisor_latest 2433

1.4.11.1.16. cmdb_entity_j2eecluster_latest 2435

1.4.11.1.17. cmdb_entity_j2eedomain_latest 2436

1.4.11.1.18. cmdb_entity_j2eeserver_latest 2437

1.4.11.1.19. cmdb_entity_loadbalancecluster_latest 2439

1.4.11.1.20. cmdb_entity_location_latest 2440

1.4.11.1.21. cmdb_entity_mail_server_latest 2442

1.4.11.1.22. cmdb_entity_ms_exchange_server_latest 2444

1.4.11.1.23. cmdb_entity_network_entity_latest 2446

1.4.11.1.24. cmdb_entity_node_latest 2448

1.4.11.1.25. cmdb_entity_node_element_latest 2451

1.4.11.1.26. cmdb_entity_running_software_latest 2454

1.4.11.1.27. cmdb_entity_sap_app_server_latest 2456

1.4.11.1.28. cmdb_entity_sap_its_agate_latest 2458

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.11.1.29. cmdb_entity_sap_r3_server_latest 2460

1.4.11.1.30. cmdb_entity_sap_system_latest 2462

1.4.11.1.31. cmdb_entity_vmware_cluster_latest 2464

1.4.11.1.32. cmdb_entity_vmware_virtual_center_latest 2466

1.4.11.1.33. cmdb_entity_web_server_latest 2468

1.4.11.1.34. cmdb_entity_relation_cicollection_ci_latest 2470

1.4.11.1.35. cmdb_entity_relation_location_ci_latest 2471

1.4.11.1.36. cmdb_entity_relation_businesselement_ci_latest 2472

1.4.11.1.37. cmdb_entity_relation_node_ci_latest 2473

1.4.11.1.38. cmdb_ext_entity_applicationresource_raw 2474

1.4.11.1.39. cmdb_ext_entity_application_system_raw 2475

1.4.11.1.40. cmdb_ext_entity_business_element_raw 2476

1.4.11.1.41. cmdb_ext_entity_ci_collection_raw 2477

1.4.11.1.42. cmdb_ext_entity_configuration_item_raw 2478

1.4.11.1.43. cmdb_ext_entity_location_raw 2479

1.4.11.1.44. cmdb_ext_entity_network_entity_raw 2480

1.4.11.1.45. cmdb_ext_entity_node_element_raw 2481

1.4.11.1.46. cmdb_ext_entity_node_raw 2482

1.4.11.1.47. cmdb_ext_entity_running_software_raw 2483

1.4.12. Carbon Footprint 2484

1.4.12.1. ghg_activity 2485

1.4.12.2. ghg_calculation_model 2486

1.4.12.3. ghg_statement_1d 2487

1.4.13. Hyperscale Observability 2488

1.4.13.1. Mapping actual metric names with column names in the schema table 2489

1.4.13.2. Hyperscale Observability for AWS 2490

1.4.13.2.1. cloud_aws_application_elb 2493

1.4.13.2.2. cloud_aws_asg 2500

1.4.13.2.3. cloud_aws_athena 2503

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

1.4.13.2.4. cloud_aws_billing_service 2505

1.4.13.2.5. cloud_aws_certificate_manager 2506

1.4.13.2.6. cloud_aws_classic_elb 2508

1.4.13.2.7. cloud_aws_cloudfront_distribution 2513

1.4.13.2.8. cloud_aws_cloudfront_distribution_function 2515

1.4.13.2.9. cloud_aws_cwagent_linux 2516

1.4.13.2.10. cloud_aws_cwagent_windows 2526

1.4.13.2.11. cloud_aws_dc_connection 2535

1.4.13.2.12. cloud_aws_dc_optical_lane_num 2538

1.4.13.2.13. cloud_aws_dc_virtual_interface 2540

1.4.13.2.14. cloud_aws_dynamodb_account 2542

1.4.13.2.15. cloud_aws_dynamodb_index 2544

1.4.13.2.16. cloud_aws_dynamodb_operation 2548

1.4.13.2.17. cloud_aws_dynamodb_table 2550

1.4.13.2.18. cloud_aws_ebs 2554

1.4.13.2.19. cloud_aws_ec2 2559

1.4.13.2.20. cloud_aws_ec2_avail_status 2567

1.4.13.2.21. cloud_aws_ecr 2568

1.4.13.2.22. cloud_aws_ecs_cluster 2570

1.4.13.2.23. cloud_aws_ecs_instance 2579

1.4.13.2.24. cloud_aws_ecs_service 2583

1.4.13.2.25. cloud_aws_ecs_task_definition 2587

1.4.13.2.26. cloud_aws_efs_filereplication 2590

1.4.13.2.27. cloud_aws_efs_filesystem 2591

1.4.13.2.28. cloud_aws_efs_filestorage 2594

1.4.13.2.29. cloud_aws_eks_cluster 2595

1.4.13.2.30. cloud_aws_eks_namespace 2603

1.4.13.2.31. cloud_aws_eks_node 2606

1.4.13.2.32. cloud_aws_eks_pod 2610

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

1.4.13.2.33. cloud_aws_eks_service 2614

1.4.13.2.34. cloud_aws_elastic_beanstalk_env 2617

1.4.13.2.35. cloud_aws_elastic_beanstalk_instance 2621

1.4.13.2.36. cloud_aws_elasticache_node 2625

1.4.13.2.37. cloud_aws_elasticache_replication_grp 2638

1.4.13.2.38. cloud_aws_elasticache_replication_grp_role 2641

1.4.13.2.39. cloud_aws_gateway_elb 2643

1.4.13.2.40. cloud_aws_glue 2645

1.4.13.2.41. cloud_aws_kms 2653

1.4.13.2.42. cloud_aws_lambda 2655

1.4.13.2.43. cloud_aws_lambda_version 2660

1.4.13.2.44. cloud_aws_network_elb 2662

1.4.13.2.45. cloud_aws_network_elb_target_group 2667

1.4.13.2.46. cloud_aws_qldb 2668

1.4.13.2.47. cloud_aws_qldb_command_type 2671

1.4.13.2.48. cloud_aws_qldb_stream 2672

1.4.13.2.49. cloud_aws_rds 2673

1.4.13.2.50. cloud_aws_rds_aurora_dbcluster 2678

1.4.13.2.51. cloud_aws_rds_aurora_dbcluster_engine 2717

1.4.13.2.52. cloud_aws_rds_aurora_dbcluster_role 2721

1.4.13.2.53. cloud_aws_rds_aurora_dbinstance 2766

1.4.13.2.54. cloud_aws_rds_cluster 2804

1.4.13.2.55. cloud_aws_redshift_cluster 2806

1.4.13.2.56. cloud_aws_redshift_dbschema 2811

1.4.13.2.57. cloud_aws_redshift_latency 2813

1.4.13.2.58. cloud_aws_redshift_node 2815

1.4.13.2.59. cloud_aws_redshift_node_latency 2818

1.4.13.2.60. cloud_aws_redshift_node_stage 2819

1.4.13.2.61. cloud_aws_redshift_node_wlm 2820

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

1.4.13.2.62. cloud_aws_redshift_queuename 2822

1.4.13.2.63. cloud_aws_redshift_queuepriority 2824

1.4.13.2.64. cloud_aws_redshift_serviceclass 2825

1.4.13.2.65. cloud_aws_redshift_stage 2826

1.4.13.2.66. cloud_aws_redshift_wlm 2827

1.4.13.2.67. cloud_aws_route53_firewall_domain 2829

1.4.13.2.68. cloud_aws_route53_firewall_rule_group 2830

1.4.13.2.69. cloud_aws_route53_health_check 2832

1.4.13.2.70. cloud_aws_route53_hosted_zone 2835

1.4.13.2.71. cloud_aws_route53_rslvr_account 2838

1.4.13.2.72. cloud_aws_route53_rslvr_endpoint 2839

1.4.13.2.73. cloud_aws_s3_replication 2841

1.4.13.2.74. cloud_aws_s3_request 2843

1.4.13.2.75. cloud_aws_s3_storage 2848

1.4.13.2.76. cloud_aws_sns 2850

1.4.13.2.77. cloud_aws_sqs 2854

1.4.13.2.78. cloud_aws_vpc_nat_gateway 2858

1.4.13.2.79. cloud_aws_vpc_tgw_attachment 2861

1.4.13.2.80. cloud_aws_vpc_transit_gateway 2864

1.4.13.2.81. cloud_aws_vpn_tunnel 2866

1.4.13.2.82. cloud_aws_vpn_tunnel_account 2868

1.4.13.2.83. cloud_aws_vpn_tunnel_ipaddress 2870

1.4.13.2.84. cloud_aws_application_elb_baseline 2872

1.4.13.2.85. cloud_aws_classic_elb_baseline 2876

1.4.13.2.86. cloud_aws_ebs_baseline 2879

1.4.13.2.87. cloud_aws_ec2_baseline 2883

1.4.13.2.88. cloud_aws_gateway_elb_baseline 2887

1.4.13.2.89. cloud_aws_network_elb_baseline 2889

1.4.13.2.90. cloud_aws_rds_baseline 2891

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

1.4.13.2.91. cloud_aws_s3_replication_baseline 2896

1.4.13.2.92. cloud_aws_s3_request_baseline 2898

1.4.13.2.93. cloud_aws_sns_baseline 2901

1.4.13.2.94. cloud_aws_sqs_baseline 2904

1.4.13.2.95. cloud_aws_application_elb_1h 2907

1.4.13.2.96. cloud_aws_asg_1h 2919

1.4.13.2.97. cloud_aws_athena_1h 2925

1.4.13.2.98. cloud_aws_billing_service_1h 2928

1.4.13.2.99. cloud_aws_certificate_manager_1h 2929

1.4.13.2.100. cloud_aws_classic_elb_1h 2931

1.4.13.2.101. cloud_aws_cloudfront_distribution_1h 2937

1.4.13.2.102. cloud_aws_cloudfront_distribution_function_1h 2941

1.4.13.2.103. cloud_aws_cwagent_linux_1h 2943

1.4.13.2.104. cloud_aws_cwagent_windows_1h 2962

1.4.13.2.105. cloud_aws_dc_connection_1h 2977

1.4.13.2.106. cloud_aws_dc_optical_lane_num_1h 2981

1.4.13.2.107. cloud_aws_dc_virtual_interface_1h 2983

1.4.13.2.108. cloud_aws_dynamodb_account_1h 2986

1.4.13.2.109. cloud_aws_dynamodb_index_1h 2988

1.4.13.2.110. cloud_aws_dynamodb_operation_1h 2994

1.4.13.2.111. cloud_aws_dynamodb_table_1h 2998

1.4.13.2.112. cloud_aws_ebs_1h 3006

1.4.13.2.113. cloud_aws_ec2_1h 3014

1.4.13.2.114. cloud_aws_ec2_avail_status_1h 3028

1.4.13.2.115. cloud_aws_ecr_1h 3029

1.4.13.2.116. cloud_aws_ecs_cluster_1h 3031

1.4.13.2.117. cloud_aws_ecs_instance_1h 3044

1.4.13.2.118. cloud_aws_ecs_service_1h 3048

1.4.13.2.119. cloud_aws_ecs_task_definition_1h 3055

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

1.4.13.2.120. cloud_aws_efs_filereplication_1h 3060

1.4.13.2.121. cloud_aws_efs_filesystem_1h 3065

1.4.13.2.122. cloud_aws_efs_filestorage_1h 3070

1.4.13.2.123. cloud_aws_eks_cluster_1h 3072

1.4.13.2.124. cloud_aws_eks_namespace_1h 3084

1.4.13.2.125. cloud_aws_eks_node_1h 3088

1.4.13.2.126. cloud_aws_eks_pod_1h 3093

1.4.13.2.127. cloud_aws_eks_service_1h 3098

1.4.13.2.128. cloud_aws_elastic_beanstalk_env_1h 3102

1.4.13.2.129. cloud_aws_elastic_beanstalk_instance_1h 3109

1.4.13.2.130. cloud_aws_elasticache_node_1h 3117

1.4.13.2.131. cloud_aws_elasticache_replication_grp_1h 3125

1.4.13.2.132. cloud_aws_elasticache_replication_grp_role_1h 3127

1.4.13.2.133. cloud_aws_gateway_elb_1h 3129

1.4.13.2.134. cloud_aws_glue_1h 3132

1.4.13.2.135. cloud_aws_kms_1h 3139

1.4.13.2.136. cloud_aws_lambda_1h 3141

1.4.13.2.137. cloud_aws_lambda_version_1h 3149

1.4.13.2.138. cloud_aws_network_elb_1h 3152

1.4.13.2.139. cloud_aws_network_elb_target_group_1h 3161

1.4.13.2.140. cloud_aws_qldb_1h 3163

1.4.13.2.141. cloud_aws_qldb_command_type_1h 3167

1.4.13.2.142. cloud_aws_qldb_stream_1h 3168

1.4.13.2.143. cloud_aws_rds_1h 3169

1.4.13.2.144. cloud_aws_rds_aurora_dbcluster_1h 3178

1.4.13.2.145. cloud_aws_rds_aurora_dbcluster_engine_1h 3210

1.4.13.2.146. cloud_aws_rds_aurora_dbcluster_role_1h 3215

1.4.13.2.147. cloud_aws_rds_aurora_dbinstance_1h 3243

1.4.13.2.148. cloud_aws_rds_cluster_1h 3273

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

1.4.13.2.149. cloud_aws_redshift_cluster_1h 3275

1.4.13.2.150. cloud_aws_redshift_dbschema_1h 3283

1.4.13.2.151. cloud_aws_redshift_latency_1h 3285

1.4.13.2.153. cloud_aws_redshift_node_1h 3287

1.4.13.2.153. cloud_aws_redshift_node_1h 3291

1.4.13.2.154. cloud_aws_redshift_node_latency_1h 3295

1.4.13.2.155. cloud_aws_redshift_node_stage_1h 3296

1.4.13.2.156. cloud_aws_redshift_node_wlm_1h 3298

1.4.13.2.158. cloud_aws_redshift_queuename_1h 3300

1.4.13.2.158. cloud_aws_redshift_queuename_1h 3303

1.4.13.2.159. cloud_aws_redshift_queuepriority_1h 3306

1.4.13.2.160. cloud_aws_redshift_serviceclass_1h 3307

1.4.13.2.161. cloud_aws_redshift_stage_1h 3309

1.4.13.2.162. cloud_aws_redshift_wlm_1h 3311

1.4.13.2.163. cloud_aws_route53_firewall_domain_1h 3314

1.4.13.2.164. cloud_aws_route53_firewall_rule_group_1h 3316

1.4.13.2.165. cloud_aws_route53_health_check_1h 3318

1.4.13.2.166. cloud_aws_route53_hosted_zone_1h 3321

1.4.13.2.167. cloud_aws_route53_rslvr_account_1h 3324

1.4.13.2.168. cloud_aws_route53_rslvr_endpoint_1h 3326

1.4.13.2.169. cloud_aws_s3_replication_1h 3328

1.4.13.2.170. cloud_aws_s3_request_1h 3330

1.4.13.2.171. cloud_aws_s3_storage_1h 3340

1.4.13.2.172. cloud_aws_schedule_config_1h 3342

1.4.13.2.173. cloud_aws_sns_1h 3343

1.4.13.2.174. cloud_aws_sqs_1h 3350

1.4.13.2.175. cloud_aws_vpc_nat_gateway_1h 3356

1.4.13.2.176. cloud_aws_vpc_tgw_attachment_1h 3363

1.4.13.2.177. cloud_aws_vpc_transit_gateway_1h 3367

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

1.4.13.2.178. cloud_aws_vpn_tunnel_1h 3371

1.4.13.2.179. cloud_aws_vpn_tunnel_account_1h 3373

1.4.13.2.180. cloud_aws_vpn_tunnel_ipaddress_1h 3375

1.4.13.2.181. cloud_aws_application_elb_baseline_1h 3377

1.4.13.2.182. cloud_aws_classic_elb_baseline_1h 3381

1.4.13.2.183. cloud_aws_ebs_baseline_1h 3384

1.4.13.2.184. cloud_aws_ec2_baseline_1h 3388

1.4.13.2.185. cloud_aws_gateway_elb_baseline_1h 3392

1.4.13.2.186. cloud_aws_network_elb_baseline_1h 3394

1.4.13.2.187. cloud_aws_rds_baseline_1h 3396

1.4.13.2.188. cloud_aws_s3_replication_baseline_1h 3402

1.4.13.2.189. cloud_aws_s3_request_baseline_1h 3404

1.4.13.2.190. cloud_aws_sns_baseline_1h 3407

1.4.13.2.191. cloud_aws_sqs_baseline_1h 3410

1.4.13.2.192. cloud_aws_application_elb_1d 3413

1.4.13.2.193. cloud_aws_asg_1d 3416

1.4.13.2.194. cloud_aws_athena_1d 3422

1.4.13.2.195. cloud_aws_billing_service_1d 3425

1.4.13.2.196. cloud_aws_certificate_manager_1d 3426

1.4.13.2.197. cloud_aws_classic_elb_1d 3428

1.4.13.2.198. cloud_aws_cloudfront_distribution_1d 3434

1.4.13.2.199. cloud_aws_cloudfront_distribution_function_1d 3438

1.4.13.2.200. cloud_aws_cwagent_linux_1d 3443

1.4.13.2.201. cloud_aws_cwagent_windows_1d 3462

1.4.13.2.202. cloud_aws_dc_connection_1d 3477

1.4.13.2.203. cloud_aws_dc_optical_lane_num_1d 3481

1.4.13.2.204. cloud_aws_dc_virtual_interface_1d 3483

1.4.13.2.205. cloud_aws_dynamodb_account_1d 3486

1.4.13.2.206. cloud_aws_dynamodb_index_1d 3488

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

1.4.13.2.207. cloud_aws_dynamodb_operation_1d 3494

1.4.13.2.208. cloud_aws_dynamodb_table_1d 3498

1.4.13.2.209. cloud_aws_ebs_1d 3506

1.4.13.2.210. cloud_aws_ec2_1d 3514

1.4.13.2.211. cloud_aws_ec2_avail_status_1d 3528

1.4.13.2.212. cloud_aws_ecr_1d 3529

1.4.13.2.213. cloud_aws_ecs_cluster_1d 3531

1.4.13.2.214. cloud_aws_ecs_instance_1d 3544

1.4.13.2.215. cloud_aws_ecs_service_1d 3548

1.4.13.2.216. cloud_aws_ecs_task_definition_1d 3555

1.4.13.2.217. cloud_aws_efs_filereplication_1d 3560

1.4.13.2.218. cloud_aws_efs_filesystem_1d 3561

1.4.13.2.219. cloud_aws_efs_filestorage_1d 3566

1.4.13.2.220. cloud_aws_eks_cluster_1d 3568

1.4.13.2.221. cloud_aws_eks_namespace_1d 3580

1.4.13.2.222. cloud_aws_eks_node_1d 3584

1.4.13.2.223. cloud_aws_eks_pod_1d 3589

1.4.13.2.224. cloud_aws_eks_service_1d 3594

1.4.13.2.225. cloud_aws_elastic_beanstalk_env_1d 3598

1.4.13.2.226. cloud_aws_elastic_beanstalk_instance_1d 3605

1.4.13.2.227. cloud_aws_elasticache_node_1d 3613

1.4.13.2.228. cloud_aws_elasticache_replication_grp_1d 3621

1.4.13.2.229. cloud_aws_elasticache_replication_grp_role_1d 3623

1.4.13.2.230. cloud_aws_gateway_elb_1d 3625

1.4.13.2.231. cloud_aws_glue_1d 3628

1.4.13.2.232. cloud_aws_kms_1d 3635

1.4.13.2.233. cloud_aws_lambda_1d 3637

1.4.13.2.234. cloud_aws_lambda_version_1d 3645

1.4.13.2.235. cloud_aws_network_elb_1d 3648

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

1.4.13.2.236. cloud_aws_network_elb_target_group_1d 3657

1.4.13.2.237. cloud_aws_qldb_1d 3666

1.4.13.2.238. cloud_aws_qldb_command_type_1d 3670

1.4.13.2.239. cloud_aws_qldb_stream_1d 3671

1.4.13.2.240. cloud_aws_rds_1d 3672

1.4.13.2.241. cloud_aws_rds_aurora_dbcluster_1d 3681

1.4.13.2.242. cloud_aws_rds_aurora_dbcluster_engine_1d 3713

1.4.13.2.243. cloud_aws_rds_aurora_dbcluster_role_1d 3718

1.4.13.2.244. cloud_aws_rds_aurora_dbinstance_1d 3746

1.4.13.2.245. cloud_aws_rds_cluster_1d 3776

1.4.13.2.246. cloud_aws_redshift_cluster_1d 3778

1.4.13.2.247. cloud_aws_redshift_dbschema_1d 3786

1.4.13.2.248. cloud_aws_redshift_latency_1d 3788

1.4.13.2.249. cloud_aws_redshift_node_1d 3790

1.4.13.2.250. cloud_aws_redshift_node_latency_1d 3794

1.4.13.2.251. cloud_aws_redshift_node_stage_1d 3795

1.4.13.2.252. cloud_aws_redshift_node_wlm_1d 3797

1.4.13.2.253. cloud_aws_redshift_queuename_1d 3799

1.4.13.2.254. cloud_aws_redshift_queuepriority_1d 3802

1.4.13.2.255. cloud_aws_redshift_serviceclass_1d 3803

1.4.13.2.256. cloud_aws_redshift_stage_1d 3805

1.4.13.2.257. cloud_aws_redshift_wlm_1d 3807

1.4.13.2.258. cloud_aws_route53_firewall_domain_1d 3810

1.4.13.2.259. cloud_aws_route53_firewall_rule_group_1d 3812

1.4.13.2.260. cloud_aws_route53_health_check_1d 3814

1.4.13.2.261. cloud_aws_route53_hosted_zone_1d 3817

1.4.13.2.262. cloud_aws_route53_rslvr_account_1d 3820

1.4.13.2.263. cloud_aws_route53_rslvr_endpoint_1d 3822

1.4.13.2.264. cloud_aws_s3_replication_1d 3825

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

1.4.13.2.265. cloud_aws_s3_request_1d 3827

1.4.13.2.266. cloud_aws_s3_storage_1d 3837

1.4.13.2.267. cloud_aws_schedule_config_1d 3839

1.4.13.2.268. cloud_aws_sns_1d 3840

1.4.13.2.269. cloud_aws_sqs_1d 3847

1.4.13.2.270. cloud_aws_vpc_nat_gateway_1d 3853

1.4.13.2.271. cloud_aws_vpc_tgw_attachment_1d 3860

1.4.13.2.272. cloud_aws_vpc_transit_gateway_1d 3864

1.4.13.2.273. cloud_aws_vpn_tunnel_1d 3868

1.4.13.2.274. cloud_aws_vpn_tunnel_account_1d 3870

1.4.13.2.275. cloud_aws_vpn_tunnel_ipaddress_1d 3872

1.4.13.2.276. cloud_aws_application_elb_baseline_1d 3874

1.4.13.2.277. cloud_aws_classic_elb_baseline_1d 3878

1.4.13.2.278. cloud_aws_ebs_baseline_1d 3881

1.4.13.2.279. cloud_aws_ec2_baseline_1d 3885

1.4.13.2.280. cloud_aws_gateway_elb_baseline_1d 3889

1.4.13.2.281. cloud_aws_network_elb_baseline_1d 3891

1.4.13.2.282. cloud_aws_rds_baseline_1d 3893

1.4.13.2.283. cloud_aws_s3_replication_baseline_1d 3899

1.4.13.2.284. cloud_aws_s3_request_baseline_1d 3901

1.4.13.2.285. cloud_aws_sns_baseline_1d 3904

1.4.13.2.286. cloud_aws_sqs_baseline_1d 3907

1.4.13.3. Hyperscale Observability for Azure 3910

1.4.13.3.1. cloud_azure_aks_cluster 3912

1.4.13.3.2. cloud_azure_aks_namespace 3914

1.4.13.3.3. cloud_azure_aks_node 3916

1.4.13.3.4. cloud_azure_aks_pod 3918

1.4.13.3.5. cloud_azure_aks_service 3920

1.4.13.3.6. cloud_azure_application_gateway 3922

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

1.4.13.3.7. cloud_azure_appservices 3924

1.4.13.3.8. cloud_azure_aspservices 3935

1.4.13.3.9. cloud_azure_container_registries 3941

1.4.13.3.10. cloud_azure_cosmosdb 3943

1.4.13.3.11. cloud_azure_datalakeanalytics 3953

1.4.13.3.12. cloud_azure_disk 3955

1.4.13.3.13. cloud_azure_eventhubs 3957

1.4.13.3.14. cloud_azure_eventhubsclusters 3960

1.4.13.3.15. cloud_azure_expressroutecircuits 3963

1.4.13.3.16. cloud_azure_expressroutedirect 3965

1.4.13.3.17. cloud_azure_frontdoors 3967

1.4.13.3.18. cloud_azure_guestos_linux 3970

1.4.13.3.19. cloud_azure_guestos_windows 3976

1.4.13.3.20. cloud_azure_load_balancer 3996

1.4.13.3.21. cloud_azure_postgresqlflexibleserver 3999

1.4.13.3.22. cloud_azure_postgresqlsingleserver 4002

1.4.13.3.23. cloud_azure_purview 4005

1.4.13.3.24. cloud_azure_rediscache 4007

1.4.13.3.25. cloud_azure_sql_database 4014

1.4.13.3.26. cloud_azure_sqlmanagedinstance 4018

1.4.13.3.27. cloud_azure_storage_accounts 4020

1.4.13.3.28. cloud_azure_synapse_dedicatedsqlpools 4026

1.4.13.3.29. cloud_azure_synapse_sparkpools 4031

1.4.13.3.30. cloud_azure_synapse_workspace 4033

1.4.13.3.31. cloud_azure_traffic_manager_profile 4038

1.4.13.3.32. cloud_azure_virtual_machine_scale_sets 4041

1.4.13.3.33. cloud_azure_virtual_machines 4052

1.4.13.3.34. cloud_azure_virtualnetworkgateways 4063

1.4.13.3.35. cloud_azure_virtual_machines_avail_status 4070

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

1.4.13.3.36. cloud_azure_virtualwan_expressroutegateways 4071

1.4.13.3.37. cloud_azure_virtualwan_ptosvpngateways 4074

1.4.13.3.38. cloud_azure_virtualwan_virtualhubs 4076

1.4.13.3.39. cloud_azure_virtualwan_vpngateways 4078

1.4.13.3.40. cloud_azure_aks_cluster_baseline 4084

1.4.13.3.41. cloud_azure_application_gateway_baseline 4086

1.4.13.3.42. cloud_azure_appservices_baseline 4089

1.4.13.3.43. cloud_azure_aspservices_baseline 4093

1.4.13.3.44. cloud_azure_cosmosdb_baseline 4097

1.4.13.3.45. cloud_azure_datalakeanalytics_baseline 4100

1.4.13.3.46. cloud_azure_disk_baseline 4102

1.4.13.3.47. cloud_azure_eventhubs_baseline 4104

1.4.13.3.48. cloud_azure_eventhubsclusters_baseline 4107

1.4.13.3.49. cloud_azure_expressroutecircuits_baseline 4110

1.4.13.3.50. cloud_azure_expressroutedirect_baseline 4112

1.4.13.3.51. cloud_azure_frontdoors_baseline 4114

1.4.13.3.52. cloud_azure_load_balancer_baseline 4117

1.4.13.3.53. cloud_azure_purview_baseline 4120

1.4.13.3.54. cloud_azure_rediscache_baseline 4122

1.4.13.3.55. cloud_azure_sql_database_baseline 4125

1.4.13.3.56. cloud_azure_storage_accounts_baseline 4128

1.4.13.3.57. cloud_azure_synapse_dedicatedsqlpools_baseline 4131

1.4.13.3.58. cloud_azure_synapse_workspace_baseline 4133

1.4.13.3.59. cloud_azure_virtual_machines_baseline 4136

1.4.13.3.60. cloud_azure_virtualnetworkgateways_baseline 4140

1.4.13.3.61. cloud_azure_virtualwan_ptosvpngateways_baseline 4145

1.4.13.3.62. cloud_azure_virtualwan_vpngateways_baseline 4147

1.4.13.3.63. cloud_azure_aks_cluster_1h 4149

1.4.13.3.64. cloud_azure_aks_namespace_1h 4155

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

1.4.13.3.65. cloud_azure_aks_node_1h 4157

1.4.13.3.66. cloud_azure_aks_pod_1h 4160

1.4.13.3.67. cloud_azure_aks_service_1h 4162

1.4.13.3.68. cloud_azure_application_gateway_1h 4164

1.4.13.3.69. cloud_azure_appservices_1h 4169

1.4.13.3.70. cloud_azure_aspservices_1h 4196

1.4.13.3.71. cloud_azure_container_registries_1h 4210

1.4.13.3.72. cloud_azure_cosmosdb_1h 4213

1.4.13.3.73. cloud_azure_datalakeanalytics_1h 4231

1.4.13.3.74. cloud_azure_disk_1h 4234

1.4.13.3.75. cloud_azure_eventhubs_1h 4236

1.4.13.3.76. cloud_azure_eventhubsclusters_1h 4244

1.4.13.3.77. cloud_azure_expressroutecircuits_1h 4252

1.4.13.3.78. cloud_azure_expressroutedirect_1h 4255

1.4.13.3.79. cloud_azure_frontdoors_1h 4257

1.4.13.3.80. cloud_azure_guestos_linux_1h 4261

1.4.13.3.81. cloud_azure_guestos_windows_1h 4271

1.4.13.3.82. cloud_azure_load_balancer_1h 4292

1.4.13.3.83. cloud_azure_postgresqlflexibleserver_1h 4298

1.4.13.3.84. cloud_azure_postgresqlsingleserver_1h 4303

1.4.13.3.85. cloud_azure_purview_1h 4307

1.4.13.3.86. cloud_azure_rediscache_1h 4309

1.4.13.3.87. cloud_azure_schedule_config_1h 4321

1.4.13.3.88. cloud_azure_sql_database_1h 4322

1.4.13.3.89. cloud_azure_sqlmanagedinstance_1h 4330

1.4.13.3.90. cloud_azure_storage_accounts_1h 4332

1.4.13.3.91. cloud_azure_synapse_dedicatedsqlpools_1h 4345

1.4.13.3.92. cloud_azure_synapse_sparkpools_1h 4352

1.4.13.3.93. cloud_azure_synapse_workspace_1h 4354

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

1.4.13.3.94. cloud_azure_traffic_manager_profile_1h 4361

1.4.13.3.95. cloud_azure_virtual_machine_scale_sets_1h 4364

1.4.13.3.96. cloud_azure_virtual_machines_1h 4381

1.4.13.3.97. cloud_azure_virtualnetworkgateways_1h 4397

1.4.13.3.98. cloud_azure_virtual_machines_avail_status_1h 4408

1.4.13.3.99. cloud_azure_virtualwan_expressroutegateways_1h 4409

1.4.13.3.100. cloud_azure_virtualwan_ptosvpngateways_1h 4412

1.4.13.3.101. cloud_azure_virtualwan_virtualhubs_1h 4415

1.4.13.3.102. cloud_azure_virtualwan_vpngateways_1h 4418

1.4.13.3.103. cloud_azure_aks_cluster_baseline_1h 4429

1.4.13.3.104. cloud_azure_application_gateway_baseline_1h 4431

1.4.13.3.105. cloud_azure_appservices_baseline_1h 4434

1.4.13.3.106. cloud_azure_aspservices_baseline_1h 4439

1.4.13.3.107. cloud_azure_cosmosdb_baseline_1h 4444

1.4.13.3.108. cloud_azure_datalakeanalytics_baseline_1h 4447

1.4.13.3.109. cloud_azure_disk_baseline_1h 4450

1.4.13.3.110. cloud_azure_eventhubs_baseline_1h 4452

1.4.13.3.111. cloud_azure_eventhubsclusters_baseline_1h 4455

1.4.13.3.112. cloud_azure_expressroutecircuits_baseline_1h 4458

1.4.13.3.113. cloud_azure_expressroutedirect_baseline_1h 4461

1.4.13.3.114. cloud_azure_frontdoors_baseline_1h 4464

1.4.13.3.115. cloud_azure_load_balancer_baseline_1h 4467

1.4.13.3.116. cloud_azure_purview_baseline_1h 4470

1.4.13.3.117. cloud_azure_rediscache_baseline_1h 4472

1.4.13.3.118. cloud_azure_sql_database_baseline_1h 4476

1.4.13.3.119. cloud_azure_storage_accounts_baseline_1h 4479

1.4.13.3.120. cloud_azure_synapse_dedicatedsqlpools_baseline_1h 4482

1.4.13.3.121. cloud_azure_synapse_workspace_baseline_1h 4485

1.4.13.3.122. cloud_azure_virtual_machines_baseline_1h 4488

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

1.4.13.3.123. cloud_azure_virtualnetworkgateways_baseline_1h 4493

1.4.13.3.124. cloud_azure_virtualwan_ptosvpngateways_baseline_1h 4499

1.4.13.3.125. cloud_azure_virtualwan_vpngateways_baseline_1h 4501

1.4.13.3.126. cloud_azure_aks_cluster_1d 4503

1.4.13.3.127. cloud_azure_aks_namespace_1d 4509

1.4.13.3.128. cloud_azure_aks_node_1d 4511

1.4.13.3.129. cloud_azure_aks_pod_1d 4514

1.4.13.3.130. cloud_azure_aks_service_1d 4516

1.4.13.3.131. cloud_azure_application_gateway_1d 4518

1.4.13.3.132. cloud_azure_appservices_1d 4523

1.4.13.3.133. cloud_azure_aspservices_1d 4550

1.4.13.3.134. cloud_azure_container_registries_1d 4564

1.4.13.3.135. cloud_azure_cosmosdb_1d 4567

1.4.13.3.136. cloud_azure_datalakeanalytics_1d 4585

1.4.13.3.137. cloud_azure_disk_1d 4588

1.4.13.3.138. cloud_azure_eventhubs_1d 4590

1.4.13.3.139. cloud_azure_eventhubsclusters_1d 4598

1.4.13.3.140. cloud_azure_expressroutecircuits_1d 4606

1.4.13.3.141. cloud_azure_expressroutedirect_1d 4609

1.4.13.3.142. cloud_azure_frontdoors_1d 4611

1.4.13.3.143. cloud_azure_guestos_linux_1d 4615

1.4.13.3.144. cloud_azure_guestos_windows_1d 4625

1.4.13.3.145. cloud_azure_load_balancer_1d 4646

1.4.13.3.146. cloud_azure_postgresqlflexibleserver_1d 4652

1.4.13.3.147. cloud_azure_postgresqlsingleserver_1d 4657

1.4.13.3.148. cloud_azure_purview_1d 4661

1.4.13.3.149. cloud_azure_rediscache_1d 4663

1.4.13.3.150. cloud_azure_schedule_config_1d 4672

1.4.13.3.151. cloud_azure_sql_database_1d 4673

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

1.4.13.3.152. cloud_azure_sqlmanagedinstance_1d 4681

1.4.13.3.153. cloud_azure_storage_accounts_1d 4683

1.4.13.3.154. cloud_azure_synapse_dedicatedsqlpools_1d 4696

1.4.13.3.155. cloud_azure_synapse_sparkpools_1d 4703

1.4.13.3.156. cloud_azure_synapse_workspace_1d 4705

1.4.13.3.157. cloud_azure_traffic_manager_profile_1d 4712

1.4.13.3.158. cloud_azure_virtual_machine_scale_sets_1d 4715

1.4.13.3.159. cloud_azure_virtual_machines_1d 4732

1.4.13.3.160. cloud_azure_virtualnetworkgateways_1d 4748

1.4.13.3.161. cloud_azure_virtual_machines_avail_status_1d 4760

1.4.13.3.162. cloud_azure_virtualwan_expressroutegateways_1d 4761

1.4.13.3.163. cloud_azure_virtualwan_ptosvpngateways_1d 4764

1.4.13.3.164. cloud_azure_virtualwan_virtualhubs_1d 4767

1.4.13.3.165. cloud_azure_virtualwan_vpngateways_1d 4770

1.4.13.3.166. cloud_azure_aks_cluster_baseline_1d 4781

1.4.13.3.167. cloud_azure_application_gateway_baseline_1d 4783

1.4.13.3.168. cloud_azure_appservices_baseline_1d 4786

1.4.13.3.169. cloud_azure_aspservices_baseline_1d 4791

1.4.13.3.170. cloud_azure_cosmosdb_baseline_1d 4796

1.4.13.3.171. cloud_azure_datalakeanalytics_baseline_1d 4799

1.4.13.3.172. cloud_azure_disk_baseline_1d 4802

1.4.13.3.173. cloud_azure_eventhubs_baseline_1d 4804

1.4.13.3.174. cloud_azure_eventhubsclusters_baseline_1d 4807

1.4.13.3.175. cloud_azure_expressroutecircuits_baseline_1d 4810

1.4.13.3.176. cloud_azure_expressroutedirect_baseline_1d 4813

1.4.13.3.177. cloud_azure_frontdoors_baseline_1d 4816

1.4.13.3.178. cloud_azure_load_balancer_baseline_1d 4819

1.4.13.3.179. cloud_azure_purview_baseline_1d 4822

1.4.13.3.180. cloud_azure_rediscache_baseline_1d 4824

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

1.4.13.3.181. cloud_azure_sql_database_baseline_1d 4828

1.4.13.3.182. cloud_azure_storage_accounts_baseline_1d 4831

1.4.13.3.183. cloud_azure_synapse_dedicatedsqlpools_baseline_1d 4834

1.4.13.3.184. cloud_azure_synapse_workspace_baseline_1d 4837

1.4.13.3.185. cloud_azure_virtual_machines_baseline_1d 4840

1.4.13.3.186. cloud_azure_virtualnetworkgateways_baseline_1d 4845

1.4.13.3.187. cloud_azure_virtualwan_ptosvpngateways_baseline_1d 4851

1.4.13.3.188. cloud_azure_virtualwan_vpngateways_baseline_1d 4853

1.4.13.4. Hyperscale Observability for GCP 4855

1.4.13.4.1. cloud_gcp_appengine_application 4856

1.4.13.4.2. cloud_gcp_cloudsql 4866

1.4.13.4.3. cloud_gcp_computeengine 4872

1.4.13.4.4. cloud_gcp_filestore 4882

1.4.13.4.5. cloud_gcp_gke_container 4886

1.4.13.4.6. cloud_gcp_gke_pod 4891

1.4.13.4.7. cloud_gcp_gke_node 4893

1.4.13.4.8. cloud_gcp_loadbalancing 4899

1.4.13.4.9. cloud_gcp_computeengine_baseline 4918

1.4.13.4.10. cloud_gcp_appengine_application_1h 4925

1.4.13.4.11. cloud_gcp_cloudsql_1h 4946

1.4.13.4.12. cloud_gcp_computeengine_1h 4959

1.4.13.4.13. cloud_gcp_filestore_1h 4980

1.4.13.4.14. cloud_gcp_gke_container_1h 4988

1.4.13.4.15. cloud_gcp_gke_pod_1h 4999

1.4.13.4.16. cloud_gcp_gke_node_1h 5003

1.4.13.4.17. cloud_gcp_loadbalancing_1h 5014

1.4.13.4.18. cloud_gcp_computeengine_baseline_1h 5045

1.4.13.4.19. cloud_gcp_appengine_application_1d 5053

1.4.13.4.20. cloud_gcp_cloudsql_1d 5074

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

1.4.13.4.21. cloud_gcp_computeengine_1d 5087

1.4.13.4.22. cloud_gcp_filestore_1d 5108

1.4.13.4.23. cloud_gcp_gke_container_1d 5116

1.4.13.4.24. cloud_gcp_gke_pod_1d 5127

1.4.13.4.25. cloud_gcp_gke_node_1d 5131

1.4.13.4.26. cloud_gcp_loadbalancing_1d 5142

1.4.13.4.27. cloud_gcp_computeengine_baseline_1d 5173

1.4.13.5. Hyperscale Observability for Kubernetes 5181

1.4.13.5.1. kubernetes_clusters 5183

1.4.13.5.2. kubernetes_cronjobs 5185

1.4.13.5.3. kubernetes_daemonsets 5186

1.4.13.5.4. kubernetes_deployments 5187

1.4.13.5.5. kubernetes_endpoints 5188

1.4.13.5.6. kubernetes_horizontalpodautoscalers 5189

1.4.13.5.7. kubernetes_ingress 5191

1.4.13.5.8. kubernetes_jobs 5192

1.4.13.5.9. kubernetes_namespaces 5194

1.4.13.5.10. kubernetes_nodes 5195

1.4.13.5.11. kubernetes_persistent_volume_claims 5197

1.4.13.5.12. kubernetes_persistent_volumes 5199

1.4.13.5.13. kubernetes_pods 5200

1.4.13.5.14. kubernetes_services 5201

1.4.13.5.15. kubernetes_statefulsets 5202

1.4.13.5.16. kubernetes_replicasets 5203

1.4.13.5.57. kubernetes_namespaces_baseline 5204

1.4.13.5.18. opsb_k8sapp_nginx 5205

1.4.13.5.19. opsb_k8sapp_rabbitmq 5207

1.4.13.5.20. opsb_k8sapp_rabbitmq_node 5211

1.4.13.5.21. kubernetes_clusters_1h 5213

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

1.4.13.5.22. kubernetes_cronjobs_1h 5216

1.4.13.5.23. kubernetes_daemonsets_1h 5217

1.4.13.5.24. kubernetes_deployments_1h 5220

1.4.13.5.25. kubernetes_endpoints_1h 5222

1.4.13.5.26. kubernetes_horizontalpodautoscalers_1h 5224

1.4.13.5.27. kubernetes_ingress_1h 5227

1.4.13.5.28. kubernetes_jobs_1h 5228

1.4.13.5.29. kubernetes_namespaces_1h 5230

1.4.13.5.30. kubernetes_nodes_1h 5232

1.4.13.5.31. kubernetes_persistent_volume_claims_1h 5236

1.4.13.5.32. kubernetes_persistent_volumes_1h 5238

1.4.13.5.33. kubernetes_pods_1h 5239

1.4.13.5.34. kubernetes_services_1h 5241

1.4.13.5.35. kubernetes_statefulsets_1h 5242

1.4.13.5.36. kubernetes_replicasets_1h 5244

1.4.13.5.37. opsb_k8sapp_rabbitmq_1h 5246

1.4.13.5.38. opsb_k8sapp_rabbitmq_node_1h 5260

1.4.13.5.39. opsb_k8sapp_nginx_1h 5264

1.4.13.5.40. opsb_k8sapp_nginx_1d 5267

1.4.13.5.41. kubernetes_clusters_1d 5270

1.4.13.5.42. kubernetes_cronjobs_1d 5273

1.4.13.5.43. kubernetes_daemonsets_1d 5274

1.4.13.5.44. kubernetes_deployments_1d 5277

1.4.13.5.45. kubernetes_endpoints_1d 5279

1.4.13.5.46. kubernetes_horizontalpodautoscalers_1d 5281

1.4.13.5.47. kubernetes_ingress_1d 5284

1.4.13.5.48. kubernetes_jobs_1d 5285

1.4.13.5.49. kubernetes_namespaces_1d 5287

1.4.13.5.50. kubernetes_nodes_1d 5289

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

1.4.13.5.51. kubernetes_persistent_volume_claims_1d 5293

1.4.13.5.52. kubernetes_persistent_volumes_1d 5295

1.4.13.5.53. kubernetes_pods_1d 5296

1.4.13.5.54. kubernetes_services_1d 5298

1.4.13.5.55. kubernetes_statefulsets_1d 5299

1.4.13.5.56. kubernetes_replicasets_1d 5301

1.4.13.5.57. kubernetes_namespaces_baseline 5303

1.4.13.5.58. kubernetes_namespaces_baseline_1h 5304

1.4.13.5.59. kubernetes_namespaces_baseline_1d 5305

1.4.13.5.60. opsb_k8sapp_rabbitmq_1d 5306

1.4.13.5.61. opsb_k8sapp_rabbitmq_node_1d 5320

1.4.13.5.62. opsb_k8sapp_kafka 5324

1.4.13.5.63. opsb_k8sapp_kafka_jmx_broker_topic 5325

1.4.13.5.64. opsb_k8sapp_kafka_jmx_controller 5326

1.4.13.5.65. opsb_k8sapp_kafka_jmx_replica_fetcher_mgr 5330

1.4.13.5.66. opsb_k8sapp_kafka_topic_partition 5331

1.4.13.5.67. opsb_k8sapp_mongodb 5332

1.4.13.5.68. opsb_k8sapp_mongodb_collection 5340

1.4.13.5.69. opsb_k8sapp_mongodb_db 5342

1.4.13.5.70. opsb_k8sapp_mongodb_rs_members 5343

1.4.13.5.71. opsb_k8sapp_mysql 5345

1.4.13.5.72. opsb_k8sapp_mysql_perf_schema 5355

1.4.13.5.73. opsb_k8sapp_mysql_plugin 5358

1.4.13.5.74. opsb_k8sapp_mysql_innodb 5360

1.4.13.5.75. opsb_k8sapp_postgresql 5366

1.4.13.5.76. opsb_k8sapp_postgresql_db 5368

1.4.13.5.77. opsb_k8sapp_redis 5370

1.4.13.5.78. opsb_k8sapp_redis_db 5374

1.4.13.5.79. opsb_k8sapp_kafka_1h 5375

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

1.4.13.5.80. opsb_k8sapp_kafka_jmx_broker_topic_1h 5377

1.4.13.5.81. opsb_k8sapp_kafka_jmx_controller_1h 5378

1.4.13.5.82. opsb_k8sapp_kafka_jmx_replica_fetcher_mgr_1h 5396

1.4.13.5.83. opsb_k8sapp_kafka_topic_partition_1h 5398

1.4.13.5.84. opsb_k8sapp_mongodb_1h 5400

1.4.13.5.85. opsb_k8sapp_mongodb_collection_1h 5441

1.4.13.5.86. opsb_k8sapp_mongodb_db_1h 5445

1.4.13.5.87. opsb_k8sapp_mongodb_rs_members_1h 5447

1.4.13.5.88. opsb_k8sapp_mysql_1h 5452

1.4.13.5.89. opsb_k8sapp_mysql_perf_schema_1h 5491

1.4.13.5.90. opsb_k8sapp_mysql_plugin_1h 5500

1.4.13.5.91. opsb_k8sapp_mysql_innodb_1h 5504

1.4.13.5.92. opsb_k8sapp_postgresql_1h 5526

1.4.13.5.93. opsb_k8sapp_postgresql_db_1h 5534

1.4.13.5.94. opsb_k8sapp_redis_1h 5542

1.4.13.5.95. opsb_k8sapp_redis_db_1h 5556

1.4.13.5.96. opsb_k8sapp_kafka_1d 5557

1.4.13.5.97. opsb_k8sapp_kafka_jmx_broker_topic_1d 5559

1.4.13.5.98. opsb_k8sapp_kafka_jmx_controller_1d 5560

1.4.13.5.99. opsb_k8sapp_kafka_jmx_replica_fetcher_mgr_1d 5578

1.4.13.5.100. opsb_k8sapp_kafka_topic_partition_1d 5580

1.4.13.5.101. opsb_k8sapp_mongodb_1d 5582

1.4.13.5.102. opsb_k8sapp_mongodb_collection_1d 5623

1.4.13.5.103. opsb_k8sapp_mongodb_db_1d 5627

1.4.13.5.104. opsb_k8sapp_mongodb_rs_members_1d 5629

1.4.13.5.105. opsb_k8sapp_mysql_1d 5634

1.4.13.5.106. opsb_k8sapp_mysql_perf_schema_1d 5673

1.4.13.5.107. opsb_k8sapp_mysql_plugin_1d 5682

1.4.13.5.108. opsb_k8sapp_mysql_innodb_1d 5686

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

1.4.13.5.109. opsb_k8sapp_postgresql_1d 5708

1.4.13.5.110. opsb_k8sapp_postgresql_db_1d 5716

1.4.13.5.111. opsb_k8sapp_redis_1d 5724

1.4.13.5.112. opsb_k8sapp_redis_db_1d 5738

1.4.13.6. Hyperscale Observability for VMware Virtualization 5739

1.4.13.6.1. opsb_vmware_cluster 5740

1.4.13.6.2. opsb_vmware_cluster_1h 5743

1.4.13.6.3. opsb_vmware_cluster_1d 5748

1.4.13.6.4. opsb_vmware_cluster_baseline 5753

1.4.13.6.5. opsb_vmware_cluster_baseline_1h 5755

1.4.13.6.6. opsb_vmware_cluster_baseline_1d 5757

1.4.13.6.7. opsb_vmware_datacenter 5759

1.4.13.6.8. opsb_vmware_datacenter_1h 5761

1.4.13.6.9. opsb_vmware_datacenter_1d 5762

1.4.13.6.10. opsb_vmware_datacenter_baseline 5763

1.4.13.6.11. opsb_vmware_datacenter_baseline_1h 5765

1.4.13.6.12. opsb_vmware_datacenter_baseline_1d 5767

1.4.13.6.13. opsb_vmware_datastore 5769

1.4.13.6.14. opsb_vmware_datastore_1h 5771

1.4.13.6.15. opsb_vmware_datastore_1d 5773

1.4.13.6.16. opsb_vmware_datastore_baseline 5775

1.4.13.6.17. opsb_vmware_datastore_baseline_1h 5777

1.4.13.6.18. opsb_vmware_datastore_baseline_1d 5779

1.4.13.6.19. opsb_vmware_host 5781

1.4.13.6.20. opsb_vmware_host_1h 5785

1.4.13.6.21. opsb_vmware_host_1d 5795

1.4.13.6.22. opsb_vmware_host_baseline 5805

1.4.13.6.23. opsb_vmware_host_baseline_1h 5807

1.4.13.6.24. opsb_vmware_host_baseline_1d 5810

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.4.13.6.25. opsb_vmware_resourcepool 5813

1.4.13.6.26. opsb_vmware_resourcepool_1h 5815

1.4.13.6.27. opsb_vmware_resourcepool_1d 5818

1.4.13.6.28. opsb_vmware_vm 5821

1.4.13.6.29. opsb_vmware_vm_1h 5825

1.4.13.6.30. opsb_vmware_vm_1d 5834

1.4.13.6.31. opsb_vmware_vm_baseline 5843

1.4.13.6.32. opsb_vmware_vm_baseline_1h 5846

1.4.13.6.33. opsb_vmware_vm_baseline_1d 5849

1.5. Develop custom reports and dashboards 5852

1.5.1. Customize BVD reports 5853

1.5.2. Customize Flex reports 5855

1.5.2.1. Customize System Top N report to display top X values 5857

1.5.3. Customized Event views 5861

1.5.4. Develop Performance Troubleshooting dashboard 5864

1.5.5. Develop topology centric reports in OPTIC Reporting 5869

1.5.6. Develop reports for Operations Bridge Integration Hub content 5874

1.5.7. Develop custom CI attributes report 5877

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

1.1. Develop OBM


This section describes how to customize OBM, extend its functionality, and use APIs to perform operations. The intended audiences are
administrators and integrators who need to establish advanced configurations and extensions.

This section covers the following topics:

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

1.1.1. Extending OBM


The prerequisites for extending and customizing OBM are as follows:

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:

< OMi_HOME >/conf/opr/topology-sync/sync-packages

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

1.1.2. Web Service Interfaces


A number of web services allow integrators to access OBM functionality from external applications.

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.

This part is structured as follows:

Reference information for all web services


Action Web Service Interface
Downtime Web Service Interface
Event Synchronization Web Service Interface
Event Web Service Interface
Monitoring Automation Web Service Interface
Status Web Service Interface
Tool Execution Web Service Interface
User Management Web Services Interface

For details on additional WebServices, see Developer Central.

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

1.1.2.1. Reference information for all web services


This section describes what to consider when using any of the available web service interfaces.

Authentication
Consider the following with regard to authentication and security when using web services:

Web services can only be executed by regular OBM users.


User rights assumed when executing a web service request are identical to the user rights you would have when performing the
same operation using the OBM user interface, being logged in as the user whose credentials are used for web service
authentication.
Network encryption and data integrity are supported only when using the HTTPS protocol.
Users that do not have Clear View Filter permission need to specify a view filter when executing the Event Web Service.

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();

The following types of authentication are also supported:

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

options are available:

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.

1. Navigate to the in the Infrastructure Settings Manager:

Administration > Setup and Maintenance > Infrastructure Settings

2. Search for the Error Response Verbosity setting.

3. Optional. Change the default value Standard to another value.

4. Review the error log file on the OBM Gateway Server:

<OMi_HOME>/log/opr-ws-response.log

Secure modify operations


Web Service modify operations must be secured by setting the X-Secure-Modify-Token HTTP header on modify requests (PUT, POST, and
DELETE). This header provides enhanced security protection against malicious exploits of web applications.

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.

Setting the X-Secure-Modify-Token HTTP Header


Web Service clients must first obtain the secureModifyToken cookie, and then set the value of the cookie in the X-Secure-Modify-Token
HTTP header:

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.

2. Set the X-Secure-Modify-Token HTTP header.

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.

Sample Code Using a Standard Java HTTP Client

The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.

Get the secureModifyToken cookie


The following method gets all the cookies from an initial GET request. The standard Java HTTP client does not automatically manage
cookies for the user as the Apache HttpClient does. The cookies need to be obtained and managed separately.

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

private static List<HttpCookie> getCookies(final String path)


{
final URL url = new URL(path);
final HttpURLConnection connection = url.openConnection();
final List<HttpCookie> result = new ArrayList<HttpCookie>();

connection.setRequestMethod("GET");

// Set the username and password for the request


byte[] encodedUserPassword = Base64.encodeBase64((username + ":" + password).getBytes());
connection.setRequestProperty("Authorization", "Basic " + new String(encodedUserPassword));

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;
}

Set the X-Secure-Modify-Token HTTP header


The following code adds the cookies to the POST request and the HTTP header X-Secure-Modify-Token if the cookie secureModifyToken
exists.

final URL url


final List<HttpCookie> cookies = getCookies("http://" + localHostName + ":" + port + "/opr-web/rest");

final URL url = new URL("https://" + localHostName + ":" + port + "/opr-web/rest/9.10/event_list");


final HttpURLConnection connection = url.openConnection();

// Set the cookies and HTTP header for the request


for (HttpCookie cookie : cookies)
{
// add the cookies to the request
connection.addRequestProperty("Cookie", cookie.getName() + "=" + cookie.getValue());
if (cookie.getName().equalsIgnoreCase("secureModifyToken"))
{
// add the HTTP header
connection.setRequestProperty("X-Secure-Modify-Token", cookie.getValue());
}
}
...

Sample Code Using an Apache HttpClient

The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.

Get the secureModifyToken cookie


The following method may return null, in which case it should be assumed the target web service does not require the X-Secure-Modify-T
oken HTTP header. (For example, OBM versions lower than 9.10 do not require this 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

private static String getSecureModifyToken(final HttpClient client, final String url)

{
int rc = -1;

String secureModifyToken = null;

// get the service document from the base path


final HttpMethod getMethod = new GetMethod(url);
getMethod.setFollowRedirects(true);
getMethod.setDoAuthentication(true);
getMethod.setRequestHeader("Accept", "text/plain, text/xml, application/xml, application/atomsvc+xml");
getMethod.setRequestHeader("Accept-Language", System.getProperty("user.language", "en") + "-"
+ System.getProperty("user.country", "US"));
try
{
client.executeMethod(getMethod);
rc = getMethod.getStatusCode();
}
catch (IOException ioe)
{
// ignore any errors for backwards compatibility
}
if (rc == HttpStatus.SC_OK)
{
// look for the secureModifyToken
Cookie[] cookies = client.getState().getCookies();
if (cookies != null && cookies.length > 0)
{
for (Cookie cookie : cookies)
{
if (SECURE_MODIFY_TOKEN.equalsIgnoreCase(cookie.getName()))
secureModifyToken = cookie.getValue();
}
}
}
return secureModifyToken;
}

Set the X-Secure-Modify-Token HTTP header


HttpClient client = new HttpClient();
client.getState().setCredentials(new AuthScope(hostname, port),
new UsernamePasswordCredentials(username, password));
final String secureModifyToken = getSecureModifyToken(client,
"https://" + localHostName + ":" + port + "/opr-web/rest");
String url = "https://" + localHostName + ":" + port + "/opr-web/rest/9.10/event_list";
PostMethod method = new PostMethod(url);
if (secureModifyToken != null)
method.setRequestHeader("X-Secure-Modify-Token", secureModifyToken);
...

Sample Code Using an Apache Wink REST Client

The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.

Get initial cookies


The following method gets all the cookies from an initial GET request. The Apache Wink REST Client does not automatically manage
cookies for the user like the Apache HttpClient does. The cookies need to be obtained and managed separately.

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

private static Set<Cookie> getCookies(final String url, final RestClient client)


{
final Set<Cookie> cookies = new HashSet <Cookie>();
final Resource resource = client.resource(url);

// Set the username and password for the request


byte[] encodedUserPassword = Base64.encodeBase64((username + ":" + password).getBytes());
resource.header("Authorization", "Basic " + new String(encodedUserPassword));
final ClientResponse response = resource.get();

final MultivaluedMap<String, String> headers = response.getHeaders();


if (headers != null)
{
for (final Map.Entry<String, List<String>> header : headers.entrySet())
{
if ("Set-Cookie".equalsIgnoreCase(header.getKey()))
{
for (final String value : header.getValue())
{
if (value != null && value.length() > 0)
try
{
cookies.add(Cookie.valueOf(value));
}
catch (IllegalArgumentException e)
{
// ignore this entry
}
}
}
}
}
return cookies;
}

Sample Code Using an Apache Wink REST Client

The following sample code first gets the value of the secureModifyToken cookie and then sets the X-Secure-Modify-Token HTTP header.

Set the X-Secure-Modify-Token HTTP header


The following code adds the cookies to the REST resource and the HTTP header X-Secure-Modify-Token if the cookie secureModifyToken
exists.

final RestClient client = new RestClient();


final Set<Cookie> cookies = getCookies("https://" + localHostName + ":" + port + "/opr-web/rest", client);

String url = "https://" + localHostName + ":" + port + "/opr-web/rest/9.10/event_list";


final Resource resource = client.resource(url);

// Set the username and password for the request


byte[] encodedUserPassword = Base64.encodeBase64((username + ":" + password).getBytes());
resource.header("Authorization", "Basic " + new String(encodedUserPassword));

// Set the cookies and HTTP header for the request


for (Cookie cookie : cookies)
{
// add the cookies to the resource
resource.cookie(cookie);
if (cookie.getName().equalsIgnoreCase("secureModifyToken"))
{

// add the HTTP header


resource.header("X-Secure-Modify-Token", cookie.getValue());
}
}
...

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

Disable Enhanced Security Protection

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.

1. Navigate to the Infrastructure Settings Manager:

Administration > Setup and Maintenance > Infrastructure Settings

Search for the Secure Modify setting and edit as required.

2. Change the default value true to false.

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.

Environments with CA SiteMinder


If the CA SiteMinder Web Agent is configured for CssChecking=YES , characters configured in the CA SiteMinder Web Agent BadUrlChars
parameter are rejected by the CA SiteMinder Web Agent. By default the following characters are included in this list:

Single quotation mark (')


Greater than sign (>)
Less than sign (<)

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:

Replace single quotation marks (') with $60.

Replace greater than signs (>) with $3E.

Replace less than signs (<) with $3C

See the topic URL escape codes for more information.

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:

Administration > Setup and Maintenance > Infrastructure Settings

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:

Administration > Setup and Maintenance > Infrastructure Settings

Search for Web Service 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

1.1.2.2. Action Web Service Interface


The REST-based Action Web Service enables you to access the following functionality from an external application:

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:

$ <OvBinDir>/ovdeploy -cmd set [ -host <remoteHost> ] | grep "Ov"

Linux output: OvBinDir = /opt/OV/bin

Windows output: Program Files\HP\HP BTO Softeare\bin\win64

Cancel the command on the managed nodes.

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.

Retrieve the detailed command status for a specific managed node.

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.

For further information about actions, see the topic Actions.

For information about tools, see the topic Tools.

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

How to Access the Action Web Service


Your entry point to the web service interface is the Service Document, using the following base URL and syntax: https://<serviceURL>/<re
quest>

The URL of the Action web service is:

<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.

List of Services in the Service Document

OPR Action Web Services URL

Action Web Service POST request: https://<server>:<port>/opr-web/rest/10.10/direct_execution

DELETE request: https://<server>:<port>/opr-web/rest/10.10/direct_execution/{contextId}

DELETE request on single node: https://<server>:<port>/opr-web/rest/10.10/direct_execution/{contextId}/{resultId}

Security and Authorization


Because the Action Web Service enables the user to trigger mass requests that run on all managed nodes, security and authorization
settings are especially important. It's highly recommended that you configure OBM to use HTTPS while working with the Action Web

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

Service. Ensure that you meet the following security requirements:

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:

HTTP error codes:

HTTP error code 403: authorization problems


HTTP error code 409: requested hosts aren't in the RTSM, or no CIs match requirements
HTTP error code 4xx (other than 403, 409): any form of communication problems with OBM
HTTP code 200: At least one requested host is in the RTSM and meets the requirements.

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

1.1.2.2.1. Action Web Service request reference


The Action Web Service interface supports the following requests:

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.

Execute a command as specified in the posted XML data.

/<executionContextID> POST Note:

/<executionContextID> is required.

Cancel the execution.

/<executionContextID>/<nodeSpecificResultID> is specified: Cancel the execution on a


/<executionContextID> DELETE specific node.

/<executionContextID> is specified, but /<nodeSpecificResultID> is omitted: Cancel the


execution on all concerned nodes with ID < execution ContextID >.

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.

Execute a command string:

POST - https://<server>:<port>/opr-web/rest/10.10/direct_execution

Input:

<direct_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:\


xs="http://www.w3.org/2001/XMLSchema">
<!--wrapper element for command execution-->
<command>
<!-- mandatory; the command string to execute-->
<tool_type>
<!-- mandatory; can be om_agent_command, perl, vb_script, java_script or wsh (Windows scripting host)-->
<!-- If set to om_agent_command, it's executed by the OM action agent (opcacta), otherwise it's executed by the built-in module (e.g. for perl) from
the OM monitor agent (opcmona)-->.
<run_as_username>
<!-- optional; execute the command as this user; by default the command is executed as the OM agent user.-->
<!-- on Unix setting this XML tag has no impact if the OM agent doesn't run with superuser right;-->
<!-- for Windows, the user password must be specified to switch to that user, but as opposed to in Unix, you can switch to any user.-->
<run_as_user_password>
<!-- optional; Windows only, password for the user to run the command as; see above-->
<execution_hosts>
<!-- mandatory; list of hosts to execute the command on-->
<execution_host>
<!-- mandatory; hostname or IP address of a managed node-->

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-->

Retrieve status overview:

GET - https://<server>:<port>/opr-web/rest/10.10/direct_execution/<executionContextID>

Same as output for the above POST call (<tool_execution_context>).

Retrieve detailed status for one node:

GET - https://<server>:<port>/opr-web/rest/10.10/direct_execution/<executionContextID>/<nodeSpecificResultId>

<tool_execution_result xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<!-- wrapper element for the detailed status-->
<id>
<!-- the nodeSpecificResultId-->
<tool_ref>
<!-- only relevant for tool web service, not for action web service.-->
<execution_host>
<!-- the host the command is running on-->
<user_parameters/>
<!-- only relevant for tool web service, not for action web service-->
<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-->
<output>
<!-- command output-->
<result_code>
<!-- command return code-->

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

<direct_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:\


xs="http://www.w3.org/2001/XMLSchema">
<command>ovc</command>
<tool_type>om_agent_command</tool_type>
<execution_hosts>
<execution_host>example.example.net</execution_host>
<execution_host>ia2.example.net</execution_host>
<execution_host>asdf</execution_host>
</execution_hosts>
</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:

<tool_execution_result xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>d1714284-5d42-4b45-a95a-ad110555630d</id>
<tool_ref>
<id>3269833c-1818-41dc-bd06-aafb6334088f</id>
<target_id>3269833c-1818-41dc-bd06-aafb6334088f</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>
<execution_host>ia2.example.net</execution_host>
<tool_command>ovc</tool_command>
<user_parameters/>
<tool_execution_state>finished</tool_execution_state>
<started>2015-09-30T13:03:56.980+02:00</started>
<started_text>01:03:56 AM</started_text>
<finished>2015-09-30T13:03:58.292+02:00</finished>
<finished_text>01:03:58 AM</finished_text>
<output>coda OV Performance Core COREXT (6983)
Running
ompolparm OM Parameter Handler AGENT,EA (8308) Running
opcacta OVO Action Agent AGENT,EA (6948) Running
opcmona OVO Monitor Agent AGENT,EA (8275) Running
opcmsga OVO Message Agent AGENT,EA (8333) Running
ovbbccb OV Communication Broker CORE (6897) Running
ovcd OV Control CORE (6889) Running
ovconfd OV Config and Deploy COREXT (6917) Running
</output>
<result_code>0</result_code>
</tool_execution_result>

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

1.1.2.2.3. Action Web Service troubleshooting


This section contains information to help you troubleshoot using the action web service interface.

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

1.1.2.3. Downtime Web Service Interface


You can use a RESTful web service running on the Gateway Server to retrieve, update, create, and delete downtime values. HTTP
requests are entered in your browser and combinations of HTTP requests and XML commands in a REST client. Service authentication is
based on basic authentication.

To use the Downtime REST API, a user with Full Control permission for Downtime Management under Service Health is needed.

https://<serviceURL>/<request>

The URL of the Action web service:


<serviceURL> <server>:<port>/topaz/bsmservices/customers/[customerID]/downtimes
where <server> is the name of the OBM server.

<request> The service request.

The downtime REST service supports the following HTTP requests:

CustomerID is always 1.

Request Request Type Action Description

/{[downtimeID]} is omitted: Lists all configured downtime values.


/downtimes/{[downtimeID]} GET
/{[downtimeID]} is specified: Get the downtime with ID [downtimeID] .

Create a downtime as specified in the posted XML data.


/downtimes + XML of the downtime POST
You must omit /[downtimeID] .

Update downtime as specified in the posted XML data.


downtimes/[downtimeID] + XML of the downtime PUT
You must specify /[downtimeID] .

Delete the downtime with the ID [downtimeID] .


downtimes/[downtimeID] DELETE
You must specify /[downtimeID] .

Request Reference
The downtime REST service supports the following HTTP requests:

CustomerID is always 1.

Request Request Type Action Description

/{[downtimeID]} is omitted: Lists all configured downtime values.


/downtimes/{[downtimeID]} GET
/{[downtimeID]} is specified: Get the downtime with ID [downtimeID] .

Create a downtime as specified in the posted XML data.


/downtimes + XML of the downtime POST
You must omit /[downtimeID] .

Update downtime as specified in the posted XML data.


downtimes/[downtimeID] + XML of the downtime PUT
You must specify /[downtimeID] .

Delete the downtime with ID [downtimeID] .


downtimes/[downtimeID] DELETE
You must specify /[downtimeID] .

Allowed Downtime Actions


Use the XML commands listed for the following downtime actions:

Action Description XML Command

Take no actions <action name="REMINDER"/>

Suppress alerts and close events <action name="SUPPRESS_NOTIFICATIONS"/>

Enforce downtime on KPI calculations; suppress alerts and


<action name="ENFORCE_ON_KPI_CALCULATION"/>
close events (continue monitoring)

Enforce downtime on Reports and KPI calculations; suppress


<action name="ENFORCE_ON_REPORTS"/>
alerts and close events (continue monitoring)

Enforce downtime on Reports and KPI calculations; suppress


<action name="ENFORCE_ON_REPORTS"> <propGroup name="SLA"
alerts and close events (continue monitoring), including all
value="ALL"/> </action>
SLAs

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

Action Description XML Command

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>

Stop active monitoring (BPM and SiteScope); enforce


downtime on Reports & KPI calculations; suppress alerts and <action name="STOP_MONITORING"/>
close events

Downtime XML Example


The following fields may not exceed the maximum lengths specified:

Name: 200 characters


Description: 2000 characters
Approved by: 50 characters

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.

<downtime userId="1" planned="true" id="8898e5a5dbcdc953e04037104bf5737c">


<name>The name of the downtime</name>
<action name="ENFORCE_ON_REPORTS">
</action>
<approver>The approver name</approver>
<category>1</category>
<notification>
<recipients>
<recipient id="24"/>
<recipient id="22"/>
<recipient id="21"/>
</recipients>
</notification>
<selectedCIs>
<ci>
<id>ac700345b47064ed4fbb476f21f95a76</id>
<viewName>End User Monitors</viewName>
</ci>
</selectedCIs>
<schedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="WeeklyScheduleType">
<type>WEEKLY</type>
<startDate>2010-06-10T00:00:00</startDate>
<timeZone>Europe/Zurich</timeZone>
<days>
<selectedDays>WEDNESDAY</selectedDays>
<selectedDays>THURSDAY</selectedDays>
<selectedDays>FRIDAY</selectedDays>
<selectedDays>SATURDAY</selectedDays>
</days>
<startTimeInSecs>600</startTimeInSecs>
<durationInSecs>300</durationInSecs>
</schedule>
</downtime>

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

<downtime planned="false" userId="admin" userName="admin" dttype="UNPLANNED">


<name>a downtime test rest service</name>
<action name="ENFORCE_ON_REPORTS"/>
<approver>The approver name</approver>
<category>1</category>
<notification>
<recipients/>
</notification>
<selectedCIs>
<ci>
<name>test.infra.net</name>
<type>unix</type>
<viewName>End User Monitors</viewName>
</ci>
</selectedCIs>
<schedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="OnceScheduleType">
<type>ONCE</type>
<startDate>2023-06-23T17:11:00</startDate>
<endDate>2023-06-23T17:15:00</endDate>
<timeZone>Asia/Kolkata</timeZone>
</schedule>
</downtime>

Downtime XML Tags


General

Element Description Structure

<name>Name of the Down


name Name of the downtime.
time</name>

<approver>The approver n
approver Name of the approver of the downtime.
ame</approver>

category A numerical value that represents the category ID. <category>1</category>

<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>

name Name of the CI as defined in CMDB. <name>CI name</name>

type CI type. <type>CI type</type>

Schedule

Note

Notes: Remember the following points when scheduling downtime:

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 offset value isn't supported in <startDate> and <endDate> .

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.

Type Description 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

Type Description Structure

<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>

The downtime occurs on a monthly basis, based on a specified


start date and other details such as dayOfWeek and weekInMont
h . For example, if dayOfWeek is 3 and weekInMonth is 2, the
downtime will occur on the second Tuesday ( dayOfWeek 1 is
Sunday) of the month. <schedule xsi:type="MonthlyScheduleType">

<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 .

The downtime occurs on a monthly basis starting on a specified


start date and the day of the month.
The downtime reoccurs depending on monthRecurrence until the <schedule <a
provided end date. If no end date is provided, then the downtime rel="nofollow">xsi:type="MonthlyScheduleType</a>">
occurs endlessly. monthRecurrence is a numerical value stating <type>MONTHLY</type>
how many months pass until the next occurrence. For example, if
<startDate>2018-06-04T00:00:00</startDate>
MONTHLY monthRecurrence is 1 then the downtime will occur every month.
<endDate>2019-05-01T11:59:00</endDate>
(day of If monthRecurrence is 2 then the downtime will occur every
<timeZone>America/Merida</timeZone>
month second month.
<selectedDayOfMonth>4</selectedDayOfMonth>
selection) The downtime is active from the (start date time+the value of star
<monthRecurrence>1</monthRecurrence>
tTimeInSecs ) to the (start date time+ value of startTimeInSecs +
<startTimeInSecs>300</startTimeInSecs>
value of durationInSecs ).
<durationInSecs>2100</durationInSecs>
For example, the start date is 2018-06-04T00:00:00 . Therefore
the start date time is 12:00 AM , startTimeInSecs is 300 seconds, </schedule>
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

1.1.2.3.1. Downtime schedule examples


Keep the following in mind when setting the downtime schedule:

Retroactive downtime isn't supported. You can't:


Create a downtime that's scheduled in the past.
Modify a downtime that has started or that occurred in the past.
The date format of startDate/endDate is: yyyy-MM-dd'T'HH:mm:ssZ
For weekly and monthly downtime values, the startDate and endDate should be defined at midnight. For example:
<startDate>2010-07-24T00:00:00</startDate>
<endDate>2010-09-04T00:00:00</endDate>

Example of a Downtime Schedule with One Occurrence


<schedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="OnceScheduleType">
<type>ONCE</type>
<startDate>2010-06-08T14:40:00</startDate>
<endDate>2010-06-08T14:45:00</endDate>
<timeZone>Asia/Tokyo</timeZone>
</schedule>

Example of a Weekly Downtime Schedule


<schedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="WeeklyScheduleType">
<type>WEEKLY</type>
<startDate>2010-06-10T00:00:00</startDate>
<timeZone>Europe/Zurich</timeZone>
<days>
<selectedDays>WEDNESDAY</selectedDays>
<selectedDays>THURSDAY</selectedDays>
<selectedDays>FRIDAY</selectedDays>
<selectedDays>SATURDAY</selectedDays>
</days>
<startTimeInSecs>600</startTimeInSecs>
<durationInSecs>300</durationInSecs>
</schedule>

Example of a Monthly Downtime Schedule


<schedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="MonthlyScheduleType">
<type>MONTHLY</type>
<startDate>2010-06-10T00:00:00</startDate>
<endDate>2011-05-09T11:59:00</endDate>
<timeZone>America/Montevideo</timeZone>
<selectedDayOfMonth>4</selectedDayOfMonth>
<monthRecurrence>1</monthRecurrence>
<startTimeInSecs>300</startTimeInSecs>
<durationInSecs>2100</durationInSecs>
</schedule>

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

1.1.2.3.2. Import downtime data from an external


source
If business management solutions (such as Service Manager, OM, or third party software) create downtime events when integrating
with OBM, you may need to import downtime information from an external system. To import this downtime information, create a
middle utility using the REST API to pull the events from the external source and post them to OBM.

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

Imported events must be translated to match OBM downtime properties.

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.

Keep the following in mind when editing the file:

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.

To run the example:

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

1.1.2.3.3. Downtime Filters


Use the following filters for filtering downtimes:

Filter Values Description

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

1.1.2.3.4. Downtime Web Service troubleshooting


The section contains information to help you troubleshoot using the downtime web service.

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

1.1.2.4. Event Synchronization Web Service interface


The Event Synchronization Web Service interface can be used to integrate with external (third-party) event processes, such as an
incident manager like Service Manager. The interface is used to forward events and event changes from the OBM OPR client to the
third-party application, and to synchronize back from the third-party client events and event changes that the external application
makes to the events.

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.

Prerequisite. Configure a Connected Server


To use this web service, the following steps must first be performed:

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.

For details of how to configure connected servers, see OMB Help.

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

1.1.2.4.1. Forward events and event changes from


OPR client
For the OPR client to be able to forward events and event changes to a third-party event processing application, that third-party
application must implement an OPR-compliant Event Synchronization Web Service.

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.

Forward Event Change

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.

Forward Event Changes

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.

Web Service GET Request

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 .

Web Service Ping Request

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

HEAD to base URL


Base URL:

Base URL for forwarding events

http://<base configured URL of the connected server>

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

1.1.2.4.2. Synchronize event changes back from


external client
If synchronization is supported by the external application, a REST web service client is needed to synchronize back event changes to
the Event Synchronization Web Service. The payload in this back synchronization is expected to comply with native OPR objects. With a
Groovy script configured for the connected server, the Groovy script interprets the payload that is defined by the client.

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

In the case of event get, the following data is relevant:

HTTP Method: GET

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event/<event_id>

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

In the case of event updates, the following data is relevant:

HTTP Method: PUT

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event/<event_id>

Ping request (from third-party client): HTTP HEAD to base URL

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.

See also the topic Event update: Logfile Adapter examples.

Event Change Creation

In the case of event changes, the following data is relevant:

HTTP Method: POST

Base URL: https://<server.example.com>/rest/9.10/synchronization/event_change/<event_id>

Ping request (from third-party client): HTTP HEAD to base URL

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.

Web Service Ping Request

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:

HTTP Method: HEAD

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization

Expected Payload: None

Event List Updates


The following URLs point to the sub-path event_list . Requests to this sub-path do not call the Groovy script and always have input or
output of OPR data structures, for example, OprEvent and OprEventList .

Event Get

In the case of event get, the following data is relevant:

HTTP Method: GET

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_list/<event_id>

Payload returned:

The payload is always an OprEvent object.

The Groovy script is not called for the sub-path event_list .

Event Update

In the case of event updates, the following data is relevant:

HTTP Method: PUT

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_list/<event_id>

Payload received and returned:

The payload received must be an OprEvent object.

The payload returned is always an OprEvent object.

The Groovy script is not called for the sub-path event_list .

See also the topic Event update to event_list example.

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:

HTTP Method: POST

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_list

Payload received:

The payload must be an OprEvent or OprEventList object.

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

For an OprEventList object, the media type must be text/xml;type=collection or application/xml;type=collection .

The Groovy script is not called for the sub-path event_list .

See also the topic Event submit examples.

Event List Changes


The following URLs point to the sub-path event_change_list . Requests to this sub-path do not call the Groovy script and always have
input or output of OPR data structures, for example, OprEvent and OprEventList .

Event Change Creation

In the case of event changes to the sub-path event_change_list , the following data is relevant:

HTTP Method: POST

Base URL: https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_change_list/

Payload received:

The payload received must be an OprEventChange or OprEventChangeList object..

For an OprEventChangeList object, the media type must be text/xml;type=collection or application/xml;type=collection .

The Groovy script is not called for the sub-path event_change_list .

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

1.1.2.4.3. Event attributes that support back


synchronization
Supported Attribute Updates

Update Create Delete

Attribute Name Supported Operations

annotation Yes Yes

assigned_user Yes set to null

assigned_group Yes set to null

cause Yes set to null

custom attribute Yes Yes

description Yes Yes set to null

priority Yes

severity Yes

solution Yes

state Yes

title Yes set to null

control_transferred_to Yes set to null

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

1.1.2.4.4. Event update: Logfile Adapter examples


The examples showing event updates in this section are specific to the Logfile Adapter (the sample Groovy script adapter provided with
the product), and would work only for the Logfile Adapter, or for accessing the Event Synchronization Web Service directly without
having a Groovy script configured for the target connected server.

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:

RestWsUtil -update update.xml-url "https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event/0695624b-93fa-40b1-8b0fc9b4ea07a4


ec" -username logger -password Password1 -verbose

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.

Note: An Event REST WS sample is located at:

<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.

An Event REST WS template is located at:

<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.

Set and Unset the Event 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.

Example: Set the Description

Here is a sample payload to set the description:

<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<description>This is a new description</description>
</event>

Example: Unset the Description

Here is a sample payload to unset the description:

<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<description/>
</event>

Set and Unset the Event 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 106
AI Operations Management - Containerized 24.4

operations are not supported.

Example: Set the Title

Here is a sample payload to set the title:

<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title>This is a new title</title>
</event>

Example: Unset the Title

Here is a sample payload to unset the title:

<event xmlns="http://www.hp.com/2009/software/opr/data_model">
<title/>
</event>

Change Multiple Properties in One Call


The Event Synchronization Web Service supports sending multiple properties in a single payload. Here we show just two changed
properties.

Example: Set Title and Description

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

1.1.2.4.5. Event change creation: Logfile Adapter


examples
You can submit event changes with an event change creation. The HTTP method, in this case, is POST, and the expected payload for
the LogfileAdapter is an OprEventChange . The examples in this section show sample XML payloads for each supported update. If a
Groovy script is not configured for the connected server, the Event Synchronization Web Service expects an OprEventChange object.
Each of the samples that follow represents an OprEventChange object.

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

An example call for an event change creation is shown below.

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:

RestWsUtil -create create.xml-url "https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_change/<event id>" -username logger


-password Password1 -verbose

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.

Example: Insert an Annotation

Here is a sample payload showing an annotation insert:

<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>

Example: Update an Annotation

Here is a sample payload showing an update to an annotation with the ID of 1c108839-9584-45f4-93ab-798bf49797c7 :

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.

Example: Set the Cause of an 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>

Example: Unset the Cause of an Event

Here is a sample payload showing how to unset the cause of an 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>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.

Example: Insert a Custom Attribute

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>

Example: Update a Custom Attribute

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.

Example: Set the Description

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>

Example: Unset the Description

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 .

Example: Set the State

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 .

Example: Set the Priority

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 .

Example: Set the Severity

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.

Example: Set a Solution

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>

Example: Unset a Solution

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

operations are not applicable for title changes.

Example: Set the Title

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>

Example: Unset the Title

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>

Change Multiple Properties in One Call


The Event Synchronization Web Service supports sending multiple properties in a single payload. Here, we show two changed
properties.

Example: Set the Title and Description

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

1.1.2.4.6. Event update to event_list example


You can update events using OPR data structure only (and not call the Groovy script). To update events using OPR data structures, call
update using the event_list sub path. The payload is the same as, for example, the standard put.

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

1.1.2.4.7. Event Submit Examples


You can submit new events using the URL https://<server.example.com>/opr-web/rest/9.10/event_list . The HTTP method in this case is the
POST method and the expected payload is an OprEvent or OprEventList . For an OprEventList object, the media type must be text/xml;type
=collection or application/xml;type=collection .

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.

Submit a New Event


Here is a sample payload showing submittal of a single 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>
</event>

Submit a New Event with Synchronization Requested


Here is a sample payload showing an event submittal with synchronization requested:

<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>

Submit a New Event with Synchronization and Transfer Control


Requested
Here is a sample payload showing an event submittal with synchronization and transfer control requested:

<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>

Submit a List of New Events

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

The media type for OprEventList objects must be text/xml;type=collection or application/xml;type=collection .

Here is a sample payload showing submittal of a list of events:

<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

1.1.2.4.8. Event change creation for


event_change_list examples
You can submit new events changes using the URL https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_change_list .
The HTTP method in this case is the POST method and the expected payload is an OprEventChange or OprEventChangeList . For an OprEve
ntChangeList object, the media type must be text/xml;type=collection or application/xml;type=collection .

The following samples show the XML payload. The correct HTTP method to set is the POST method.

Submit a New Event Change


Here is a sample payload showing submittal of a title 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>title</property_name>
<current_value xsi:type="xs:string">Some title for the event.</current_value>
</string_property_change>
</changed_properties>
</event_change>

Submit a List of New Event Changes


The media type must be text/xml;type=collection or application/xml;type=collection .

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

1.1.2.4.9. Event synchronization web service


troubleshooting
This section contains information to help you troubleshoot using the event synchronization web service interface.

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

1.1.2.5. Event Web Service Interface


The REST-based Event Web Service enables integrators to programmatically automate operator functions and detect event changes.
Most operations that an operator can do in the console while working on events can be done programmatically, to improve efficiency,
and enable integration with external applications.

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

1.1.2.6. Monitoring Automation Web Service Interface


The REST- based Monitoring Automation Web Service enables integrators to access the following Monitoring Automation functionality
from an external application:

List all management template, aspect, or policy template assignments.


List all automatic assignments for a view.
List all assignments of a certain management template, aspect, or policy template.
List all management template, aspect, or policy template assignments to a certain CI.
List all automatic assignments to a certain management template or aspect version.
List all management templates or aspects assignable for a view.
List all management templates and aspects assignable to a certain CI.
List all deployment jobs created as a result of an assignment.
Find status and parameter information for a certain assignment of a management template, aspect, or policy template.
Create, update, and delete assignments of management templates, aspects, or policy templates.
Create, update, and delete automatic assignments of management templates or aspects.
List available management templates, allowing filtering by CI type or management template ID.
List available aspects, allowing filtering by CI type or aspect ID.
List available policy templates, allowing filtering by template ID.

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:

Use the Monitoring Automation Web Service interface


Monitoring Automation Web Service interface reference
Examples

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

1.1.2.6.1. Use the Monitoring Automation Web


Service interface
This section describes several aspects to be considered when using the Monitoring Automation Web Service interface.

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.

Object references embedded in the response


Objects returned in the response include several references that you can use in subsequent requests involving the referenced object.

id and <target_id>

The XML tags id and <target_id> represent the object ID and the ID of a referenced object, respectively.

self and <target_href>

The XML tags self and <target_href> represent the object URL and the URL of a referenced object, respectively.

type and <target_type>

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

XML structure of automatic assignments


You can manage automatic assignments by using the Monitoring Automation Web Service Interface. The following examples show the
XML structure for different requests:

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

Input (a draft object):

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:

Parameter values can be of the type string , numeric , password , or enum .

Certain XML tags are only visible in verbose mode. Examples of these are the following tags:

Possible enumeration values of enum parameters.

Minimum and maximum values of numeric parameters.

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 /assignment_list/draft/ci/<CIID>/management_template_version/<MTVersionID> request contains only


parameters that are relevant to the CI with ID <CIID> ; parameters that are contained in the management template with version ID
<MTVersionID> that does not apply to this CI are omitted.

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_default : Set to the value false if the parameter was overwritten.

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.

Literals take precedence over calculated values.

We recommend never changing model_property , in order to avoid ambiguities with regard to the property's CI type and
resolvability.

The following parameter attributes can be modified:

value

model_property

Creation of additional instances for a multi-instance parameter.

All other parameter attributes are for information only.

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.

Security of passwords passed as parameter values

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.

Recommended Procedure for Creating POST Requests


The encoding used for XML requests and responses does not depend on the type of request. This enables a response to be reused for a
POST request creating an assignment.

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:

1. Execute a GET request for the assignment to be created:


To create an assignment differing from an existing assignment only in the value of a few parameters, it is useful to start with
an /assignment_list/<assignmentID> request, resulting in a response containing all parameter values for the assignment with ID
<assignmentID> .
To start an assignment from scratch, use the GET /assignment_list/draft/ci/<CIID>/management_template_version/<MTVersionID>
request, which results in a response representing a draft of the input needed for the assignment creation request (the same
procedure can be applied to aspects and policy templates). The draft contains all parameters contained in the management
template <CIID> to be assigned, initialized to their default values. Alternatively, you can use the URL parameter useExisting=t
rue in the draft call to use parameters from an existing assignment to the same CI and configuration artifact.
2. Modify the response by overwriting the parameter values to be changed in the assignment to be created.
3. Post the modified response as a POST /assignment_list request to create the new assignment.

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

Schema and Class Information


XML schema

The following file contains the XML schema used for encoding object information:

<OBM_HOME>/opr/api/schema/OprDataModel.xsd

JAXB annotated classes

The following file contains the JAXB annotated classes:

<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

Verbose and Minimal Mode


The level of detail in the input and output data for a web service request can be determined by specifying verbose or minimal mode:

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

1.1.2.6.2. Monitoring Automation Web Service


interface reference
This section provides reference information for the Monitoring Automation (MA) Web Service interface.

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/

<serviceURL> The individual URL of the Monitoring Automation web service:

<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();

The value of the secure modify token as set in the set-cookie.

X-Secur JAVA code example extracting and passing the token:


e-Modif
Object header = response.getHeaders().get("Set-Cookie"); for(String cookie : (List<String>)header) { cookie = cookie.substring(0,
y-
cookie.indexOf(";")); String cookieName = cookie.substring( 0, cookie.indexOf("=")); String cookieValue = cookie.substring( cookie.ind
Token
exOf("=") + 1, cookie.length() ); if(cookieName.equalsIgnoreCase("secureModifyToken")) break; }response = client.target(URL).header("
Authorization","Basic " +encodedUserPassword).header(X-Secure-Modify-Token",cookieValue).post(xml);

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

/<autoassignmentID> is omitted: List all current automatic assignments in the database.

GET /<autoassignmentID> is specified: Get the automatic assignment with ID<autoassignmentID


>.

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.

Delete the management template or aspect automatic assignment with ID <autoassignmentID


>.
DELETE
/<autoassignmentID> must be specified.

/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.
>

Get a draft for creating a management template automatic assignment:

If management_template/<MTID> is used, the latest version of the specified


/auto_assignment_list/draft/view/<viewN management template is assigned.
ame>/{management_template/<MTID>| If management_template_version/<MTVersionID> is used, the specified management
GET
management_template_version/<MTVer template version is assigned.
sionID>}
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.

Get a draft for creating an aspect automatic assignment:

/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.

/<assignmentID> is omitted: List all current assignments in the database.

/<assignmentID> is specified: Get the assignment with ID<assignmentID> .

GET The 9.20 web service available at <Server>:<port>/opr-config-server/rest/ws/9.20/assignment


_lists only retrieves a list of management template assignments, while the 10.11 web service,
available at <Server>:<port>/opr-config-server/rest/ws/10.11/assignment_lists , retrieves a list
of all types of assignments.

/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> .

Note: The 9.20 web service available at <Server>:<port>/opr-config-server/rest/ws/9.20/assig


/assignment_list/ci/<CIID> GET nment_lists only retrieves a list of management template assignments, while the 10.11 web
service, available at <Server>:<port>/opr-config-server/rest/ws/10.11/assignment_lists ,
retrieves a list of all types of assignments.

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

Get a draft for creating an assignment:

If management_template/<MTID> is used, the latest version of the specified

/assignment_list/draft/ci/<CIID>/manage management template is assigned.

ment_template/{<MTID>| management_ GET If management_template_version/<MTVersionID> is used, the specified management

template_version/<MTVersionID>} template version is assigned.

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>

Get a draft for creating an assignment:

/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/<aspectID> GET List all assignments of the aspect with ID <aspectID> .

/assignment_list/aspect_version/<aspect
GET List all assignments of the aspect with version ID <aspectVersionID> .
VersionID>

Get a draft for creating an assignment:

If template/<templateID> is used, the latest version of the specified template is


/assignment_list/draft/ci/<CIID>/templat assigned.
e/{<templateID> | template_version/<te GET If template_version/<templateVersionID> is used, the specified template version is
mplateversionID> assigned.

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>

Neither <DeploymentJobID> nor assignment/<AssignmentID> is specified: List all


deployment jobs in the database.

/deployment_job_list[/{<DeploymentJobI <DeploymentJobID> is specified: Retrieve the deployment job with ID <DeploymentJobID> .


GET
D> | assignment/<AssignmentID>}]
<assignment/AssignmentID> is specified: List all deployment jobs created as a result of the
assignment with ID <AssignmentID> .

<MTID> is omitted: List all management templates in the database.

/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>

<aspectID> is omitted: List all aspects in the database.

/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

/aspect_list/ci/<CIID> GET List all aspects assignable to the CI with ID <CIID> .

/aspect_list/view/<viewName> GET List all aspects assignable for a view.

<aspectVersionID> is omitted: List all versions of all aspects in the database.


/aspect_version_list[/<aspectVersionID>
GET <MTVersionID> is specified: Retrieve the aspect with the version ID <aspectVersionID>
]

<templateID> is omitted: List all policy templates in the database.


/template_list[/{<templateID>}] GET
<templateID> is specified: List all versions of the policy template with ID <templateID> .

<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.

Scenario 1: Monitor a new CI


Recommended workflow (same can be applied for aspects and policy templates):

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>

Alternatively, list the management templates assignable to the CI:

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

Scenario 2: Delete all assignments to a CI


Recommended workflow:

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.

Scenario 3: Temporarily disable monitoring of a CI


Recommended workflow:

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>

b. Modify the response by setting the is_enabled flag to false .

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 .

Scenario 4: Change a parameter value in an existing assignment


Recommended workflow:

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.

c. Modify the response by modifying the content of node value as desired.

d. Post the response using the following request to update the assignment:

POST assignment_list

Scenario 5: Change a parameter value in an existing automatic


assignment
Recommended workflow:

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.

c. Modify the response by modifying the content of node value as desired.

d. Post the response using the following request to update the automatic assignment:

POST /auto_assignment_list

Scenario 6: Update automatic assignments to a new management


template version
Recommended workflow:

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

The response contains a list of automatic assignments.

b. For each automatic assignment to be updated, determine the versionId and assignedViewName values and proceed with the
following steps:

1. Show the management template version object:

GET /management_template_version_list/<versionId>

In the response, determine the managementTemplateId .

2. Depending on the management template version, do one of the following:

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

Scenario 7: Update automatic assignments to a new aspect version


Recommended workflow:

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

The response contains a list of automatic assignments.

b. For each automatic assignment to be updated, determine the versionId and assignedViewName values and proceed with the
following steps:

1. Show the aspect version object:

GET /aspect_version_list/<versionId>

In the response, determine the aspectId .

2. Depending on the aspect version, do one of the following:

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 8: Update assignments to a new management template version


The following scenario is divided into two options, one reusing existing parameter values, and the other without reusing existing
parameter values.

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:

GET /assignment_list/draft/ci/ <CIID> /aspect_version/ <newAspectV> ?useExisting=true

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

Scenario 9: Determine which assignment parameters are mandatory


Recommended workflow (the same procedure can be used for aspect or policy template assignments):

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.

Scenario 10: Verify whether deployment was successful


Recommended workflow:

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>

b. Examine the response:

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

1.1.2.7. Status Web Service Interface


The REST based Status web service enables you to remotely retrieve health information (HIs and KPIs) of CIs. Only the JSON format is
supported.

Access
To access the Status web service, use the following base URL and syntax:

https://<baseURL>/<request>

The URL of the Status web service is:

<baseURL> <server>:<port>/topaz/api/urest/v2/ci_status

where <server> is the name of the OBM server.

<request> The service request.

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> .

?filter=ciId IN (“<ci id>”, “<ci i


GET Returns CI statuses and a list of KPIs for all the CIs specified by <ci id> within the brackets.
d>”,…)

Supported operators are EQ and IN . You can further filter the results based on status. Syntax: ​filter=status EQ <status>

For example, ?filter=view EQ <view name>&filter=status EQ major

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:

&view=condense GET Returns only CI status.

&view=summary GET Default. Returns CI status and a list of KPIs.

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

&view=expand GET Returns CI status, a list of KPIs, and a list of HIs.

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:

Group by status: ?filter=<filter-criteria>&groupBy=status


Group by ciType and status, get only counts: ?filter=<filter-criteria>&groupBy=ciType,status&view=countOnly
Group by view: ?filter=view IN ("view2", "view2", ...)&groupBy=view

Security and authorization


To operate the Status web service, a user must be assigned a role with the Service Health Rest permission. This permission enables
the user to view CI Names and IDs (global and local) while using the status web service. To use the < view name > option, a user must
have adequate permission on the view in the RTSM. For more information on permissions, see the Administer section.

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

1.1.2.8. Tool Execution Web Service Interface


The REST- based Tool Execution web service enables integrators to access the following functionality from an external application:

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.

How to Access the Tool Execution Web Service


Your entry point to the web service interface is the service document, using the following base URL and syntax:

https://<serviceURL>/<req
uest>

The URL of the Tool Execution web service:

<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.

List of Services in the Service Document

OPR Tool Web Services URL

Tool Web Service preview POST https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution_preview/{contextId}

GET | DELETE https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/{contextId}

Tool Web Service query tools POST https://<server>:<port>/opr-web/rest/10.11/tool_execution

Tool Web Service preparation POST https://<server>:<port>/opr-web/rest/10.11/tool_execution/preparation

DELETE https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/{contextId}/{resultId}

Security and Authorization


To be able to access the Tool Execution web service, a user needs to be assigned a role with the correct level of Tools (Execution)
permission. This permission can be accessed in the Operations Console category of the permission section of a role. For more
information on permissions, see the topic Users, Groups, and Roles.

Error Handling
Error handling for the Tool Execution web service is as follows:

HTTP error codes:

HTTP error code 403: authorization problems


HTTP error code 409: requested hosts are not in the RTSM or no CIs match the requirements
HTTP error code 4xx (other than 403, 409): any form of communication problems with the OBM backend
HTTP code 200: at least one requested host is in the RTSM and meets the requirements

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

opr-tool Command-Line Interface


Tool Execution Web Service request reference
Users, Groups, and Roles

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

1.1.2.8.1. Tool Execution Web Service request


reference
Request reference
The Tool Execution web service interface supports the following requests:

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:

<tool_preparation xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<tool_id> your_tool_id</tool_id>
<ci_ids>
<ci_id>your_ci_id</ci_id></ci_ids>
<!-- mandatory; multiple ci_id-tags can be used.-->
<ci_origin>ci</ci_origin>
</tool_preparation>

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

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<!-- the newly created context ID --></id>
<tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<tool_execution_result_ref></tool_execution_result_ref></id></tool_ref>
<id>
<!-- the newly created reference ID for a single target CI --></id>
<execution_host>
<tool_command></tool_command></execution_host></tool_execution_context>

Execute a tool:

POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>

Input:

<tool_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


</tool_execution>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<tool_ref>
<target_id></target_id>
<label></label>
<description></description></tool_ref></id>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<user_parameters/></user_parameters>
<run_as_username></run_as_username>
<tool_execution_result_ref></tool_execution_result_ref>
<execution_host>
<tool_command></tool_command></execution_host>
</tool_execution_context>

Retrieve execution status for all concerned CIs:

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

<tool_execution_result xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description></id></tool_ref>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type>
<execution_host></execution_host></tool_type>
<tool_command>
<user_parameters></user_parameters>
<run_as_username></run_as_username></tool_command>
<tool_execution_state>
<started>
<started_text></started_text></started>
<finished>
<finished_text></finished_text></finished></tool_execution_state>
<executed_in_context_of>
<entry></entry>
<key></key>
<value></value>
<output></output>
<result_code></result_code></executed_in_context_of>
</tool_execution_result>

Retrieve execution status for a single CI:

GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>/<resultID>

<tool_execution_result xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description></id></tool_ref>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type>
<execution_host></execution_host></tool_type>
<tool_command>
<user_parameters></user_parameters>
<run_as_username></run_as_username></tool_command>
<tool_execution_state>
<started>
<started_text></started_text></started>
<finished>
<finished_text></finished_text></finished></tool_execution_state>
<executed_in_context_of>
<entry></entry>
<key></key>
<value></value>
<output></output>
<result_code></result_code></executed_in_context_of>
</tool_execution_result>

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

Input (when specifying CI IDs):

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

<tool_preparation xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<tool_id>
<ci_ids>
<ci_id>
<!-- mandatory; multiple ci_id-tags can be used.--></ci_id></ci_ids></tool_id>
<ci_origin></ci_origin>
</tool_preparation>

Input (when specifying event IDs):

<tool_preparation xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<tool_id></tool_id>
<event_ids>
<event_id><!-- mandatory; multiple event_id-tags can be used.--></event_id></event_ids>
<ci_origin><!-- mandatory; has one of the following values: event_related_ci, event_node, or event_source_ci --></ci_origin>
</tool_preparation>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<tool_ref></tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description></id>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<user_parameters>
<entry></entry>
<key>
<value></value>
<entry></entry></key>
<key>
<value></value>
<entry></entry></key>
<key>
<value></value></key></user_parameters>
</tool_execution_context>

Retrieve a list of tools applicable for a given CI:

POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution

Input:

<tool_query xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<ci_ids>
<ci_id>
<!-- mandatory; multiple ci_id-tags can be used.--> </ci_id></ci_ids>
</tool_query>

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

<tool_list xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<tools_for_ci></tools_for_ci></id>
<tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description></id></tool_ref>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description></id></tool_ref>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<tool_ref>
<id>
<target_id></target_id>
<label></label>
<description></description></id></tool_ref>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
</tool_list>

Retrieve a list of tools applicable for a given event (specified by ID):

POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution

Input:

<tool_query xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<event_ids>
<event_id>
<!-- mandatory; multiple ci_id-tags can be used.--></event_id></event_ids>
</tool_query>

Output:

<tool_list xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<tools_for_event_related_ci>
<!-- Only appears if there is at least one tool associated with related CI of the specified event --></tools_for_event_related_ci></id>
<tool_ref>
<!-- Information for one or multiple tools like above --></tool_ref>
<tools_for_event_node>
<!-- Only appears if there is at least one tool associated with the node on which the related CI of the event is hosted --></tools_for_event_node>
<tool_ref>
<!-- Information for one or multiple tools like above --></tool_ref>
<tools_for_event_source_ci>
<!-- Only appears if there is at least one tool associated with the source CI of the event --></tools_for_event_source_ci>
<tool_ref>
<!-- Information for one or multiple tools like above --></tool_ref>
</tool_list>

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>

<tool_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<user_parameters>
<entry></entry>
<key>
<value></value></key></user_parameters>
</tool_execution>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<tool_ref></tool_ref></id>
<id>
<target_id></target_id>
<label></label>
<description></description></id>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<user_parameters>
<entry></entry>
<key>
<value></value>
<run_as_username></run_as_username></key></user_parameters>
<tool_execution_result_ref>
<id>
<execution_host></execution_host>
<tool_command></tool_command></id></tool_execution_result_ref>
</tool_execution_context>

Cancel tool execution for all affected nodes:

POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextID>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<tool_ref></tool_ref></id>
<id>
<target_id></target_id>
<label></label>
<description></description></id>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<user_parameters>
<entry></entry>
<key>
<value></value>
<run_as_username></run_as_username></key></user_parameters>
<tool_execution_result_ref>
<id>
<execution_host></execution_host>
<tool_command></tool_command></id></tool_execution_result_ref>
<started>
<started_text></started_text></started>
</tool_execution_context>

Cancel execution for a single CI:

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:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>
<tool_ref></tool_ref></id>
<id>
<target_id></target_id>
<label></label>
<description></description></id>
<tool_type>
<has_user_parameter></has_user_parameter>
<requires_run_as_user></requires_run_as_user>
<name></name>
<ci_type></ci_type></tool_type>
<user_parameters>
<entry></entry></user_parameters>
<key>
<value></value>
<entry></entry></key>
<key>
<value></value></key>
<tool_execution_result_ref>
<id>
<execution_host></execution_host>
<tool_command></tool_command></id></tool_execution_result_ref>
<started>
<started_text></started_text></started>
</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 148
AI Operations Management - Containerized 24.4

1.1.2.9. User Management Web Services Interface


Note

Users cannot be created in containerized OBM. Create users using IDM


portal.

The User Management Web Services enable integrators to access the following user management functionality from an external
application:

Create, update, or delete a user.


List all current users in the database, allowing filtering by user ID.
List all time zones that can be used when setting up new users.
Create, update, or delete a user group.
List all available user groups in the database.
List all groups available for LDAP mapping, as specified during LDAP setup.
Create, update, or delete a role in the database.
List all current roles in the database.
List all roles which are assigned to the user with the specified ID.
List all roles which are assigned to the user group with the specified ID.
List all available authorizable resources that can be set in a role.
Create or delete an event category.
List available event categories, allowing filtering by category ID.

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.

How to Access the User Management Web Services


Your entry point to the web service interface is the Service Document, using the following base URL and syntax:

https://<serviceURL>/<req
uest>

The URL of the User Management web services:

<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.

List of OPR Administration Services in the Service Document

OPR Administration Service URL

User Service: https://<server>:<port>/opr-web/admin/rest/10.01/user_object_list

User Service: https://<server>:<port>/opr-web/admin/rest/10.01/user_object_list/{id}

Time Zone Service: https://<server>:<port>/opr-web/admin/rest/10.01/time_zone_list

User Group Service: https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list/{id}

User Group Service: https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list

LDAP User Group Service: https://<server>:<port>/opr-web/admin/rest/10.01/ldap_group_list

User Role Service: https://<server>:<port>/opr-web/admin/rest/10.01/role_list

User Role Service: https://<server>:<port>/opr-web/admin/rest/10.01/role_list/{id}

User Role Service: https://<server>:<port>/opr-web/admin/rest/10.01/role_list/user/{id}

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

OPR Administration Service URL

User Role Service: https://<server>:<port>/opr-web/admin/rest/10.01/role_list/user_group/{id}

Authorizable Resource Service: https://<server>:<port>/opr-web/admin/rest/10.01/auth_resource_list

Event Category Service: https://<server>:<port>/opr-web/admin/rest/10.01/event_category_list

Event Category Service: https://<server>:<port>/opr-web/admin/rest/10.01/event_category_list/{id}

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

1.1.2.9.1. User Management Web Services request


reference
The User Management Web Services interface supports the following requests:

User service
Request Request Type Web Service Action

/<userID> is omitted: List all current users in the database.


/user_object_list[/{userID}] GET
/<userID> is specified: Get the user with ID<userID> .

Create a user as specified in the posted XML data.

/user_object_list[/{userID}] POST Note:

/<userID> must be omitted.

Delete the user with ID <userID> .

/user_object_list[/{userID}] DELETE Note:

/<userID> must be specified.

Edit the user with ID <userID> .

/user_object_list[/{userID}] PUT Note:

/<userID> must be specified.

Time zone service


Request Request Type Web Service Action

/time_zone_list GET Lists all time zones that can be used when setting up new users.

User group service


Request Request Type Web Service Action

/<userGroupID> is omitted: List all current user groups in the database.


/user_group_list[/{userGroupID}] GET
/<userGroupID> is specified: Get the user group with ID<userGroupID> .

Create a user group as specified in the posted XML data.

/user_group_list[/{userGroupID}] POST Note:

/<userGroupID> must be omitted.

Delete the user group with ID <userGroupID> .

/user_group_list[/{userGroupID}] DELETE Note:

/<userGroupID> must be specified.

Edit the user group with ID <userGroupID> .

/user_group_list[/{userGroupID}] PUT Note:

/<userGroupID> must be specified.

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 user group service


Request Request Type Web Service Action

/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.

User role service

Request
Request Web Service Action
Type

/role_list[/< /<roleID> is omitted: List all current roles in the database.


GET
roleID>] /<roleID> is specified: Get the role with ID<roleID> .

Create a role as specified in the posted XML data.

Note:

/<roleID> must be omitted.

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 .

Delete the role with ID <roleID> .


/role_list[/<
DELETE Note:
roleID>]
/<roleID> must be specified.

Edit the role with ID < roleID >.

/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}

Authorizable resource service


Request Request Type Web Service Action

/auth_resource_list GET Lists all available authorizable resources that can be set in a role.

Event category service


Request Request Type Web Service Action

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

/<categoryID> is omitted: List all current event categories in the database.


/event_category_list[/{categoryID}] GET
/<categoryID> is specified: Get the event category with ID<categoryID> .

Create an event category as specified in the posted XML data.

/event_category_list[/{categoryID}] POST Note:

/<categoryID> must be omitted.

Delete the event category with ID <categoryID> .

/event_category_list[/{categoryID}] DELETE Note:

/<categoryID> must be specified.

Edit the event category with ID <categoryID> .

/event_category_list[/{categoryID}] PUT Note:

/<categoryID> must be specified.

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>

2. Get all available resources and operations:

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:

Example: Grant permissions to all LDAP users

1. Prerequisite. LDAP mapping settings must be configured with "Automatically create LDAP users" and "Add new users to
groups".

2. Submit the following POST request.

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".

2. List all available LDAP 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.

3. Submit the following POST request:

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>

6. Query to which groups a user belongs:

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}

<user_object xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">


<id>c58e8046-825e-4023-8091-c05d76ef7138</id>
<version>0</version>
<login>ingroup</login>
<name>user in group</name>
<email_address>[email protected]</email_address>
<time_zone>America/La_Paz</time_zone>
<ldap_user>false</ldap_user>
<super_administrator>false</super_administrator>
<inactive>false</inactive>
<user_object_to_role_list>
<user_object_to_role>
<role>
<id>626529a9-6cd2-494d-be64-38833b73ff77</id>
<version>2</version>
<name>DB Expert Role</name>
<description>Expert permission for databases.</description>
</role>
</user_object_to_role>
</user_object_to_role_list>
<user_group_list>
<user_group>
<id>76ac4edb-1d29-4e42-9fee-d14fc732b02f</id>
<version>1</version>
<name>MiddleGroup</name>
<event_assignment>true</event_assignment>
<ldap_auto_assignment>false</ldap_auto_assignment>
</user_group>
</user_group_list>
</user_object>

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

7. Retrieve roles assigned to users or groups:

Retrieve all roles assigned to a specific user

GET- https://<server>:<port>/opr-web/admin/rest/10.01/role_list/user_object/{ID}

Retrieve all roles assigned to a specific group

GET- https://<server>:<port>/opr-web/admin/rest/10.01/role_list/user_group/{ID}

8. Remove a user from a group:

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>

2. Remove the user with ID 00000000-0000-0000-95ac-ae0c2214712b

<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.

9. Delete a group or a set of groups:

Delete a single group

DELETE - https://<server>:<port>/opr-web/admin/rest/10.01/user_group_list{groupID}

Delete a set of groups

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

1.1.2.9.3. User Management Web Service


troubleshooting
This section contains information to help you troubleshoot using the user management web service interface.

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

1.1.3. Groovy scripts


OBM supports script-based customization. Using scripts enables adding functionality to the OBM process flow in situations where the
required functionality is not provided in OBM or cannot be added using the standard OBM tools and configuration options.

How this section is organized


This section documents where and how Groovy scripts can be added. It includes the following parts:

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.

Introduction to customization scripts


The following aspects are critical to developing successful customization scripts:

Script Execution Trigger

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.

Script Execution Process Location

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 Programming Practices

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

1.1.3.1. Best practices


The tips in this section will help you to develop high-quality scripts.

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.

Cache Data Wherever it Improves Performance


Caching data that takes time to retrieve is a useful way to speed up performance. Examples are data from resources external to the
synchronization process, such as RTSM data, data from user databases, and data from files.

Caching comprises the following operations:

1. Connecting to the external resource.


2. Loading the data from the resource and storing it in a data structure in memory, which typically has a much shorter access time.
The data in memory is called cache data.
3. Using the data in the custom process.
4. Disconnecting from the external resource.
5. Removing the cached data from memory.

Typically, connecting to and loading from the external resource are the most time-consuming steps.

When implementing caching, consider the following aspects:

Avoiding is better than fixing, so try to minimize dependency on external resources:


When contemplating using external data, contemplate whether it is really necessary or not.
If data is available or derivable from an internal resource, don't use an external resource.
If data is available or derivable from a number of external resources, use the minimum number of resources.
If data is available or derivable through a number of different APIs, use the API with the fastest performance.
Cache only data that is likely to be reused. CI data is likely to be reused, and should be cached in most situations. It is not
recommended, however, to always cache all available CI data. If your script only uses events associated with a certain type of CI,
for example, you could apply a filter to cache relevant events only. Try to find a balance, however, between caching only data that
would be reloaded against increasing code complexity, which could decrease process performance due to the need to evaluate
numerous if and case conditions.
Connecting to an external resource needs to be done only once. The best place to connect to resources containing data used
throughout the script is in the script class's init() method. Disconnect in the destroy() method. Code inside the process() method
can then directly access the resource.
Loading the data will usually be done while using the code, because different data is needed in different places. However, if you
reuse the same data over and over again, you could use the init() method to connect, load the data to a local array, and
disconnect right away.
Having a resource open and storing data in memory uses system resources. To optimize resource usage you may want to connect
the first time data is accessed and disconnect after loading in the process() method; this is just as fast, as long as you connect
only once. Keep in mind, however, that it is always better to optimize script performance for absolute time than to minimize
system resource usage.
After finishing debugging, remove any logging code which is not necessary in the production environment from the script to avoid
unnecessary overhead.

Avoid Using Slow APIs and Functions


Do not use APIs known to have slow performance characteristics in performance critical code. Most notably, pay attention to the
performance of APIs when inserting custom scripts in the event pipeline.
Access the RTSM using its JAVA API, which has a better performance than other APIs such as SOAP-based web services APIs.
It is not permitted to use shell functions such as System.exit() . Shell function calls cause the JVM, which executes the Groovy script,
to be stopped and restarted.
Perform time-consuming processes in background threads wherever possible.

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

Improving code quality


The quality of your code has a direct impact on the ease with which the resulting script can be integrated and maintained.

Debug Your Scripts to Minimize Potential Problems


Running problematic scripts can lead to performance issues, even if the code executes. In-depth testing and debugging is necessary to
produce robust scripts that are safe to use in your production environment.

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.

Facilitating writing code


The following tips help you make writing Groovy scripts for OBM as easy as possible.

Use an External Editing Tool


The OBM administration screens that are used to configure scripts on the platform are useful to manage the script, but are not
sufficient to edit, maintain, test and debug scripts. You must rely on an external editing tool to create a more versatile editing
environment

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.

Use Script Templates


Script templates and examples are available in the directories where scripts can reside. Starting a new script from a template rather
than from scratch makes it easier to follow the script format rules and make it less you forget something.

Be Careful with Copy-and-Paste


Be careful with copy-and-paste from emails, PDF files or Microsoft Word documents.

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

1.1.3.2. Development and deployment of scripts


This section includes examples of where you can use scripts and explanations for triggers, process flow, best practices, and script
management. You can find the pages placed under this topic that contain this information.

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

1.1.3.2.1. View script log messages


OBM supports script based customization. You can use Groovy scripts to add functionality to the OBM process flow where the required
functionality is unavailable or you can’t add it using the standard OBM tools and configuration options.

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.

During connection errors, you can see the following message:

The system has lost the connection and is attempting to reconnect.

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.

To view script log messages on the user interface

Follow the steps to view the script log message:

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

Event Processing Customizations

Time-Based Event Automation

Event Automation Scripts

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

1.1.3.2.2. Event Processing Interface scripts


The Event Processing Interface (EPI) enables you to run user-defined Groovy scripts during event processing. Actions include
modification and enhancement of events using data external to the EPI process. You could, for example, add data from an external SQL
database.

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.

To configure an event forwarding script and activate it:

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

1. In OBM, navigate to Event Processing Customizations:

Administration > Event Processing > Automation > Event Processing Customizations

The screen contains two panes:

1. Event Processing Scripts‚

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. A script must be contained in a class.

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. The class does not inherit any properties or methods.

Example of a class declaration:


class EpiBeforeStoringEvents{ ... }

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.

Best practices specific to EPI scripts


To minimize the impact of EPI scripts on the performance of OBM processing, consider the following aspects:

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

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

1.1.3.2.3. Custom Action scripts


Custom actions can be executed for events that are selected in the OBM Event Browser.

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:

1. In OBM, navigate to Custom Actions:

Administration > Operations Console > Custom Actions

The screen contains two panes:

1. Custom Action Scripts ?

This pane lists the configured scripts.

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

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.

To activate a script, click the checkbox Activate after save.

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

1.1.3.2.4. Certificates Scripts


From version 9.2x, you can automatically process certificate requests using a script. The following functions are available:

Grant the request.


Deny the request.
Ignore the request, leaving it to be granted or denied manually.

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.

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 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.

To configure a certificate script:

1. In OBM, navigate to the Certificate Requests manager:

Administration > Setup and Maintenance > Certificate Requests

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.

To activate the script, click Activate Item.

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

needed, deactivate the Autogrant Script script by clicking Deactivate Item.

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

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

1.1.3.2.5. Service Health scripts


Service health scripts are used to implement business logic rules used to calculate Key Performance Indicators (KPI), to evaluate the
health status of managed networks, their components, and the services associated with them.

Service health scripts are executed as part of the Marble process.

Script Management
To configure a business rule and use it for KPI calculation:

1. In OBM, navigate to Business Rules:

Administration > Service Health > Business Rules

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

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

1.1.3.2.6. Topology Synchronization scripts


The topology synchronization package enables you to include user-defined Groovy scripts in the topology synchronization process.

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.

Logging information is written to the following log file:

<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 add, remove, or change a script:

1. Place the completed or changed script in the following folder:

<OMi_HOME>/conf/opr/topology-sync/sync-packages/<Sync Package Name>

To remove a script:

1. Use the sdtool command to remove the script from the database.

2. Delete the script from the file system.

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

Best practices specific to topology synchronization scripts


When developing topology synchronization scripts, consider the following aspects:

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

myCI = createCI( caption:"myCI" )


to return an ICi implementation without exposing the CI class, rather than using
new CI(...) myCI
See also the topic Available APIs.

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.

msg = "Sync Ready! ${iChanges} CIs modified!";


scriptInterface.exec( "sendmail Administrator " + msg );

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

1.1.3.2.7. Event forwarding scripts


Event forwarding scripts forward events to Northbound applications. The main use of event forwarding scripts is to build adapters to
external systems.

Event forwarding scripts tend to be more complicated than other scripts, because they need to be able to handle the following types of
operations:

Forwarding events arriving in the pipeline.


Forwarding updates to events.
Receiving and forwarding changes to events.
Supporting correlation of events to processes running on the external server receiving the forwarded events.
Supporting the exchange of external information required by the script, such as information gleaned from web service calls,
information provided by command line tools, or information written to log files by the script.

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();

Boolean ping(final PingArgs args);

/* The following method can be customized */


Boolean receiveChange(final ReceiveChangeArgs args);
Boolean getExternalEvent(final GetExternalEventArgs args);
Boolean forwardEvents(final ForwardEventArgs args);
Boolean forwardChanges(final ForwardChangeArgs args);
String toExternalEvent(final OprEvent event);
}

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:

PUT requests to:

/opr-gateway/rest/synchronization/event/<event ID>

POST requests to:

/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:

GET request to:

/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.

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 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.

To configure an event forwarding script and activate it:

1. In OBM, navigate to Event Forwarding:

Administration > Event Processing > Automation > Event Forwarding

Along with the Administration Menu, the screen contains two panes:

1. Event Forwarding Rules

This pane lists the configured event forwarding rules. Active scripts are shown in black, non active scripts in gray.

2. Details

This pane shows the properties of the selected rule.

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.

By default, the following rules are installed:

Automatically forward "downtime started" events to Trouble Ticket System


Automatically Forward to Trouble Ticket System

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

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

1.1.3.2.8. External Instruction Retrieval Scripts


External instruction retrieval scripts are used to get the event instructions from external interfaces, such as knowledge bases or
databases. OBM triggers the execution of an instruction retrieval script when at least one specified event filter matches the event
selected in the Event Browser (the instructions are retrieved when you select the Instructions tab in the Event Details pane).

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.

To configure an instruction retrieval script:

1. Navigate to the External Instructions manager:

Administration > Operations Console > External Instructions

The screen contains two panes:

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.

2. Use the toolbar in the Scripts pane if you want to:

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.

Activate/deactivate a script by clicking Activate Item or Deactivate Item .

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.

// always include following check for each event


if(Thread.interrupted())
throw new InterruptedException()

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 section provides two instruction retrieval Groovy scrip samples.

A sample instruction retrieval Groovy script:

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) ]
}
}
}

A sample instruction retrieval Groovy script with the HTML output:

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 """&ltl><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

1.1.3.3. Reference information


This section contains reference information related to Groovy scripts, or links to reference information in case the information itself is
already documented elsewhere.

The following information is included:

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

1.1.3.3.1. Groovy console


The best way to develop and debug Groovy scripts is by using the Groovy console.

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.

2. Click Advanced System Settings. The System Properties dialog opens.

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.

The Groovy Console looks like the following figure:

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:

1. Open the file %GROOVY_HOME%\conf\groovy-starter.conf in a text editor.

2. Make sure a line with the following format is active (if necessary, add or uncomment it):

load !{user.home}/.groovy/lib/*.jar

3. If you made changes, save the file.

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

For OBM customizations, the following libraries are often needed:

Apache Commons Libraries

<install>/lib/commons-*.jar

This library Includes general functions such as the logging function log4j .

JSON Library

<install>/lib/json.jar

For parsing and generating JSON code.

<install>/lib/opr-external-api.jar

<install>/lib/opr-common.jar

RTSM Topology APIs

<install>/lib/ucmdb-api.jar

Compatibility with OBM


OBM supports Groovy versions listed in the following table. Features contained in later versions of Groovy are not supported.

OBM (ex OMi) Version Latest Compatible Groovy Version

10.62 and later 2.4.8

10.60 and 10.61 2.4.7

10.10 2.4.5

10.0x 2.2.1

9.13, 9.2x 1.7.3

1.6.0 for EPI and Custom Action scripts.


9.10, 9.11 and 9.12
1.7.3 for other scripts.

1.6.0 for EPI and Custom Action scripts.


9.01
1.5.6 for other scripts.

Debugging using the Groovy console


The following tips can help you when testing and debugging Groovy scripts:

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:

private static Log s_log = LogFactory.getLog("com.hp.opr.epi.MyLogs")

Notes for logging to Apache:

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:

s_Log.error("Attempt to get event failed; HTTP status: ${response.statusCode}")

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

1.1.3.3.2. Available APIs


This section details the available platform and external APIs:

External APIs
Functions Used in EPI Scripts
API for Topology Synchronization Scripts
API for Service Health Rules

External APIs
API

Applications Java JDK

Generic JDBC access for functions such as the following:

Establishing a connection to the database.


Connecting with data sources.
Handling SQL Exceptions.
Creating and populating tables.
Retrieving and modifying data.
Using database transactions.

For details, see the Oracle tutorial on JDBC basics.

General Web Service access.

Use function URL.openConnection()

Command line tools. rowspan='4'|Apache

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.

Functions Used in EPI Scripts


The Groovy script API with full documentation of all arguments and types can be found in the Java API Documentation delivered with the
product. It can be found in the following directory:
<OMi_HOME>/opr/api/doc .

For detailed information about developing EPI scripts, see the topic Event Processing Interface.

API for Topology Synchronization Scripts


For more information about the interfaces and object types required for developing your own topology synchronization scripts, see the
following Java API documents:

<OMi_HOME>/opr/api/doc/opr-external-api-javadoc.zip
<OMi_HOME>/opr/api/doc/opr-ts-interfaces-javadoc.zip

The following is a list of externally visible types and functions.

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

The IScriptingInterface interface is accessible through the variable scriptInterface .


The ISyncData accessible through the variable syncData .

For detailed information about developing topology synchronization scripts, see the topic Integrate topology data.

API for Service Health Rules


For detailed information about developing service health rules, see the topic Monitor Event Type and Health Indicators.

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

1.1.4. Service Health


This section describes how to use the Rules API to create new business rules. These define how Key Performance Indicators (KPIs) are
calculated.

This section is structured as follows:

Service Health Rules API


Service Health External APIs

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

1.1.4.1. Service Health Rules API


Note: In OMi versions 9.00 and later, the rules that calculate indicator statuses and values based on samples (API Sample Rule and API
Duration-Based Sample Rule) are used to calculate metric-based health indicators (HIs).
Throughout the Rules API documentation, you will see references to various methods used to calculate KPIs. In OMi versions 9.00 and
later, when calculating sample-based values, these methods are used to calculate metric-based HIs.

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

Service Health API Rules


These are the types of Service Health API rules:

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.

Creating API Rules


Rules can be created using the Rules API in these ways:

Using the CI Customizations page to create a rule for a specific KPI.


Using a text file to create a new rule for multiple KPIs.
Using a clone of an API rule in the Rule Repository to create a new rule.

These ways are described in the topic Create rules with the Rules API.

Tooltips and Log Files


To display KPI information in tooltips when working with the Rules API, see the topic Work with tooltip entries.

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

1.1.4.1.1. API Group and Sibling Rule


An API Group and Sibling Rule calculates KPIs based on data received from other indicators, rather than from original sample data. The
received data can come from the KPIs of child CIs, or from other KPIs or HIs associated with the same CI.

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 .

Group and Sibling Rule Methods and Fields


The Group and Sibling rule implements the Rules API Interface GroupAndSiblingCalculator, using the following guidelines:

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.

Defining a Group and Sibling Rule in the CI Customizations page or Rule


Repository
To define a Group and Sibling rule by using the CI Customizations page or within the Rule Repository, enter the calculateKPI method
implementation in the KPI Calculation Script area.

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.

Accessing a Specific Child KPI in the CI Customizations Page


When creating a Group rule for a specific KPI in the CI Customizations page, to access a specific child KPI, the API includes a
mechanism to simplify the code. When defining your KPI Calculation Script, you can enter the format "<CI name>"."<KPI name>".

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

Defining a Group and Sibling Rule Using a Text File


To define a Group and Sibling rule using a text file, use the DashboardGroupAndSiblingTemplate.groovy template as described in
the topic Create a text file-based API rule .

Within the text file, enter the calculateKPI method body.

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

1.1.4.1.2. API Sample Rule


A Sample 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 parameter.

Sample Rule Methods and Fields


The Sample rule implements the Rules API Interface LeafCalculator, using the following guidelines:

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|

Defining a Sample Rule in the CI Customizations page or Rule Repository


To define a Sample rule by using the CI Customizations page or within the Rule Repository, fill in the fields as follows:

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.

Defining a Sample Rule Using a Text File


To define a Sample rule using a text file template, use the DashboardSampleRuleTemplate.groovy template file as described in
the topic Create a text file-based API rule .

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

1.1.4.1.3. API Duration-Based Sample Rule


A Duration-Based Sample rule calculates KPIs based on original data taken from sample fields; the duration rule parameter defines
which samples are included in the calculation. For example, if duration is defined as fifteen minutes, all samples collected during the
last fifteen minutes are included in the calculation.

Duration-Based Sample Rule Methods and Fields


The Duration-Based Sample rule implements the Rules API Interface LeafCalculator, using the following guidelines:

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|

Defining a Duration-Based Sample Rule in the CI Customizations page or


Rule Repository
To define a Duration-Based Sample rule by using the CI Customizations page or within the Rule Repository, fill in the fields as follows:

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.

Defining a Duration-Based Sample Rule Using a Text File


To define a Duration-Based Sample rule using a text file template, use the DashboardDurationBasedSampleRuleTemplate.groovy
template file as described in the topic Create a text file-based API rule .

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

1.1.4.1.4. Create rules with the Rules API


There are a number of ways to create rules using the Rules API, as described in the following section.

Define a rule for a specific KPI by using the CI Customizations page


Each Service Health KPI has these applicable API rules: API Group and Sibling Rule, API Sample Rule, or API Duration-Based Sample
Rule. From the CI Customizations page, you can assign one of the API rules to a KPI, and enter a calculation script (and other rule
details) to define rule logic for that KPI.

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.

Create a rule using a text file


For each of the API rules (Group and Sibling Rule, Sample Rule, or Duration-Based Sample Rule) there is a corresponding template file,
located in the <Data Processing server root directory>\BLE\rules\groovy\templates directory. You can use one of the template
files to create a text file defining a new rule. You then add this rule to the Rule Repository, and it can 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.

For details, see the topic Create a text file-based API rule .

Define a rule within the Rule Repository


The Rule Repository contains three API rules: API Group and Sibling Rule, API Sample Rule, or API Duration-Based Sample Rule. You can
use the Rule Repository to clone an API rule and enter a calculation script (and other rule details) to define the rule logic.

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

1.1.4.1.5. Define an API rule in the CI Customizations


page
Within the CI Customizations page, assign one of the API rules to a KPI, and enter the calculation script (and other rule details) to define
the rule logic for that KPI.

1. Assign an API rule to a KPI

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.

2. Define the KPI's rule logic

Depending on the type of rule you are creating, define the rule methods and fields as described in:

API Group and Sibling Rule

API Sample Rule

API Duration-Based Sample Rule

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

1.1.4.1.6. Create a text file-based API rule


There are three rule template files corresponding to the three API rules; each template implements the rule's interface.

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.

1. Create a text file for a rule

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:

API Group and Sibling Rule

API Sample Rule

API Duration-Based Sample Rule

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.

2. Add a business rule

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.

d. Create rule parameters depending on your API rule type, as follows:

In the Parameters area, click New Parameter.

For API Sample rules:

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.

Click Apply to save.

For API Duration-Based Sample rules:

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.

Click Apply to save.

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.)

In the Thresholds section, select Calculate severity based on predefined thresholds .

Set the threshold values for each operator by using the + and - buttons.

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
.

4. Add tooltip parameters to the new tooltip

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.

5. Reload rules after editing the text file

If you make changes to the text file at any time after the rule is created, perform the following steps to apply the changes.

a. In the browser, access the JMX port 29800.

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

API Sample Rule


API Duration-Based Sample Rule
Business Rules
Work with tooltip entries

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

1.1.4.1.7. Define an API rule in the rule repository


Within the Business Rule Repository, create an API rule that can be applied to multiple KPIs. This is done by cloning one of the three API
rules, and setting default rule values for specific rule parameters. After the rule is applied to a KPI, you can edit its script within the CI
Customizations page at any time to change the rule logic for the specific KPI.

1. Clone an API rule

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.

For details on cloning a rule, see the topic Business Rules.

2. Edit rule details

a. Open the new rule for editing.

b. In the Name field, rename the cloned 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):

API Group and Sibling Rule

API Sample Rule

API Duration-Based Sample Rule

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.1.4.1.8. Work with tooltip entries


The following section describes how to work with Tooltip entries to display information calculated by the Rules API.

1. Go to:

Administration > Service Health > Business Rules

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:

Tooltip Parameter Value

Business Rule NODE.DIM.RULE.ID_CUST

CI name NODE.PROPS.BamNodeNameKey

Last Status Change NODE.DIM.RESULT.LastStatusChange

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

1.1.4.1.9. Write to log files from the Rules API code


Write to log files from the Rules API code

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.

To write to log files using the Rules API:


1. Within the rule method, implement one of the following methods (listed in ascending order of severity):

logger.debug("<API rule name> : log message");

logger.info("<API rule name> : log message");

logger.warn("<API rule name> : log message");

logger.error("<API rule name> : log message");

logger.fatal("<API rule name> : log message");

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):

groupAndSiblingRule.log (for API Group and Sibling rules)

sampleRule.log (for API Sample rules)

durationBasedSampleRule.log (for API Duration-Based sample rules)

To modify the severity level written to a log file:


1. By default, only log method invocations of error and fatal severity are written to log files. To modify this setting, open the log
configuration file located in <OMi_HOME_DPS>/conf/core/Tools/log4j/marble_supervisor/dashboard_rules.properties .
2. In the line corresponding with your rule type, replace the string ${dashboard_rules_Loglevel} with the severity level you want
logged (either DEBUG, INFO, WARN, ERROR, or FATAL). Edit one of the following lines, depending on your rule type:
Group and Sibling rules:
logger.com_mercury_am_rules_dashboard_blDashboardRules_simplifiedRule_groupAndSiblingRule_DashboardGroupAndSiblingRule.level =
${dashboard_rules_Loglevel}, bam.app.rules.api.group.appender
Sample rules:
logger.com_mercury_am_rules_dashboard_blDashboardRules_simplifiedRule_leaf_DashboardSimplifiedSampleBasedRule.level = ${dashboa
rd_rules_Loglevel}, bam.app.rules.api.leafsample.appender
Duration-Based Sample rules:
logger.com_mercury_am_rules_dashboard_blDashboardRules_simplifiedRule_leaf_DashboardSimplifiedTimeBasedRule.level = ${dashboard
_rules_Loglevel}, bam.app.rules.api.leafduration.appender

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

1.1.4.1.10. Include a CI property in Rules API


calculations
Within your API rules, you can include CI properties using the CI class getPropertyValue method, and the KPI class getCiProperty
method. Only CI properties with one of the following qualifiers can be accessed with this method:

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:

<Attribute name="<attribute-name>" type="double" display-name="<attribute-display-name>">


<Attribute-Qualifiers>
<Attribute-Qualifier name="BLE_ATTRIBUTE"/>
</Attribute-Qualifiers>
</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

1.1.4.1.11. Examples - API Sample Rule


This section provides examples of API Sample Rules.

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

1.1.4.1.11.1. Example - Average Availability Rule


The following rule calculates average availability of samples, based on the u_iStatus sample field.

The rule logic is (available samples / total samples) * 100.

// This rule uses the u_iStatus sample field.


def sampleFields = ["u_iStatus"];
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples) {
// Keep total number of samples for this calculation cycle.
def totalSamples = samples.size();
// Create a variable to count available samples.
def availableSamples = 0;
/**
* 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) {
// Increase the count of available samples.
availableSamples++;
}
}
if (totalSamples > 0) {
// Set KPI value, converted to percentage.
kpi.setValue ((availableSamples/totalSamples)*100.0);
}
}

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

1.1.4.1.11.2. Example - Average Performance Rule


The following rule calculates average performance in seconds, based on the dResponseTime and u_iStatus sample fields.

Only samples with a u_iStatus value of 0 (available samples) are used in the calculation. The rule logic is: sum(dResponseTime) /
available samples.

// This rule uses the u_iStatus and dResponseTime sample field.


def sampleFields = ["u_iStatus", "dResponseTime"];
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples) {
// Create a variable to count available samples.
def availableSamples = 0;
// Create a variable to sum response times of available samples.
def totalResponseTime = 0;
/**
* 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) {
// Increase the count of available samples.
availableSamples++;
// Add the current 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

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

1.1.4.1.12. Example - Average Performance Rule


Using a Rule Parameter Filter
The following rule calculates average performance in seconds, based on the dResponseTime and u_iStatus sample fields.

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.

The rule logic is: sum(dResponseTime) / available samples.

/ This rule use the u_iStatus and dResponseTime sample fields.


def sampleFields = ["u_iStatus", "dResponseTime"];
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples) {
// Create a variable to count available samples.
def availableSamples = 0;
// Create a variable to sum response times of available samples.
def totalResponseTime = 0;
/**
* Get the value of the rule parameter named "Response time limit"
* from the KPI, as defined for the KPI in Service Health Admin.
* This rule parameter is optional, so responseTimeLimit can be null.
*/
Long responseTimeLimit = kpi.getRuleParameter("Response time limit")

/**
* 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

1.1.4.1.13. Examples - API Group and Sibling Rule


This section provides examples of API Group and Sibling Rules.

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

1.1.4.1.13.1. Example - Worst Child Rule


The following rule finds the worst status from all of the KPIs of the calculated CI's child CIs, which are of the same type as the calculated
KPI, based on active statuses only. Active statuses are Critical, Major, Minor, Warning, and OK.

public void calculateKPI(CI ci, KPI kpi) {


// Get the calculated KPI's type ID (as defined in the Service Health KPI Repository).
int kpiId = kpi.getType();
// Get a list of all of the KPIs of the calculated CI's child CIs, which are of the same
// type as the calculated KPI.
List<KPI> childKpiList = ci.getChildrenKPIsByID(kpiId);
// Create a variable to set the status of the calculated KPI,
// only if an active status is found.
boolean isActiveStatusFound = false;
// Set the current worst status to OK; if a worse status is found this will be updated.
Status worstStatus = Status.OK;
// Go over the list of child KPIs.
childKpiList.each{KPI childKPI->
// Get the child KPI's status.
Status childKpiStatus = childKPI.status;
// Check if the child KPI's status is an active status.
if(childKpiStatus.isActive()){
// Mark that an active status was found.
isActiveStatusFound = true;
// Check if the child KPI's status is worse than the current worst status.
if(childKpiStatus.isWorse(worstStatus)){
// Update the worst status.
worstStatus = childKpiStatus;
}
}
}
// Check if an active status was found in the child KPI.
if(isActiveStatusFound){
// Set the calculated KPI status.
kpi.setStatus(worstStatus);
}
}

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

1.1.4.1.13.2. Example - Worst Sibling Status Rule


Example - Worst Sibling Status Rule

The following rule finds the worst status from sibling KPIs, based on active statuses only. Active statuses are Critical, Major, Minor,
Warning, and OK.

public void calculateKPI(CI ci, KPI kpi) {


// Get a list of all the KPIs for the CI.
List<KPI> ciKpiList = ci.getAllKPIs();
/**
* Create a variable to set the status of the calculated KPI,
* only if an active status is found.
*/
boolean isActiveStatusFound = false;
// Set the current worst status to OK; if a worse status is found this will be updated.
Status worstStatus = Status.OK;
// Go over the list of the CI's KPIs.
ciKpiList.each {KPI ciKPI ->
/**
* Check that the CI's KPI is not the calculated KPI.
* This is needed because getAllKPIs method returns all the KPIs for the CI.
*/
if (ciKPI != kpi) {
/**
* The ciKPI represents a sibling KPI of the calculated KPI.
* Get the sibling KPI's status.
*/
Status siblingKpiStatus = ciKPI.status;
// Update worstStatus if necessary.
if (siblingKpiStatus.isActive()) {
isActiveStatusFound = true;
if (siblingKpiStatus.isWorse(worstStatus)) {
worstStatus = siblingKpiStatus;
}
}
}
}
// Check if an active status was found in the sibling KPI.
if (isActiveStatusFound) {
// Set the calculated KPI's status.
kpi.setStatus(worstStatus);
}
}

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

1.1.4.1.13.3. Example - Specific Child CI Group Rule


Example - Specific Child CI Group Rule

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.

public void calculateKPI(CI ci, KPI kpi) {


/**
* Get the Availability KPI for the child CI "tx_10 from virtual_host_3".
* The RTSM ID of "tx_10 from virtual_host_3" is "96c2df2b544683c7f79bb382d1d7b3a9".
*
* Note: Within the UI, the following line can be written as
* KPI childKPI = "tx_10 from virtual_host_3"."Availability"
*/
KPI childKPI = ci.getChildKpiByChildId(KpiType.Availability, "96c2df2b544683c7f79bb382d1d7b3a9");

// 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) {

// Check if the child KPI has a value.


if (childKPI.valueExist) {
if (childKPI.value == 100.0) {
kpi.status = Status.OK
}
else {
kpi.status = Status.CRITICAL
}
}
}
}

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

1.1.4.1.13.4. Example - Sibling Rule Based on


Availability and Performance KPIs
Example - Sibling Rule Based on Availability and Performance KPIs

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.)

public void calculateKPI(CI ci, KPI kpi) {


/**
* Get the sibling KPI of type Availability.
* If Availability KPI does not exist, null will be returned.
*/
KPI availabilityKPI = ci.getKPI(KpiType.Availability);
// Get the sibling KPI of type Performance.
KPI performanceKPI = ci.getKPI(KpiType.Performance);
if (availabilityKPI != null && performanceKPI != null) {
// Both KPIs exist for this CI. Check if the KPIs status is active.
if (availabilityKPI.status.isActive() && performanceKPI.status.isActive()) {
// Check the KPI's status.
if (availabilityKPI.status == Status.OK &&
performanceKPI.status == Status.OK) {
/**
* Both statuses are active and both are OK. Set this KPI's status to OK.
*/
kpi.status = Status.OK
}
else {
/**
* Both statuses are active, and not both are OK.
* Set this KPI's status to CRITICAL
*/
kpi.status = Status.CRITICAL
}
}
}
}

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

1.1.4.1.13.5. Example - Group Average Value by CI


Type
Example - Group Average Value by CI Type

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.

public void calculateKPI(CI ci, KPI kpi) {


// Get the calculated KPI's type ID (as defined in the Service Health KPI Repository).
int kpiId = kpi.getType();
// Get a list of the KPIs of the child CIs, which are of the same CI type as the calculated
// KPI, whose CI type is "unix".
List<KPI> unixChildKpiList = ci.getChildrenKPIsByIDAndCiType(kpiId, "unix")
// Create a variable to sum the total values from child KPIs.
// If no child exists or no child has value the variable will remain null.
Double totalChildValue = null;
// Write information to the log file.
logger.debug("DashboardGroupAvgValueByCiTypeRule : number of child CIs with type unix: " + unixChildKpiList.size())
// Go over the list of child KPIs.
unixChildKpiList.each {KPI childKPI ->
// Sum values of the child KPIs using the Utils class, which handles null values.
totalChildValue = Utils.sum(totalChildValue, childKPI.value);
}
// Set the calculated KPI's value to the average value, using the Utils class.
// If totalChildValue is null, null value will be set.
kpi.value = Utils.divide(totalChildValue, unixChildKpiList.size());
}

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

1.1.4.1.13.6. Example - Worst Health Indicator Rule


The following rule finds the worst status from all of the health indicators (HIs) of the calculated CI, based on active statuses only. Active
statuses are Critical, Major, Minor, Warning, and OK.

public void calculateKPI(CI ci, KPI kpi) {


// Get all health indicators.
List<HI> his = ci.getHIs();
// Create a variable to set the status of the calculated KPI,
// only if an active status is found.
boolean isActiveStatusFound = false;
// Set the current worst status to OK;
// if a worse status is found this will be updated.
Status worstHiStatus = Status.OK;
his.each {HI hi ->
Status hiStatus = hi.getStatus();
// Check if the current HI status is an active status.
if (hiStatus.isActive()) {
// Mark that an active status was found.
isActiveStatusFound = true;
// Check if the child KPI's status is worse than the current worst status.
if (hiStatus.isWorse(worstHiStatus)) {
// Update the worst status.
worstHiStatus = hiStatus;
}
}
}
// Check if an active status was found in the child KPI.
if (isActiveStatusFound) {
// Set the calculated KPI status.
kpi.setStatus(worstHiStatus);
}
}

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

1.1.4.1.13.7. Example - Using Groovy Closure


The following rule sets the calculated KPI's status to Critical, if at least one Availability KPI with Major status exists for the calculated
CI's child CIs.

This rule illustrates Groovy Closure. Refer to the Groovy documentation for more information.

public void calculateKPI(CI ci, KPI kpi) {


/**
* Use Groovy Closure with the CI class getChildrenKPIs method,
* to get List of KPIs from the CI`s child CIs, where
* 1. KPI type is Availability
* 2. Status is MAJOR

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.
*/

List<KPI> kpiList = ci.getChildrenKPIs {KPI childKPI ->


childKPI.type == KpiType.Availability.getID("DASHBOARD") && childKPI.status == Status.MAJOR
}
// Check if such a KPI exists.
if (kpiList.isEmpty()) {
// No such KPI exists.
// Write to a log file at debug level.
logger.debug "Closure Rule: no Availability KPI with MAJOR status exist"
}
else {
// At least one Availability KPI with MAJOR status exists.
logger.debug("Closure Rule: At least one Availability KPI with MAJOR status exist")
// Set calculated KPI status to CRITICAL.
kpi.status = Status.CRITICAL;
}
}

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

1.1.4.2. Service Health External APIs


This section includes:

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

1.1.4.2.1. Retrieve Indicator Data API


The following external API can be used to access KPI over time statuses, KPI definitions, and indicator statuses.

The service log file is located under: <OBM_HOME>/log/webapps/serviceHealthExternalAPI.log .

Return values are supported in XML and JSON formats.

Authentication should be done using the basic access authentication method. For details and examples see the related Wikipedia
article.

Get KPI Over Time Statuses


You can use the following to get KPI over time statuses.

API Syntax

https://<Gateway Server>/topaz/servicehealth/customers/<Customer Id>/


kpiOverTime?ciIds=<CI ID>&startDate=<Start Date>&endDate=<End Date>

The API uses the following parameters:

customerId. Customer ID (use 1 for other SaaS deployment).


ciId. Mandatory; use comma-separated CI IDs.
startDate. Mandatory; start time for the KPI status (value representing the date in milliseconds since January 1 1970).
endDate. Mandatory; end time for the KPI status (value representing the date in milliseconds since January 1 1970).
kpiId. Optional; use comma-separated KPI internal IDs as in the repository UI (default is empty for all KPIs).

The following is an example of the API and its output:

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>

The output fields are as follows:

Field Description

ciId CI ID

ciDisplayLabel CI display label

kpiType KPI ID

kpiDisplayName KPI display name

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)

statusDisplayName KPI status display name

duration Duration of the KPI's status in milliseconds.

Return Codes
The API returns the following return codes:

Name Error Code

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

Name Error Code

INTERNAL_
500
SERVER_ERROR

Get Indicator Statuses


You can use the following to retrieve indicator statuses.

API Syntax

https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/
repositories/indicators/statuses

The API uses the following parameter:

customerId. Customer ID (use 1 for other SaaS deployment).

The following is an example of the API and its output:

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>

The output fields are as follows:

Field Description

id KPI status internal ID

name KPI status name

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:

Name Error Code

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

1.1.4.2.2. 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 might want to reset the HI's state to Normal (default). For details on
resetting HI state within Service Health, see the topic Health Indicators Component.

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.

This REST API is case-sensitive and uses the PUT method.

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:

https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/cis/<CI ID>/his/reset

To reset a specific HI:

https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/cis/<CI ID>/his/<HI name>/reset

To reset a specific subcomponent of an HI:

https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/cis/<CI ID>/his/<HI name>/reset?subcomponent=<subcomponent


name>

HI name refers to the name of the HI as defined in the indicator repository, and not to the HI's display label.

Return Codes and Log File


The API returns the following return codes:

Name Error Code

OK 200

UNAUTHORIZED 401

NOT_FOUND 404

INTERNAL_
500
SERVER_ERROR

The service log file is located under <OBM_HOME>/log/webapps/serviceHealthExternalAPI.log.

In addition, the service writes to the Audit log on each HI reset.

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

1.1.4.2.3. Service Health Database Query API


Service Health Database Query API

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:

https://<Gateway Server>/topaz/bam/BAMOpenApi?customerId=<customer ID>&userName=<user name>&password=<password>&command=


<command parameter>

Depending on the command parameter defined, additional parameters may also be included.

Main Parameters Used in the Query


The following table lists the parameters that must be defined in the query.

Parameter Description

customerID OBM customers should specify 1.

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.

Specify one of the following values:

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

1.1.5. RTSM Developer Reference


Operations Bridge Manager:24.4/DevRefGuideWelcome

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

1.1.5.1. Creating Discovery and Integration Adapters


Operations Bridge Manager:24.4/Part1DiscIntegAdapterDivider

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

1.1.5.1.1. Adapter Development and Writing


Operations Bridge Manager:24.4/AdapDevPatternWriting

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

1.1.5.1.1.1. Adapter Development and Writing


Overview
Prior to beginning actual planning for development of new adapters, it is important for you to understand the processes and
interactions commonly associated with this development.

The following sections can help you understand what you need to know and do to successfully manage and execute a discovery
development project.

The following sections:

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

1.1.5.1.1.2. Content Creation


Operations Bridge Manager:24.4/AdapdevCreateNewcontent

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

1.1.5.1.1.2.1. The Adapter Development Cycle


The following illustration shows a flowchart for adapter writing. Most of the time is spent in the middle section, which is the iterative
loop of development and testing.

Each phase of adapter development builds on the last one.

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:

Research and Preparation phase

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:

Use external tools/protocols to obtain the data

Develop how the adapter should create CIs based on the data

You now know what a similar adapter should look like

3. Determine most similar adapter based on:

Same CIs created

Same Protocols used (SNMP)

Same kind of targets (by OS type, versions, and so on)

4. Copy the entire package.

5. Unzip the package contents into the work space and rename the adapter (XML) and Jython (.py) files.

Adapter Development and Testing

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.

Startup and Preparation of Copy

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.

Development and Testing

Use other sample code to develop changes


Test adapter by running it
Use a dedicated view to validate complex results, search to validate simple results

Adapter Packaging and Productization


The Adapter Packaging and Productization phase accounts for the last phase of development. As a best practice, a final pass
should be made to clean up debugging remnants, documents, and comments, to look at security considerations, and so on, before
moving on to packaging. You should always have at least a readme document to explain the inner workings of the adapter. Someone
(maybe even you) may need to look at this adapter in the future and will be aided greatly by even the most limited documentation.

Cleanup and Document

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

1.1.5.1.1.2.2. Data Flow Management and Integration


DFM adapters are capable of integration with other products. Consider the following definitions:

DFM collects specific content from many targets.


Integration collects multiple types of content from one system.

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.

Discovery uses regular, CMDB CIs for input.

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.

From Universal CMDB to another project:

Create a TQL that produces the CIs and relations to be exported.

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:

Integration Type Reference Example to Be Reused

Access the product's database directly Microsoft SCCM

Read in a csv or xml file produced by an export Troux

Access a product's API BMC Atrium/Remedy

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

1.1.5.1.1.2.3. Associating Business Value with


Discovery Development
The use case for developing new discovery content should be driven by a business case and plan to produce business value. That is,
the goal of mapping system components to CIs and adding them to the CMDB is to provide business value.

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.

This drawing (or model) is referred to as the blueprint.

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

1.1.5.1.1.2.4. Researching Integration Requirements


The prerequisite of this stage is a blueprint of the CIs and relationships needed to be discovered by DFM, which should include the
attributes that are to be discovered. For details, see Adapter Development and Writing Overview .

Modifying an existing adapter


You modify an existing adapter when an out-of-the-box or field adapter exists, but:

It does not discover specific attributes that are needed


A specific type of target (OS) is not being discovered or is being incorrectly discovered
A specific relationship is not being discovered or created

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.

Writing a new adapter


A new adapter needs to be developed:

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.

Guidelines for choosing ways to access data


Relevance: Select sources or a combination of sources that provide the most data. If a single source supplies most information
whereas the rest of the information is scattered or hard to access, try to assess the value of the remaining information by comparison

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

To access Windows Registry data, you can use either WMI or


NTCMD.

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

1.1.5.1.1.3. Developing Integration Content


Before creating a new integration, you must understand what the integration's requirements are:

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?

If you answer yes to these questions, then Population is needed.

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 these questions, then Federation is needed.

Should the integration push data to remote data sources?

If you answer yes to these questions, then Data Push is needed.

Is the length of any CI's ID greater than 60 characters?

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.

The following options are available for creating integration adapters:

1. Jython Adapter:

The classic discovery pattern

Written in Jython

Used for population

For details, see Developing Jython Adapters.

2. Generic DB Adapter:

An abstract adapter based on the Java Adapter that uses the Federation SDK Framework.

Allows creation of adapters that connect to external data repositories.

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.

Suitable for jobs that connect to a single data source.

For details, see Developing Generic Database Adapters .

3. Generic Push Adapter:

An abstract adapter based on the Java Adapter (the Federation SDK Framework) and the Jython Adapter.

Allows creation of adapters that push data to remote targets.

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.

Suitable for jobs that connect to a single data target.

Used for Data Push.

For details, see Developing Push Adapters.

4. Enhanced Generic Push Adapter:

All the above features of the Generic Push Adapter

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

Maps a UCMDB tree data structure to a target tree data structure

For details, see Achieving Data Push using the Generic Adapter.

The following table displays the capabilities of each adapter:

Flow/Adapter Jython Adapter Generic DB Adapter Generic Push Adapter Enhanced Generic Push Adapter

Population Yes Yes No No

Federation No Yes No No

Data Push No No Yes Yes

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

1.1.5.1.1.4. Developing Discovery Content


Operations Bridge Manager:24.4/AdapDevDiscoveryContent

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

1.1.5.1.1.4.1. Discovery Adapters and Related


Components
The following diagram shows an adapter's components and the components they interact with to execute discovery. The components in
green are the actual adapters, and the components in blue are components that interact with adapters.

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

1.1.5.1.1.4.2. Separating Adapters


An entire discovery could be defined in a single adapter. But good design demands that a complex system be separated into simpler,
more manageable components.

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.1.5.1.1.5. Implement a Discovery Adapter


A DFM task has the aim of accessing remote (or local) systems, modeling extracted data as CIs, and saving the CIs to the CMDB. The
task consists of the following steps:

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.

2. Create a discovery job.

You configure a job with scheduling information and a trigger query. For details, see Step 2: Assign a job to the adapter.

3. Edit discovery code.

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

1.1.5.1.1.6. Step 1: Create an Adapter


An adapter can be considered as the definition of a function. This function defines an input definition, runs logic on the input, defines
the output, and provides a result.

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.

For details on input components, see Data Flow Management Concepts.

1. Define adapter input (Trigger CIT and Input Query)


You use the Trigger CIT and Input Query components to define specific CIs as adapter input:

Example of Replacing Variables with Actual Data:

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.

2. Define adapter output


The output of the adapter is a list of discovered CIs (Data Flow Management > Adapter Management > Adapter Definition
tab > Discovered CITs) and the links between them:

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.

Example of adapter output:

In this example, you define which CITs are to be part of the IP CI output.

1. Access Data Flow Management > Adapter Management .

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

2. In the Resources pane, select Network > Adapters > NSLOOKUP_on_Probe.

3. In the Adapter Definition tab, locate the Discovered CITs pane.

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.

3. Override adapter parameters


To configure an adapter for more than one job, you can override adapter parameters. For example, the adapter SQL_NET_Dis_Connection
is used by both the MSSQL Connection by SQL and the Oracle Connection by SQL jobs.

Example of overriding an adapter parameter:

This example illustrates overriding an adapter parameter so that one adapter can be used to discover both Microsoft SQL Server and
Oracle databases.

1. Access Data Flow Management > Adapter Management .

2. In the Resources pane, select Database_Basic > Adapters > SQL_NET_Dis_Connection.

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 .

5. Display the Properties tab. Locate the Parameters pane:

The all value is overwritten with the MicrosoftSQLServer value.

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.

4. Override probe selection - optional


On the UCMDB server there is a dispatching mechanism that takes the trigger CIs received by the UCMDB and automatically chooses
which probe should run the job for each trigger CI according to one of the following options:

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:

To manually specify which probe to use with the adapter:

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.

Select the adapter and click the Adapter Configuration tab.

Under Trigger Dispatch Options, select Override default probe selection.

In the box, enter the Probe in one of the following formats:

The name of the Probe.


Probe
To find the probe name, go to Local Client > Data Flow Management > Data Flow Probe Setup, in the Domains and
name
Probes pane, select your domain, then expand Data Flow Probes, you should be able to find the probe of your interest.

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.

IPv4 format: 16.59.63.86,DefaultDomain


IP,Domain
IPv6 format: 2001:0:9d46:953c:34a9:1e6b:f2ff:fffe,CustomDomain

Domain
The domain from which the Probe should be selected.
name

Configure a classpath for a remote process (optional)


For details, see Configure Remote Process Execution.

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

1.1.5.1.1.7. Step 2: Assign a Job to the Adapter


Each adapter has one or more associated jobs that define the execution policy. Jobs enable scheduling the same adapter differently
over different sets of Triggered CIs and also enable supplying different parameters for each set.

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).

Choose a Trigger TQL


Each job is associated with Trigger TQLs. These Trigger TQLs publish results that are used as Input Trigger CIs for the adapter of this
job.

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.

Set scheduling information


The scheduling information for the Probe specifies when to run the code on Trigger CIs. If the Invoke on new triggered CIs
Immediately check box is selected, the code also runs once on each Trigger CI when it reaches the Probe, regardless of future
schedule settings.

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.

Override adapter parameters


When configuring a job you can override the adapter parameters. For details, see Override adapter parameters.

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

1.1.5.1.1.8. Step 3: Create Jython Code


Operations Bridge Manager:24.4/AdapDevtstep3CreateJythoncode

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

1.1.5.1.1.9. Configure Remote Process Execution


You can run discovery for a discovery job in a process separate from the Data Flow Probe's process.

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

remoteJVMArgs JVM parameters for the remote Java process.

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.

Examples of remoteJVMClasspath customization:


remoteJVMClasspath
To prepend or append custom jars to the default Probe classpath. customize the remoteJVMClasspath parameter as
follows:

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.

To use the minimal classpath, customize the remoteJVMClasspath parameter as follows:

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

1.1.5.1.2. Developing Jython Adapters


Operations Bridge Manager:24.4/JythonAdapChapter

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

1.1.5.1.2.1. Data Flow Management API Reference


Operations Bridge Manager:24.4/JythonAdapDiscoveryAPIref

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

1.1.5.1.2.2. Create Jython Code


Universal CMDB uses Jython scripts for adapter-writing. For example, the SNMP_Connection.py script is used by the
SNMP_NET_Dis_Connection adapter to try to connect to machines using SNMP. Jython is a language based on Python and powered
by Java.

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

Scripts written for Universal Discovery should be compatible with Jython


version 2.7.2.

Related topics
For full documentation on the available APIs, see

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 256
AI Operations Management - Containerized 24.4

1.1.5.1.2.2.1. Use External Java JAR Files within


Jython
When developing new Jython scripts, external Java Libraries (JAR files) or third-party executable files are sometimes needed as Java
utility archives, connection archives such as JDBC Driver JAR files, or executable files (for example, nmap.exe is used for credential-
less discovery).

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

1.1.5.1.2.2.2. Execution of the Code


After a job is activated, a task with all the required information is downloaded to the Probe.

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

1.1.5.1.2.2.3. Modifying Out-of-the-Box Scripts


When making out-of-the-box script modifications, make only minimal changes to the script and place any necessary methods in an
external script. You can track changes more efficiently and, when moving to a newer Universal CMDB version, your code is not
overwritten.

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:

serverName = iplanet_cspecific.PlugInProcessing(serverName, transportHN, mam_utils)

The more complex logic that decides how to calculate this name is contained in an external script:

# implement customer specific processing for 'servername' attribute of httpplugin


#
def PlugInProcessing(servername, transportHN, mam_utils_handle):
# support application-specific HTTP plug-in naming
if servername == "appsrv_instance":
# servername is supposed to match up with the j2ee server name, however some groups do strange things with their
# iPlanet plug-in files. this is the best work-around we could find. this join can't be done with IP address:port
# because multiple apps on a web server share the same IP:port for multiple websphere applications
logger.debug('httpcontext_webapplicationserver attribute has been changed from [' + servername + '] to [' + transportHN[:5] + '] to facil
itate websphere enrichment')
servername = transportHN[:5]
return servername

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

1.1.5.1.2.2.4. Structure of the Jython File


The Jython file is composed of three parts in a specific order:

Imports
Main Function - DiscoveryMain
Functions definitions (optional)

The following is an example of a Jython script:

# 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.)

To import a Jython script:

import logger

To import a Java class:

from appilog.collectors.clients import ClientsConsts

Main function – DiscoveryMain


Each Jython runnable script file contains a main function: DiscoveryMain.

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

Example of a function calling another function:

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

1.1.5.1.2.2.5. Results Generation by the Jython Script


Each Jython script runs on a specific Trigger CI, and ends with results that are returned by the return value of the DiscoveryMain
function.

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 syntax


This section explains how to build the DFM results into a UCMDB model.

Example of setting attributes on the CIs:

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)

Line 1 creates a CI of type siebelappserver.


Line 2 creates an attribute called data_name with a value of sblsvrName which is a Jython variable set with the value
discovered for the server name.
Line 3 sets a non-key attribute that is updated in the CMDB.
Line 4 is the building of containment (the result is a graph). It specifies that this application server is contained inside a host
(another ObjectStateHolder class in the scope).

Note: Each CI being reported by the Jython script must include values for all the key attributes of the CI's CI Type.

Example of relationships (Links):

The following link example explains how the graph is represented:

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.

Example of vector (gathering CIs):

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

Sending large amounts of data


Sending large amounts of data (usually more than 20 KB) is difficult to process in UCMDB. Data of this size should be split into smaller
chunks before sending to UCMDB. In order for all the chunks to be correctly inserted into UCMDB, each chunk needs to contain the
required identification information for the CIs in the chunk. This is a common scenario when developing Jython integrations. The
sendObjects method is used to send the results in chunks. If the Jython script sends a large number of results (the default value is
20,000, but this value can be configured in the DataFlowProbe.properties File using the appilog.agent.local.maxTaskResultSize
key) it should chunk the results according to their topology. This chunking should be performed taking into account identification rules
so that the results are entered correctly in UCMDB. If the Jython script does not chunk the results, the probe attempts to chunk them;
however, this can lead to poor performance for a large result set.

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.

Example of using 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

1.1.5.1.2.2.6. The Framework Instance


The Framework instance is the only argument that is supplied in the main function in the Jython script. This is an interface that can be
used to retrieve information required to run the script (for example, information on trigger CIs and adapter parameters), and is also
used to report on errors that occur during the script run.

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

This section describes the most important Framework usages:

Framework.getTriggerCIData(String attributeName)
This API provides the intermediate step between the Trigger CI data defined in the adapter and the script.

Example of retrieving credential information:

You request the following Trigger CI data information:

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.

Example of creating a client instance for the credentials ID:

To create a Client instance for the credentials ID:

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.

Example of creating a WMI client and running a WMI query:

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:

<UCMDB root directory>\UCMDBServer\deploy\ucmdb-docs\docs\eng\APIs\DDM_Schema\webframe.html

Framework.getParameter (String parameterName)


In addition to retrieving information on the Trigger CI, you often need to retrieve an adapter parameter value. For example:

Example of Retrieving the Value of the protocolType Parameter:

To retrieve the value of the protocolType parameter from the Jython script, use the following API:

protocolType = Framework.getParameterValue('protocolType')

Framework.reportError(String message) and


Framework.reportWarning(String message)
Some errors (for example, connection failure, hardware problems, timeouts) can occur during a script run. When such errors are
detected, Framework can report on the problem. The message that is reported reaches the server and is displayed for the user.

Example of a report error and message:

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

1.1.5.1.2.2.7. Finding the Correct Credentials (for


Connection Adapters)
An adapter trying to connect to a remote system needs to try all possible credentials. One of the parameters needed when creating a
client is the credentials ID. The connection script gains access to possible credential sets and tries them one by one using the Framewor
k.getAvailableProtocols() method. When one credential set succeeds, the adapter reports a CI connection object on the host of this trigger
CI (with the credentials ID that matches the IP) to the CMDB. Subsequent adapters can use this connection object CI directly to connect
to the credential set (that is, the adapters do not have to try all possible credentials again).

Note

Access to sensitive data (passwords, private keys, and so on) is blocked for the following protocol types:

sshprotocol, ntadminprotocol, as400protocol, vmwareprotocol, wmiprotocol, vcloudprotocol, sapjmxprotocol, websphereprotocol,


siebelgtwyprotocol, sapprotocol, ldapprotocol, udaprotocol, ntcmdprotocol, snmpprotocol, jbossprotocol, telnetprotocol, powershellprotocol,
sqlprotocol, weblogicprotocol

Utilization of these protocol types should be done by using dedicated clients.

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

1.1.5.1.2.2.8. Handling Exceptions from Java


Some Java classes throw an exception upon failure. It is recommended to catch the exception and handle it, otherwise it causes the
adapter to stop unexpectedly.

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.

from java.lang import Exception as JException


try:
client = Framework.createClient(Framework.getTriggerCIData(BaseClient.CREDENTIALS_ID))
except JException, ex:
# process java exceptions only
Framework.reportError('Connection failed')
logger.debugException(str(ex))
return

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

1.1.5.1.2.3. Support Localization in Jython Adapters


Operations Bridge Manager:24.4/JythonAdapterLocalization

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

1.1.5.1.2.3.1. Add Support for a New Language


This task describes how to add support for a new language.

1. Add a Resource Bundle (*.properties Files)

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:

Job Base Name of Resource Bundle

File Monitor by Shell langFileMonitoring

Host Resources and Applications by Shell langHost_Resources_By_TTY, langTCP

Hosts by Shell using NSLOOKUP in DNS Server langNetwork

Host Connection by Shell langNetwork

Collect Network Data by Shell or SNMP langTCP

Host Resources and Applications by SNMP langTCP

Microsoft Exchange Connection by NTCMD, Microsoft Exchange Topology by NTCMD msExchange

MS Cluster by NTCMD langMsCluster

For details on bundles, see Work with resource bundles.

2. Declare and Register the Language Object

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.

a. Declare the language, as follows:

LANG_RUSSIAN = Language(LOCALE_RUSSIAN, 'rus', ('Cp866', 'Cp1251'), (1049,), 866)

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.

b. Register the language by adding it to the following collection:

LANGUAGES = (LANG_ENGLISH, LANG_GERMAN, LANG_SPANISH, LANG_RUSSIAN, LANG_JAPANESE)

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

1.1.5.1.2.3.2. Change the Default Language


If the OS language cannot be determined, the default one is used. The default language is specified in the shellutils.py file.

#default language for fallback


DEFAULT_LANGUAGE = LANG_ENGLISH

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.1.5.1.2.3.3. Determine the Character Set for


Encoding
The suitable character set for decoding command output is determined at runtime. The multi-lingual solution is based on the following
facts and assumptions:

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

1.1.5.1.2.3.4. Define a New Job to Operate With


Localized Data
This task describes how to write a new job that can operate with localized data.

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.

This code usually takes the following form:

client = Framework.createClient(protocol, properties)


shellUtils = shellutils.ShellUtils(client)
languageBundle = shellutils.getLanguageBundle ('langNetwork', shellUtils.osLanguage, Framework)
strWindowsIPAddress = languageBundle.getString('windows_ipconfig_str_ip_address')
ipconfigOutput = shellUtils.executeCommandAndDecode('ipconfig /all', strWindowsIPAddress)
#Do work with output here

1. Create a client:

client = Framework.createClient(protocol, properties)

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:

languageBundle = shellutils.getLanguageBundle ('langNetwork', shellUtils.osLanguage, Framework)

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:

ipconfigOutput = shellUtils.executeCommandAndDecode('ipconfig /all', strWindowsIPAddress)

The ShellUtils object is also needed to link a user to the API reference (where this method is described in detail).

6. Parse the output as usual.

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

1.1.5.1.2.3.5. Decode Commands Without a Keyword


The current approach for localization uses a keyword to decode all of the command output. For details, see the step about retrieving a
keyword from the resource bundle in Define a new job to operate with localized data.

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.

The regular use case works as follows:

1. Invoke the executeCommandAndDecode method once.


2. Obtain the most recently used character set name through the getCharsetName method.
3. Make shellUtils use this character set by default, by invoking the useCharset method on the ShellUtils object.
4. Invoke the execCmd method of ShellUtils one or more times. The output is returned with the character set specified in the
previous step. No additional decoding operations occur.

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

1.1.5.1.2.3.6. Work with Resource Bundles


A resource bundle is a file that takes a properties extension (*.properties). A properties file can be considered a dictionary that stores
data in the format of key = value . Each row in a properties file contains one key = value association. The main functionality of a resource
bundle is to return a value by its key.

Resource bundles are located on the Probe machine: C:\UCMDB\DataFlowProbe\runtime\probeManager\discoveryConfigFiles.


They are downloaded from the UCMDB Server as any other configuration file. They can be edited, added, or removed, in the Resources
window. For details, see Configuration File pane.

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

1.1.5.1.2.3.7. API Reference

The language class


This class encapsulates information about the language, such as resource bundle postfix, possible encoding, and so on.

Fields

Name Description

locale Java object which represents locale.

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).

The executeCommandAndDecode method


This method is intended to be used by business logic Jython scripts. It encapsulates the decoding operation and returns a decoded
command output.

Arguments

Name Description

cmd The actual command to be executed.

keyword The keyword to be used for the decoding operation.

framework The Framework object passed to every executable Jython script in DFM.

timeout The command timeout.

waitForTimeout Specifies if client should wait when timeout is exceeded.

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.

The getCharsetName method


This method returns the name of the most recently used character set.

The useCharset method


This method sets the character set on the ShellUtils instance, which uses this character set for initial data decoding.

Arguments

Name Description

charsetName The name of the character set, for example, windows-1251 or UTF-8 .

See also The getCharsetName method.

The getLanguageBundle method


This method should be used to obtain the correct resource bundle. This replaces the following API:

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 .

language The language object. The ShellUtils.osLanguage should be passed here.

framework The Framework, common object which is passed to every executable Jython script in DFM.

The osLanguage field


This field contains an object that represents the language.

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.1.5.1.2.4. Record DFM Code


It can be very useful to record an entire execution, including all parameters, for example, when debugging and testing code. This task
describes how to record an entire execution with all relevant variables. Furthermore, you can view extra debug information that is
usually not printed to log files even at the debug level.

To record DFM code:

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:

The following example shows the message and stacktrace parameters:

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

1.1.5.1.2.5. Jython Libraries and Utilities


Several utility scripts are used widely in adapters.

To use one of the utility scripts, add the following import line to the import section of the script:

import <script name>

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.

There are two sets of APIs:

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:

logger.debug('found the result')


logger.errorException('Error in discovery')

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

dnsName = netutils.getHostName(ip, ip)


isValidIp = netutils.isValidIp(ip_address)
address = netutils.getHostAddress(hostName)

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:

ttyClient = Framework.createClient(Framework.getTriggerCIData(BaseClient.CREDENTIALS_ID), Props)


clientShUtils = shellutils.ShellUtils(ttyClient)
if (clientShUtils.isWinOs()):
logger.debug ('discovering Windows..')

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

1.1.5.1.3. Developing Generic Database Adapters


This section includes:

Prepare the Adapter Package


View the Results
Troubleshooting and Limitations

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

1.1.5.1.3.1. Prepare the Adapter Package


Operations Bridge Manager:24.4/GDBAPrepareAdapterPackage

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

1.1.5.1.3.2. View the Results


Operations Bridge Manager:24.4/GDBAViewResults

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

1.1.5.1.3.3. Troubleshooting and Limitations


Operations Bridge Manager:24.4/GDBATroubleshootingLimitations

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

1.1.5.1.4. Developing Push Adapters


Operations Bridge Manager:24.4/PushAdapsChapter

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

1.1.5.1.4.1. Developing and Deploying Push Adapters


UCMDB Containerized:24.4/PushAdptOvrvw

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

1.1.5.1.4.2. Build an Adapter Package


To create a new, MDR-specific push adapter, you should make a copy of the generic adapter and then edit it to customize it as an
adapter for a specific push target.

Generic adapters packages can be found in the following location:

C:\UCMDB\UCMDBServer\content\adapters\generic-adapter.zip

To create a new push adapter from the generic push adapter:

1. Extract the content of the selected package zip file to a folder.

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:

a. discoveryConfigFiles\<Your_Push_Adapter_Name>: rename the directory "PushAdapter" or "XMLtoWebService" to the


name of the new push adapter (for example, “myPushAdapter”).

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.

c. discoveryConfigFiles\<Your_Push_Adapter_Name>\adapter.properties: Configure the adapter properties.

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:

<pattern id="PushAdapter" xsi:noNamespaceSchemaLocation="../../Patterns.xsd" description="Discovery Pattern Description" sc


hemaVersion="9.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

is changed to:

<pattern id="MyPushAdapter" displayLabel="My Push Adapter" xsi:noNamespaceSchemaLocation="../../Patterns.xsd" description


="Discovery Pattern Description" schemaVersion="9.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

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.

host: the server name hosting the web service

port: port of the listening UCMDB Data Receiver service

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.

TQL best practices for Push Adapters


1. Create a folder structure in the TQL and View trees, and keep all new TQLs and views there. Use a naming convention.
2. Unless the TQL is small, first copy the most similar TQL.
3. Make one change at a time. Save, test, and preview after each change. Repeat until the results comply with your requirements.

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

1.1.5.1.4.3. Create Mappings


The raw TQL result data is in the form of the UCMDB class model schema. It is likely that the consumer uses a different data model. The
push adapter provides a mapping mechanism to transform the data into a format more suitable for consumption. Mappings perform
both direct and complex transformations, from direct, naming-type conversion, to parent/child aggregation and referencing functions.

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.

Build a mapping file


1. Start with a default mapping file.
2. Deploy the adapter and run it once.
3. Observe the results.
4. Identify and note what should be changed.
5. Make the changes identified in the previous step. The following list can help serve as a guide for the order of the changes.
a. Start with the top, non-transformative section. Make sure the adapter runs after each change.
b. Change the source CIs section to the UCMDB names in the TQL result.
c. First map the keys.
d. Then add all the direct mappings.
e. Add the complex mappings.
f. Add the link mappings.

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.

Prepare the mapping files


Note

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.

There are two different ways to prepare mapping files:

You can prepare a single, global mapping file.

All mappings are placed in a single file named mappings.xml.

You can prepare a separate file for each push query.

Each mapping file is called <query name>.xml.

This task includes the following steps:

1. Create a mappings.xml File

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

<?xml version="1.0" encoding="UTF-8"?>


<integration>
<info>
<source name="UCMDB" versions="9.x" vendor="HP" >
<!-- for example: -->
<target name="Oracle" versions="11g" vendor="Oracle" >
</info>
<targetcis>
<!--- CI Mappings --->
</targetcis>
<targetrelations>
<!--- Link Mappings --->
</ targetrelations>
</integration>

2. Map CIs

There are two ways to map CMDB CI types:

Map a CI type so that CIs of that type and all inherited types are mapped in the same way:

<source_ci_type_tree name="node" mode="update_else_insert">


<apioutputseq>1</apioutputseq>
<target_ci_type name="host">
<targetprimarykey>
<pkey>name</pkey>
</targetprimarykey
<target_attribute name=" name" datatype="STRING">
<map type="direct" source_attribute="name" >
</target_attribute>
<!-- more target attributes --->
</target_ci_type>
</source_ci_type_tree>

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):

<source_ci_type name="node" mode="update_else_insert">


<apioutputseq>1</apioutputseq>
<target_ci_type name="host">
<targetprimarykey>
<pkey>name</pkey>
</targetprimarykey
<target_attribute name=" name" datatype="STRING">
<map type="direct" source_attribute="name" >
</target_attribute>
<!-- more target attributes --->
</target_ci_type>
</source_ci_type>

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

There are two ways to 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

<source_link_type_tree name="dependency" target_link_type="dependency" mode="update_else_insert" source_ci_type_end1="webse


rvice" source_ci_type_end2="sap_gateway">
<target_ci_type_end1 name="webservice" >
<target_ci_type_end2 name="sap_gateway" >
<target_attribute name="name" datatype="STRING">
<map type="direct" source_attribute="name" >
</target_attribute>
</source_link_type_tree>

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):

<link source_link_type="dependency" target_link_type="dependency" mode="update_else_insert" source_ci_type_end1="webservice"


source_ci_type_end2="sap_gateway">
<target_ci_type_end1 name="webservice" >
<target_ci_type_end2 name="sap_gateway" >
<target_attribute name="name" datatype="STRING">
<map type="direct" source_attribute="name" >
</target_attribute>
</link>

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

1.1.5.1.4.3.1. Write Jython Scripts


UCMDB Containerized:24.4/PushWriteJython

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

1.1.5.1.4.4. Support Differential Synchronization


For the Push adapter to support differential synchronization, the DiscoveryMain function must return an object implementing the
DataPushResults interface, which contains the mappings between the IDs that the Jython script receives from the XML and the IDs
that the Jython script creates on the remote machine. The latter IDs are of the type ExternalId.

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.

This task enables the Push adapter to perform differential synchronization.

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).

Add the following from statements to your Jython script:

from com.hp.ucmdb.federationspi.data.query.types import ExternalIdFactory


from com.hp.ucmdb.adapters.push import DataPushResults
from com.hp.ucmdb.adapters.push import DataPushResultsFactory
from com.mercury.topaz.cmdb.server.fcmdb.spi.data.query.types import ExternalIdUtil

Use the DataPushResultsFactory factory class to obtain the DataPushResults object from the DiscoveryMain function.

# Create the UpdateResult object


updateResult = DataPushResultsFactory.createDataPushResults(objectMappings, linkMappings);

Use the following commands to create Java maps for the DataPushResults object:

#Prepare the maps to store the mappings if IDs


objectMappings = HashMap()
linkMappings = HashMap()

Use the ExternalIdFactory class to create the following ExternalId IDs:

ExternalId for objects or links originating in a CMDB (for example, all of the CIs in an add operation are from the CMDB):

externaCIlId = ExternalIdFactory.createExternalCmdbCiId(ciType, ciIDAsString)


externalRelationId = ExternalIdFactory.createExternalCmdbRelationId(linkType, end1ExternalCIId,
end2ExternalCIId, linkIDAsString)

ExternalId for objects or links not originating in a CMDB (usually, every update and remove operation contains such objects):

myIDField = TypesFactory.createProperty("systemID", "1")


myExternalId = ExternalIdFactory.createExternalCiId(type, myIDField)

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

1.1.5.1.4.5. Generic XML Push Adapter


UCMDB Containerized:24.4/PushXmlAdpt

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

1.1.5.1.4.6. Generic Web Service Push Adapter


The generic web service push adapter provides a UCMDB-initiated push of web service messages containing query data to a web
service data receiver. The mapped results are sent in standard web service messages via the HTTP POST protocol to the data receiver.
The data receiver must understand the web service messages produced by the push adapter. To facilitate the development of the
proper data receiver, a WSDL is provided with this push adapter if you use SOAP.

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.

The default WSDL URL is:

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.

The source for the WSDL is included below:

<?xml version="1.0" encoding="UTF-8"?>


<wsdl:definitions targetNamespace="http://ucmdb.microfocus.com" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://ucm
db.microfocus.com" xmlns:intf="http://ucmdb.microfocus.com" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.
xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<!--WSDL created by Apache Axis version: 1.4 Built on Apr 22, 2006 (06:55:48 PDT)-->
<wsdl:types>
<schema elementFormDefault="qualified" targetNamespace="http://ucmdb.microfocus.com" xmlns="http://www.w3.org/2001/XMLSchema">
<element name="addData">
<complexType>
<sequence>
<element name="xmlAdded" type="xsd:string"/>
</sequence>
</complexType>
</element>
<element name="addDataResponse">
<complexType/>
</element>
<element name="deleteData">
<complexType>
<sequence>
<element name="xmlDeleted" type="xsd:string"/>
</sequence>
</complexType>
</element>
<element name="deleteDataResponse">
<complexType/>
</element>
<element name="updateData">
<complexType>
<sequence>
<element name="xmlUpdate" type="xsd:string"/>
</sequence>
</complexType>
</element>
<element name="updateDataResponse">
<complexType/>
</element>
</schema>
</wsdl:types>

<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:

<2012-03-16 15:47:38,080> [INFO ] [Thread-110] - XMLtoWebService.py:addData received response:


<soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<intf:addDataResponse xmlns:intf="http://ucmdb.microfocus.com">
<xml>&lt;result&gt;&lt;status&gt;error&lt;/status&gt;
&lt;message&gt;Error publishing config item changes&lt;/message&gt;
&lt;/result&gt;</xml>
</intf:addDataResponse>
</soapenv:Body>

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.

Testing the WSDL


The SOAPUI Eclipse plug-in is used to test web service layers during development. You can use SOAPUI to assist with customization of a
web service. SOAPUI offers an integrated development environment (IDE) to test building, sending, and receiving of SOAP messages. In
the SOAPUI perspective, the source for the WSDL above in the WSDL section generated the following sample message:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ucm="http://ucmdb.microfocus.com">


<soapenv:Header/>
<soapenv:Body>
<ucm:addData>
<ucm:xmlAdded>?</ucm:xmlAdded>
</ucm:addData>
</soapenv:Body>
</soapenv:Envelope>

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

1.1.5.1.4.7. Mapping File Reference

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.

Here is an example of a direct mapping:

<target_attribute name="dns_domain" datatype="char">


<map type="direct" source_attribute="domain_name" />
</target_attribute>

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:

To map attribute values from multiple CIs to one target CI.


To map attributes of children CIs (those having a container_f or contained relationship) to the parent CI in the target data store.
For example, setting a value called Number of CPUs on a target Host CI. Another example could be setting the value Total
Memory (by adding up the memory size values of all memory CIs of a host CI in UCMDB) on a target Host CI.
To map attributes of parent CIs (those having a container_f or contained relationship) on the target data store’s CI. For example,
setting a value called Container Server on a target attribute called Installed Software CI, by getting the value from the
containing host of the software CI in UCMDB.

Below is an example of a complex mapping, using two source attributes separated by a comma character, to create the target attribute
os:

<target_attribute name="os" datatype="char">


<map type="compoundstring">
<source_attribute name="discovered_os_name" />
<constant value="," />
<source_attribute name="host_osinstalltype" />
</map>
</target_attribute>

Reversing link directions

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.

One possible solution to this problem is to define an Enrichment rule as follows:

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

1.1.5.1.4.8. Mapping File Schema


Element Name and
Description Attributes
Path

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

Description: Name of the source data


repository.

Is required?: Required

Type: String

2. Name: versions

Description: Version(s) of the source


source
Defines information about the source data repository. data repositories.
(integration > info)
Is required?: Required

Type: String

3. Name: vendor

Description: Vendor of the source data


repository.

Is required?: Required

Type: String

1. Name: type

Description: Name of the source data


repository.

Is required?: Required

Type: String

2. Name: versions

Description: Version(s) of the source


target
Defines information about the target data repository. data repository.
(integration > info)
Is required?: Required

Type: String

3. Name: vendor

Description: Vendor of the source data


repository.

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

Element Name and


Description Attributes
Path

1. Name: name

Description: Name of the source CIT.

Is required?: Required

Type: String

2. Name: mode

Description: The type of update required


for the current CI type.
source_ci_type_tree
Defines a source CIT and all of the CI types which inherit from it. Is required?: Required
(integration > targetcis)
Type: One of the following strings:

insert: Use this only if the CI does


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.

1. Name: name

Description: Name of the source CIT.

Is required?: Required

Type: String

2. Name: mode

Description: The type of update required


for the current CI type.

source_ci_type Is required?: Required


Defines a source CIT without the CI types which inherit from it.
(integration > targetcis) Type: One of the following strings:

insert: Use this only if the CI does


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.

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

Element Name and


Description Attributes
Path

1. Name: name

Description: Target CI type name.

Is required?: Required

Type: String

target_ci_type 2. Name: schema

(integration > targetcis Description: The name of the schema


> that will be used to store this CI type at
source_ci_type Defines a target CIT. the target.

-OR- Is required?: Not Required

integration > targetcis Type: String


> source_ci_type_tree)
3. Name: namespace

Description: Indicates the namespace of


this CI type on the target.

Is required?: Not Required

Type: String

targetprimarykey

(integration > targetcis


> source_ci_type)

-OR-

(integration > targetcis


> source_ci_type_tree

-OR- Identifies target CIT primary key attributes.

(integration >
targetrelations > link)

-OR-

(integration >
targetrelations >
source_link_type_tree)

pkey

(integration > targetcis


> source_ci_type >
targetprimarykey

-OR-

integration > targetcis


> source_ci_type_tree
> targetprimarykey
Identifies one primary key attribute.
-OR-
Required only if mode is update or
(integration > insert_else_update.
targetrelations > link >
targetprimarykey)

-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

Element Name and


Description Attributes
Path

1. Name: name

Description: Name of the target CIT's


attribute.

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.

integration > Is required?: Not Required


targetrelations > link
Type. Integer
-OR-
4. Name. option
integration >
Description. The conversion function to
targetrelations >
be applied to the value.
source_link_type_tree)
Is required. False

Type. One of the following strings:

uppercase – Convert to uppercase


lowercase – Convert to lowercase

If this attribute is empty, no conversion


function will be applied.

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

Element Name and


Description Attributes
Path

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)

Only valid when the


map's type is childattr

source_child_ci_type

(integration > targetcis


> source_ci_type >
target_attribute > map

-OR-

integration > targetcis 1. Name. name


> source_ci_type_tree Description. The type of the child CI
> target_attribute > Is required. Required
map Type. String
2. Name. source_attribute
-OR-
Specifies from which connected CI the child attribute is taken. Description. The attribute of the child CI
(integration > that is mapped.
targetrelations > link > Is required. Required only if the
target_attribute > map childAttr aggregation type (which is on
the same path) is not =count.
-OR- Type. String

integration >
targetrelations >
source_link_type_tree >
target_attribute > map)

Only valid when the


map’s type is childattr.

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

Element Name and


Description Attributes
Path

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

value. Optional. Description. Excludes numbers smaller


(integration >
than the specified value.
targetrelations > link >
Is Required?: Not required
target_attribute > map
Type. Numeric
-OR- 4. Name. maxvalue
Description. Excludes numbers greater
integration > than the specified value.
targetrelations > Is Required?: Not required
source_link_type_tree > Type. Numeric
target_attribute > map)

Only valid when the


map's type is childatt

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

Element Name and


Description Attributes
Path

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

Element Name and


Description Attributes
Path

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

1.1.5.1.4.9. Mapping Results Schema


Element
Name and Description Attributes
Path

root The root of the result document.

data (root) The root of the data itself.

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

1.1.5.1.5. Developing Enhanced Generic Push


Adapters
Operations Bridge Manager:24.4/EnhanGenPushChapter

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

1.1.5.1.5.2. The Mapping File


The following example demonstrates how to create the mapping file.

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.

The following is the mapping XML file:

The query results appear as follows:

Here is the RTN list built according to this mapping file:

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

1.1.5.1.5.3. The Groovy Traveler


Access the TQL query results in the following manner:

Root[attr] returns the attribute attr of the Root element.


Root.Query_Element_Name returns a list of the CI instances named in the TQL Query_Element_Name and that are linked to the
current root CI.
Root.Query_Element_Name[2][attr] returns the attribute attr of the third Query_Element_Name that is linked to the current
root CI.
Root.Query_Element_Name*.getAt(attr) returns a list of the attributes attr of the CI instances named Query_Element_Name in
the TQL and that are linked to the current root CI.

There are additional attributes that can be accessed by the groovy traveler:

cmdb_id – returns the UCMDB ID of the CI or relationship as a string.


external_cmdb_id – returns the external ID of the CI or relationship as a string.
Element_type – returns the element type of the CI or relationship as a string.

The import tag:

<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.

<source_instance_type query-name="Node Push*" root-element-name="Root">

The source_instance_type tag designates the root element we are mapping.

root-element-name should be exactly the same as the name of the root in the TQL.

target_entity

This tag is used for the creation of the RTN.

The name attribute represents the target_entity name: name=Computer

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:

<variable name="vSerialNo" datatype="STRING" value="Root['serial_number']"/>

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.

<target_mapping name="SerialNo" datatype="STRING" value="vSerialNo"/>

SerialNo assigns the value of the variable vSerialNo.

It is possible to define a target_entity as child of another target_entity as follows:

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>

The RTN Portfolio will have child RTN named Asset.

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.

Let’s modify our example mapping file:

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.

<dynamic_mapping name="IdByName " keys-unique="true">

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’)

It returns a reference to that map.

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:

<map_property property-name="SQLQuery" datatype="STRING"


property-value="SELECT name, id FROM Computer"/>

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:

Topology – Type: Topology. An instance of the topology of the current chunk.


QueryDefinition - Type: QueryDefinition. An instance of the query definition of the current TQL.
OutputCI – Type: ResultTreeNode. The RTN of the root element in the current tree mapping.
ClassModel – Type: ClassModel. An instance of the class model.
CustomerInformation – Type: CustomerInformation. Information about the customer running the job.
Logger – Type: DataAdapterLogger. This logger is available in the adapter for writing logs to the UCMDB logging framework.

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

1.1.5.1.5.4. Write Groovy Scripts


In this section we create the PushFunctions.groovy file. This file will contain static functions that are used during the mapping of the
root instance.

package mappings.scripts
public class PushFunctions {

public static boolean isVirtual(def nodeRole){


return isListContainsOne(def list, "MY_VM", "MY_SIMULATOR");
}

public static String getDescription(boolean isVirtual){


if(isVirtual){
return "This is a VM";
}
else{
return "This is physical machine";
}
}

private static boolean isListContainsOne(def list, ...stringList){


//returns true if the list contains one of the values.
}
}

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

1.1.5.1.5.5. Implement PushConnector Interface


The implementation should support the following basic steps:

public class PushExampleAdapter implements PushAdapterConnector


{

public UpdateResult pushTreeNodes(PushConnectorInput input) throws DataAccessException{


// 1. build an UpdateResult instance - the UpdateResult is used to return mappings between the sent ids to the actual ids that entered the data stor
e.
// Also has an update status which allows to pass the status of data that was actually pushed, detailed status reports on failed IDs, and actions actu
ally performed on successful ids.
// 2. handle the data:
// a. handle data to add. Can be retrieved by: input.getResultTreeNodes.getDataToAdd();
// b. handle data to update.
// c. handle data to delete.
// 3. Return the Update result.
}
public void start(PushDataAdapterEnvironment env) throws DataAccessException{
// this method is called when the integration point created,
or when the adapter is reloaded
//(i.e after changing one of the mapping files
// and pressing ‘save’).

public void testConnection(PushDataAdapterEnvironment env) throws DataAccessException {


// this method is called when pressing the 'test
connection' button in the
//creation of the integration point.
// For example if we push data to RDBMS this method
can create a connection
//to the database and will run a dummy SQL statement.
// If it fails it writes an error message to the log
and throws an exception.
}

Map<Object, Object> retrieveUniqueMapping(MappingQuery mappingQuery){


//This method will create the map according to the given mappingQuery. It will be called in the
// mapping stage of the adapter execution, before the ‘UpdateResult pushTreeNodes’ method.
// This method is called when the ‘keys-unique’ attribute of the ‘dynamic_mapping’ tag is true.
}
Map<Object, Set<Object>> retrieveNonUniqueMapping(MappingQuery mappingQuery){
// This method is called when the ‘keys-unique’ attribute of the ‘dynamic_mapping’ tag is false.
// In this case a key can be mapped to several values.
}
}

PushAdapterConnector interface
The interface contains the following methods.

void start(PushDataAdapterEnvironment env) throws


DataAccessException;
The method is called when the adapter integration
Description
point starts.

env: The handler for the generic adapter


Parameter environment, from which you can get the adapter
resources such as the logger.

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

Any error during the startup will throw an exception,


Exceptions
and the integration point will fail to start.

void testConnection(PushDataAdapterEnvironment env) throws


DataAccessException;
The method is called when clicking Test
Description
Connection from the integration point UI.

env: The handler for the generic adapter


Parameter environment, from which you can get the adapter
resources such as the logger.

Return
No return value.
value

Any error during the startup will throw an exception,


Exceptions and the integration point will pop out an error
message to show that the test connection is failed.

UpdateResult pushTreeNodes(PushConnectorInput input) throws


DataAccessException;
The method is called when running the push job
Description
from the integration point UI.

input: The collection of the CIs and linkages to be


Parameter
pushed.

Return
The push result of all the CIs and linkages.
value

Any error during the startup will throw an exception,


Exceptions and the integration point will pop out an error
message to show that the push job is failed.

void locatePushQueriesResources(DataAdapterEnvironment env,


LocatePushQueriesResourcesInput input,
LocatePushQueriesResourcesOutput output);
The method reports push query resources used by
the adapter so that the list can be edited from the
integration studio.

Implementing this helps you to find the adapter


resources that are related to a selected job's TQL
query.

To see the related resources for a job's TQL query:


Description
1. In the Integration Studio, select an integration
point.
2. In the Integration Jobs pane, select a job and
click Edit Query Resources .

This method is optional for Generic Adapter


Framework. Normally, it's advisable to put an empty
implementation for this method.

env: generic adapter environment handler.

input: the push query resource input.


Parameter
output: the output of the push query resources
supported by this adapter.

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

Exceptions No specific exception defined.

void locateGeneralResources(DataAdapterEnvironment env,


LocateGeneralResourcesInput input, LocateGeneralResourcesOutput
output);
This method reports the general resources used by
this adapter. The output resources can be edited
from the integration studio.

Implementing this helps you to find the adapter


resources that are related to a selected job's TQL
query.

To see the related resources for a job's TQL query:


Description
1. In the Integration Studio, select an integration
point.
2. In the Integration Jobs pane, select a job and
click Edit Query Resources .

This method is optional for Generic Adapter


Framework. Normally, it's advisable to put an empty
implementation for this method.

env: generic adapter environment handler.

input: the push general resource input.


Parameter
output: the output of the push general resource
used by this adapter.

Return
No return value.
value

Exceptions No specific exception defined.

Map<Object, Object> retrieveUniqueMapping(MappingQuery


mappingQuery); or Map<Object, Set<Object>>
retrieveNonUniqueMapping(MappingQuery mappingQuery);
This method is for dynamic mapping usage, which
will return the dynamic mapping output. For more
information, see The groovy traveler.

Description The retrieveUniqueMapping method will be called


when [keys-unique="true"] while
retrieveNonUniqueMapping will be called when
[keys-unique="false"].

mappingquery: the dynamic_mapping name of the


Parameter
TQL query.

Return
The mapping dynamically generated.
value

Exceptions No specific exception defined.

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

1.1.5.1.5.6. Build an Adapter Package


Ensure that the adapter package contains the following folders:

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.

Enable/disable attribute and link validation at adapter level


You can enable or disable attribute and link validation at adapter level for generic adapters by adding the following setting:

<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

1.1.5.1.5.7. Mapping File Schema


Element Name and
Description Attributes
Path

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

Description: Name of the source data


repository.

Is required?: Required

Type: String

2. Name: versions

Description: Version(s) of the source


source
Defines information about the source data repository. data repositories.
(integration > info)
Is required?: Required

Type: String

3. Name: vendor

Description: Vendor of the source data


repository.

Is required?: Required

Type: String

1. Name: type

Description: Name of the source data


repository.

Is required?: Required

Type: String

2. Name: versions

Description: Version(s) of the source


target
Defines information about the target data repository. data repository.
(integration > info)
Is required?: Required

Type: String

3. Name: vendor

Description: Vendor of the source data


repository.

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

Element Name and


Description Attributes
Path

1. Name: name

Description: Name of the source CIT.

Is required?: Required

Type: String

2. Name: mode

Description: The type of update required


for the current CI type.
source_ci_type_tree
Defines a source CIT and all of the CI types which inherit from it. Is required?: Required
(integration > targetcis)
Type: One of the following strings:

insert: Use this only if the CI does


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.

1. Name: name

Description: Name of the source CIT.

Is required?: Required

Type: String

2. Name: mode

Description: The type of update required


for the current CI type.

source_ci_type Is required?: Required


Defines a source CIT without the CI types which inherit from it.
(integration > targetcis) Type: One of the following strings:

insert: Use this only if the CI does


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.

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

Element Name and


Description Attributes
Path

1. Name: name

Description: Target CI type name.

Is required?: Required

Type: String

target_ci_type 2. Name: schema

(integration > targetcis Description: The name of the schema


> that will be used to store this CI type at
source_ci_type Defines a target CIT. the target.

-OR- Is required?: Not Required

integration > targetcis Type: String


> source_ci_type_tree)
3. Name: namespace

Description: Indicates the namespace of


this CI type on the target.

Is required?: Not Required

Type: String

targetprimarykey

(integration > targetcis


> source_ci_type)

-OR-

(integration > targetcis


> source_ci_type_tree

-OR- Identifies target CIT primary key attributes.

(integration >
targetrelations > link)

-OR-

(integration >
targetrelations >
source_link_type_tree)

pkey

(integration > targetcis


> source_ci_type >
targetprimarykey

-OR-

integration > targetcis


> source_ci_type_tree
> targetprimarykey
Identifies one primary key attribute.
-OR-
Required only if mode is update or
(integration > insert_else_update.
targetrelations > link >
targetprimarykey)

-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

Element Name and


Description Attributes
Path

1. Name: name

Description: Name of the target CIT's


attribute.

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.

integration > Is required?: Not Required


targetrelations > link
Type. Integer
-OR-
4. Name. option
integration >
Description. The conversion function to
targetrelations >
be applied to the value.
source_link_type_tree)
Is required. False

Type. One of the following strings:

uppercase – Convert to uppercase


lowercase – Convert to lowercase

If this attribute is empty, no conversion


function will be applied.

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

Element Name and


Description Attributes
Path

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)

Only valid when the


map's type is childattr

source_child_ci_type

(integration > targetcis


> source_ci_type >
target_attribute > map

-OR-

integration > targetcis 1. Name. name


> source_ci_type_tree Description. The type of the child CI
> target_attribute > Is required. Required
map Type. String
2. Name. source_attribute
-OR-
Specifies from which connected CI the child attribute is taken. Description. The attribute of the child CI
(integration > that is mapped.
targetrelations > link > Is required. Required only if the
target_attribute > map childAttr aggregation type (which is on
the same path) is not =count.
-OR- Type. String

integration >
targetrelations >
source_link_type_tree >
target_attribute > map)

Only valid when the


map’s type is childattr.

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

Element Name and


Description Attributes
Path

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

value. Optional. Description. Excludes numbers smaller


(integration >
than the specified value.
targetrelations > link >
Is Required?: Not required
target_attribute > map
Type. Numeric
-OR- 4. Name. maxvalue
Description. Excludes numbers greater
integration > than the specified value.
targetrelations > Is Required?: Not required
source_link_type_tree > Type. Numeric
target_attribute > map)

Only valid when the


map's type is childatt

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

Element Name and


Description Attributes
Path

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

Element Name and


Description Attributes
Path

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

1.1.5.1.6. View KPIs in external applications


Operations Bridge Manager:24.4/ViewKPIChapter

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

1.1.5.2. Using APIs


Operations Bridge Manager:24.4/Part2UsingAPIDivider

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

1.1.5.2.1. APIs Overview


The following APIs are included with Universal CMDB:

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

1.1.5.2.2. RTSM Java API


The Universal CMDB REST API allows you to perform topology modification and topology query related operations.

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:

REST API Read. Allows you to perform GET calls.


REST API Create and Update. Allows you to perform POST/PUT/PATCH calls.
Rest API Delete. Allows you to perform DELETE calls.

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:

POST /topology/queryNameWithParameters → GET /topology/queryNameWithParameters


POST /topology → GET /topology
POST /topologyQuery → GET /topologyQuery

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.

false. The REST API permissions check isn't done by default.


true. Granular access to the REST API is enabled, and the REST API permissions check is performed.

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

To enable granular access to REST API, follow these steps:

1. On UCMDB server, go to JMX Console > UCMDB:service=Settings Services > setGlobalSettingValue.

2. In the name field, enter restrict.rest.api.access.

3. In the value field, enter true.

4. Click Invoke.

5. Restart the UCMDB server.

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

UCMDB Java API

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

1.1.5.2.2.2. Using the RTSM Java API


The Universal CMDB API is used to integrate applications with the Universal CMDB (CMDB). The API provides methods to:

Add, remove, and update CIs and relations in the CMDB


Retrieve information about the class model
Retrieve information from the UCMDB history
Run what-if scenarios
Retrieve information about configuration items and relationships

Methods for retrieving information about configuration items and relationships generally use the Topology Query Language (TQL).

Users of the Universal CMDB API should be familiar with:

The Java programming language


Universal CMDB

Uses of the API


The API is used to fulfill a number of business requirements. For example, a third-party system can query the class model for
information about available configuration items (CIs).

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

1.1.5.2.2.3. General Structure of an Application


There is only one static factory, the UcmdbServiceFactory. This factory is the entry point for an application. The
UcmdbServiceFactory exposes getServiceProvider methods. These methods return an instance of the UcmdbServiceProvider
interface.

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.

2. Gets a query factory object from the service object.

3. Gets a new query definition from the factory.

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");

The services available from UcmdbService are:

Service Methods Use

Perform authorization operations (create users and user groups, assign roles to users and groups, and so
getAuthorizationModelService
on).

getClassModelService Information about types of CIs and relations

getConfigurationService Infrastructure settings management, for server configuration

getDataStoreMgmtService Query data store information including which CIs and attributes will be federated.

getDDMConfigurationService Configure the Data Flow Management system

getDDMManagementService Analyze and view the progress, results, and errors of the Data Flow Management system

getDDMZoneService Import and export management zones (with their activities).

getHistoryService Information about history of monitored CIs (changes, removals, and so on)

getImpactAnalysisService Run impact analysis scenario (also known as correlation).

getLicensingService Query information about licenses installed in the system.

getMultipleCMDBService Convert between global IDs and UCMDB IDs.

getMultiTenancyService Create, read, update, and delete tenants.

getPersistencyService Persist binary data into key-value pairs.

Manage access to queries - save, delete, list existing. Also provides query validation and discovery of
getQueryManagementService
queries dependencies.

getReconciliationService Supplies identification and merging capabilities.

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.

getSecurityService Verify whether credentials are valid.

getServerService Query generic information about 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

Service Methods Use

Get information about the IT universe

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.

getTopologyUpdateService Change information in the IT universe

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.

The client communicates with the server over HTTPS.

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

1.1.5.2.2.4. Put the API Jar File in the Classpath


Operations Bridge Manager:24.4/APIPutJarfileInClasspath

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

1.1.5.2.2.5. RTSM Java API Use Cases


The use cases listed in this section assume two systems:

Universal CMDB server


A third-party system that contains a repository of configuration items

Populating the CMDB


Use cases:

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

Querying the CMDB


Use cases:

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

Querying the Class Model


Use cases:

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.

Analyzing change impact


Use case:

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

1.1.5.2.2.6. Performance Improvement with a


Bidirectional GlobalID - UcmdbID Mapping Cache
The implementation of a bidirectional GlobalID - UcmdbID mapping cache at the uppermost level enables faster retrieval of Global IDs
by Ucmdb ID and vice-versa. For example, before executing a query to retrieve the UCMDB ID for a global ID, the entry is searched in
the bidirectional cache first, and if there is a match, the value will be retrieved directly from the mapping cache.

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.

The following is an example of using one of the methods in the MultipleCMDBService:

//connect to the ucmdbService


MultipleCMDBService multipleCMDBService = ucmdbService.getMultipleCMDBService();
GlobalIds globalIds = multipleCMDBService.getFactory().createGlobalIds(1);
globalIds.add(globalId);
GlobalIdToIdMapping globalIdToIdMapping = multipleCMDBService.convertGlobalIdsToIds(globalIds);
System.out.println("UcmdbId: " + globalIdToIdMapping.getID(globalId));

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.

Scenario Performance Improvement

Conversion from Global_Id to Ucmdb_Id for a single CI 45% increase in performance

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

1.1.5.2.3. RTSM REST API


The Universal CMDB REST API allows you to perform topology modification and topology query related operations.

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:

REST API Read. Allows you to perform GET calls.


REST API Create and Update. Allows you to perform POST/PUT/PATCH calls.
Rest API Delete. Allows you to perform DELETE calls.

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:

POST /topology/queryNameWithParameters → GET /topology/queryNameWithParameters


POST /topology → GET /topology
POST /topologyQuery → GET /topologyQuery

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.

false. The REST API permissions check isn't done by default.


true. Granular access to the REST API is enabled, and the REST API permissions check is performed.

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

To enable granular access to REST API, follow these steps:

1. On UCMDB server, go to JMX Console > UCMDB:service=Settings Services > setGlobalSettingValue.

2. In the name field, enter restrict.rest.api.access.

3. In the value field, enter true.

4. Click Invoke.

5. Restart the UCMDB server.

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

1.1.5.2.3.1. Standalone Deployment


Operations Bridge Manager:24.4/RestApiStandalone

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

1.1.5.2.3.2. Using REST API


This chapter provides basic information about how to use the REST API.

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:

{ "username": "admin", "password": "admin", "clientContext": 1 }

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:

key: Authorization, value: Bearer TOKEN

TOKEN is the token returned by the authorization service.

Note

All REST calls require a token except the following


ones:

get sample data model


get sample topology query

REST API endpoint


You must specify an endpoint when you make a REST call. An endpoint includes the following parts:

<base_url><resource_url>

<base_url>: The URL of where the REST API is deployed.

<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.

Authentication against LDAP


To enable authentication against LDAP, a repository key should be added to the JSON authentication request, containing the domain
name of the LDAP server, like the following:

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 &lt; in place of the less than symbol
(<) and &gt; 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

1.1.5.2.3.2.1. A Usage Example


This example demonstrates how to make a POST call to run a TQL query by definition to return the name of all CPUs of which the
attribute contains Pentium .

Step 1. Retrieve the authentication token


To do this, make a POST call to https://<EXTERNAL_ACCESS_HOST>:<EXTERNAL_ACCESS_PORT>/ucmdb-server/rest-
api/authenticate with the following payload:

{
"username": "sysadmin",
"password": "Sysadmin?123",
"clientContext": 1
}

You then receive a response that resembles the following:

Status: 200
Response body:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzQzNTc3MDYsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.cVYsuum1Cqa
qfZV1K5KJ8nidOOif8Wv9tZsLFFZPbSs"
}

Step 2. Make a POST call to run the TQL query


Make a POST call to https://<EXTERNAL_ACCESS_HOST>:<EXTERNAL_ACCESS_PORT>/ucmdb-server/rest-api/topologyQuery
with the following payload:

{
"nodes": [
{
"type": "cpu",
"queryIdentifier": "cpu1",
"visible": true,
"includeSubtypes": true,
"layout": ["name"],
"attributeConditions": [{
"attribute": "name",
"operator": "like",
"value": "%Pentium%"
}],
"linkConditions": []
}],
"relations": []
}

At the same time you need to set the following header:

Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzQzNTc3MDYsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.cV


Ysuum1CqaqfZV1K5KJ8nidOOif8Wv9tZsLFFZPbSs

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

1.1.5.2.3.2.2. Generate Change Report


Operations Bridge Manager:24.4/RestApiGenerateChange

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

1.1.5.2.3.2.3. Sample Data Model


Operations Bridge Manager:24.4/RestApiSampleData

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

1.1.5.2.3.2.4. Insert Topology


Operations Bridge Manager:24.4/RestApiInsertTopology

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

1.1.5.2.3.2.8. Get Related CIs


Operations Bridge Manager:24.4/RestApiGetRelCIs

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

1.1.5.2.3.2.9. Get Relation


Operations Bridge Manager:24.4/RestApiGetRelation

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

1.1.5.2.3.2.10. Delete Relation


Operations Bridge Manager:24.4/RestApiDeleteRelation

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

1.1.5.2.3.2.11. Sample Topology Query


Operations Bridge Manager:24.4/RestApiSampleTopologyQuery

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

1.1.5.2.3.2.12. Execute Query by Name


Operations Bridge Manager:24.4/RestApiExecuteQuerybyName

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

1.1.5.2.3.2.13. Execute Query by Definition


Operations Bridge Manager:24.4/RestApiExecuteQuerybyDefinition

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

1.1.5.2.3.2.14. Run Impact Analysis


Operations Bridge Manager:24.4/RestApiRunImpactAnalysis

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

1.1.5.2.3.3. Multiple CMDB Calls


Operations Bridge Manager:24.4/RestApiMultiCMDBCalls

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

1.1.5.2.3.3.1. Converting UCMDB IDs to Global Ids


Operations Bridge Manager:24.4/RestApiUCMDBtoLocalIDs

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

1.1.5.2.3.3.2. Converting Global IDs to UCMDB Ids


Operations Bridge Manager:24.4/RestApiGlobaltoUCMDBIDs

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

1.1.5.2.3.4. History Changes


Operations Bridge Manager:24.4/RestApiHistoryChanges

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.1.5.2.3.5. Step By Step: How to Retrieve CIs Using


REST API
This task includes the following steps:

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.

a. In Local Client, go to Modeling > Modeling Studio to model the data.

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.

As you can see there exists two nodes.

2. Make REST calls and retrieve CIs

a. Define two requests in SoapUI:

i. One to authenticate which gives you back an authentication token

ii. Another one to retrieve query results.

The second request uses response from the first one to authenticate.

JSON response of the first request will look like this:

{"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.

Header value would look like: Bearer <token_value>

As you can see in the screenshot below:

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

There is a space between the keyword and the token


value.

Now you can make authenticated REST requests to UCMDB.

b. Write the TQL query name into the message body.

In the image above you also have the response which contains two CIs without any properties.

3. Additional properties knowledge base

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 .

The Query Node Properties dialog opens.

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

c. Select the check box for Select attributes for layout.

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

e. Click OK to save the changes.


f. Click Save to save the TQL query.

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.

They appear in the response if they have a value.

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.

Advanced query features


Query node can also have condition on different kind of properties, so just specific instances of some CI types appear depending on the
created conditions.

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

1.1.5.2.4. RTSM Web Service API


This section includes the following:

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

1.1.5.2.4.2. RTSM Web Service API Reference


Operations Bridge Manager:24.4/WebAPIReference

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

1.1.5.2.4.3. RTSM Impact Analysis Methods


Operations Bridge Manager:24.4/WebAPIImpactAnalysisMethods

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

1.1.5.2.5. Internal-Global ID Conversion API


Operations Bridge Manager:24.4/IntGlobalIDConvAPI

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

1.1.5.2.5.1. Using the Internal-Global ID Conversion


API
Operations Bridge Manager:24.4/IntGlobalIDConvAPIUsing

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

1.1.5.2.5.2. How to Convert RTSM Internal IDs to


Global IDs
Operations Bridge Manager:24.4/IntGlobalIDConvAPIRTSMtoGlobal

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

1.1.5.2.5.3. How to Convert Global IDs to RTSM


Internal IDs
Operations Bridge Manager:24.4/IntGlobalIDConvAPIGlobalToRTSM

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

1.2. Develop Stakeholder Dashboards and reports


This section includes the following:

Create custom widgets


Modify the Visio shape
Define the custom widget code

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

1.2.1. Create custom widgets


You can create custom widgets to visualize your data in ways other than what's possible by default with the Visio Stencil. By coding
your own personalized widgets, you can illustrate your business value in any form required.

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.

For full code examples, see the ColorYourData GitHub website.

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

1.2.2. Modify the Visio shape


Custom widgets require a Visio shape that represents their appearance in the dashboard. You can create the shape when you design
the dashboard in Visio. Additionally, you can make it reusable by saving it as a stencil. The shape that you create in Visio is the visual
representation of your widget in the dashboard. In its simplest form, it's just a shape. But you can extend it to offer interactive
elements that define graphical attributes, like the hole size of a donut chart.

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 .

You can define these properties in Visio's shape data menu:

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:

Name:opr_item_type Type:string Value:<type-of-your-widget>

Name:opr_dashboard_item Type: Boolean Value:TRUE

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.

Widget shape type


There are two widget shapes:

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

Name:opr_grouping_item Type:Boolean Value:TRUE

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.

Save shape as stencil


To make a custom widget shape reusable, you can save it as a Visio stencil. In the following example, you learn to create a new stencil
and save it as a . vssx file so that you can reuse it later.

To create a stencil, do the following:

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

1.2.3. Define the custom widget code


Use a Custom Widget API to code the custom widget actions. The API enables you to create your own widget type by using DOM and SV
G manipulation.

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:

Variable name Library Version

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.

window.bvdPluginManager.registerWidget({...}) // access from window's scope bvdPluginManager.registerWidget({...}) // access it directly

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.

Example: Below is an example of the widget configuration file:

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
}

Init Plugin Callback


The init callback function is the place where you do all the coding for your custom widget. The application executes the function when
it loads the widget. The init function receives a context object as a parameter, which has a set of properties as defined below:

Property Type Description

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).

jsLoadService function Service to load external JavaScript files.

getStatusColor function Function to get the calculated status color.

$http object AngularJS $http service: widget uses this to get additional data from outside of Operations Cloud.

onChange function Widget data change registration function.

onInit function Widget initial data function (data from cache).

getProperty function Function to get the value of the widget's property.

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)

Return: promise object

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
});

onChange callback function

Functionality: Register an event when the widget receives a data channel update.

Params : plain object which contains these properties:

Property Description

channel the channel name (optional)

the change handler (called with the data received from


callback
the server)

ctx.onChange({
channel: 'myChannel',
callback: function(dataUpdateEnvelope) {
if (dataUpdateEnvelope && dataUpdateEnvelope.data) {
// update displayed date with content of dataUpdateEnvelope.data
}
}
});

onInit callback function

Functionality: Get the initial data displayed by this widget.

Params : plain object which contains these properties:

Name Description

chann
the channel name (optional)
el

number of items from cache (max 9.999.999) or timestamp


itemC
(Unix time ms). Using a timestamp will return all data from
oun t
that time until now.

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.

Params : property name (string)

Return: object of property value

var range = ctx.getProperty('bvd_range');

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

object which contains these properties:

severity

info , warning , or error (string)


title: the title of this notification (string)
text: the notification text (string)

Return

none

getChannelProperties function

;* Functionality: Get additional information for the selected data channel.

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.

Custom Widget configuration UI


Custom widgets require a widget configuration UI for the Dashboards page. The bvdPluginManager API generates the UI.

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:

Property Type Description

id string Unique ID of the property.

type string String of any supported input type: number , text , or channel .

label string Label to display on the Dashboards page.

mandatory boolean Optional. Indicate that the property is mandatory for proper functionality of the widget (default is false ).

default object Optional. Default value of this property.

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_field Created if hasData value is true in the registerWidget property.

opr_channel Created if hasDataChannel value is true in the registerWidget property.

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.

Save the JavaScript file


After you create the custom widget code, you must save it as a JavaScript file on the Operations Cloud server to be able to use it.
Place your custom widget code into the directory <conf_volume>/bvd/var/bvd/widget
<conf_volume> is the NFS directory for application related configuration files that you specified during the installation. The proposed
directory is /var/vols/itom/conf .

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

1.3. Develop Custom Data Integration


OPTIC Reporting capability offers you several out-of-the-box reports that depict the health of your environment. For details about the
out-of-the-box reports, see Use OPTIC Reporting.

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

For more information, see Custom metric ingestion

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

1.3.1. Custom metric ingestion


You can ingest metrics of your choice (custom metrics) from Operations Agent into OPTIC Data Lake using the Agent Metric Collector or
the streaming policies.
For detailed steps, see:

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

1.3.1.1. Custom metric ingestion using CMI tools and


Agent Metric Collector
The Operations Agent enables you to log custom data into the Metrics Datastore along with the default performance metric classes.
The Custom Metric Ingestion (CMI) tools enable you to ingest the custom data (metrics) from the Metrics Datastore into OPTIC
Data Lake.

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.

Custom metric ingestion tools


The Custom Metric Ingestion (CMI) tools enable you to ingest custom metrics into OPTIC Data Lake. It includes a set of tools, which
you must run in the following sequence:

​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:

wget --no-check-certificate https://<externalAccessHost>:<externalAccessPort>/staticfiles/custom-metric-ingestion/<CMI_yyyy.mm.zip>

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

wget --no-check-certificate https://vm.myexample.net/staticfiles/custom-metric-ingestion/CMI_202x.xx.zip --2022-08-09 07:55:02 -- https://v


m.myexample.net/staticfiles/custom-metric-ingestion/CMI_202x.xx.zip Resolving ~. vm.myexample.net (vm.myexample.net)... 16.78.51.57 C
onnecting to vm.myexample.net (vm.myexample.net) 116.78.51.571:443... connected. WARNING: The certificate of 'vm.myexample.net' is n
ot trusted. WARNING: The certificate of 'vm.myexample.net' hasn't got a known issuer. HTTP request sent, awaiting response... 200 OK Lengt
h: 23196480 (22M) (application/zip] Saving to: "CMI_202x.xx.zip
CMI_202x.xx.zip 100%[=============================================>] 22.12M 78.7MB/s in 0.35
2022-08-09 07:55:03 (78.7 MB/s) - CMI_202x.xx.zip' saved [23196480/23196480)

curl -k https://server.example.net/staticfiles/custom-metric-ingestion/CMI_202x.xx.zip --output CMI_202x.xx.zip

For example:

[root@~ cmicdy] curl -k https://vm.myexample.net/staticfiles/custom-metric-ingestion/CMI_202x.xx.zip --output CMI_202x.xx.zip


& Total Received & Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 22.1M 100 22.1M 0 0 86.7M 0 -- ------ ---- ---- 87.0M

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

To run the codatoexcel, exceltojson_schema, and exceltoyaml_oacollector tool:


Spreadsheet editor ( .xlsx editor)
Java 1.8 or higher

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.

Terms used in this document


Term Description

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

1.3.1.1.1. Guidelines to create custom content


The Custom Metric Ingestion (CMI) tools enable you to create custom content to ingest custom metrics from the Metrics
Datastore into OPTIC Data Lake.

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

1.3.1.1.2. Transform data using metric


transformation
You can use the metric transformation feature to transform or modify values of the collected data to suit your data transformation
requirements. The following is the structure in which you can give the transformation details to a collector:

"metric_transformation": {
"ALL": {
"rules": [
{
"from": "test",
"to": ""
}
]
},
"SCOPE_GLOBAL": {
"rules": [
{
"from": "-1",
"to": ""
}
]
}
}

Guidelines to use metric transformation


You can specify custom transformations for each class by adding an entry of each class to the "metric_transformation" field. The
"ALL" section is applicable to all the classes. However, if a custom transformation of the same value is present for some other
class, it overrides the transformed values inside the "ALL" section.
For example:
In the following json code, the values of the "ALL" class undergo transformation from test to abc. The values of the
SCOPE_GLOBAL call undergo transformation from test to XYZ.

"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

1.3.1.1.3. Ingest custom metrics into OPTIC Data


Lake
Follow the steps to ingest the custom metric from the Metrics Datastore into OPTIC Data Lake:

Run the codatoexcel tool


Follow one of the two options:

Option 1: Run the tool on an Operations Agent


1. Log in to a server where the Operations Agent Performance Collection Component contains the metric data that you want to
define for collection.
2. Run the tool:
java -jar codatoexcel-<version>.0.jar -d <datasource_name> -c <class_name> -o <output_directory_path>
For example:
java -jar codatoexcel-202x.xx.jar -d SCOPE -c CPU -o "C:\Test Folder"

Note

The folder gets created if it doesn't


exist.

Option 2: Run this tool outside an Operations Agent


1. Run the ovcodautil -obj > <outfile>.txt command on Operations Agent to create a text file and retrieve the file.
2. Copy the <outfile>.txt file to the same machine where the Custom Metric Ingestion tools are present.
3. Run the tool:

java -jar codatoexcel-<version>.0.jar -s <outfile>.txt-d <datasource_name> -c <class_name> -o <output_directory_path>


For example:
java -jar codatoexcel-v2.0.jar -s outfile.txt -d SCOPE -c CPU -o "C:\Test Folder"

Note

The folder gets created if it doesn't


exist.

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

<DataSource>.xlsx and Configuration.xlsx files get generated.

Modify the <DataSource>.xlsx and Configuration.xlsx files


The <DataSource>.xlsx and Configuration.xlsx files get populated with default values for most columns. You need to review the
contents and make the required changes to ensure that the mandatory columns are populated. If you need aggregation or forecasting,
then adjust the corresponding columns.

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

Run the exceltojson_schema tool


Use this tool to create raw (metadata), enrichment (daily, hourly, and forecast), and retention JSON files from the excel inputs
(<DataSource.xlsx> and Configuration.xlsx).

Run the tool:

java -jar exceltojson_schema-<version>.jar -c <configuration_excel> -s <datasource_excel> -cn <content_name>

For example:

java -jar exceltojson_schema-2021.11.jar -c Configuration.xlsx -s opsb_ad.xlsx -cn msactivedirectory


In this example: <version> is 2021.11 , <configuration_excel> is Configuration.xlsx , <datasource_excel> is opsb_ad.xlsx and <content_n
ame> is msactivedirectory . All tables (raw, aggregation, retention) get generated in the opr directory where the tools are present.

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.

java -jar exceltojson_schema-2022.11.jar -c Configuration.xlsx -s opsb_ad.xlsx -cn msactivedirectory -b C:\test\metricoverride.json


In this example: <version> is 2022.11 , <configuration_excel> is Configuration.xlsx , <datasource_excel> is opsb_ad.xlsx and <content_n
ame> is msactivedirectory . When you pass the -b argument along with the file path metric values in JSON get overriden with the
values present in the metricoverride.json file for respective codaName . If you don't specify the file path, by default, it takes the metri
c-override.json file from the resource folder.

Mandatory parameters:

-source [or] -s : Datasource excel


-config [or] -c : Configuration excel
-content_name [or] -cn : Content name of MP. Specify the name of your choice. You will use this name to create a content zip file using the excel
toyaml_oacollector tool.

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.

Run the exceltoyaml_oacollector tool


1. Run the tool:

java -jar exceltoyaml_oacollector-<version>.jar -s <datasource_directory_path [OR] space_seperated_datasource_excels> -cn <content_name>

For example, with source as directory_path_with_all_datasource_excels:


java -jar exceltoyaml_oacollector-<version>.jar -s "C:\ msad_datasources" -cn msad

For example, with source as space-separated datasource excels:

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

java -jar exceltoyaml_oacollector-<version>.jar -s "C:\adspi.xlsx" "C:\adspi2.xlsx" -cn msad

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.

For example, with input options for metric transformation:


java -jar exceltoyaml_oacollector-<version>.jar -s "C:\Users\User1" -cn msad -mt
For more information on metric transformation, see Transform data using metric transformation.

For example, with input options for metric override:


java -jar exceltoyaml_oacollector-<version>.jar -s "C:\Users\User1" -cn msad -b C:\test\metricoverride.json
When you pass the -b argument along with the file path metric values in JSON get overridden with the values present in the metric
override.json file for respective codaName . If you don't specify the file path, by default, it takes the metric-override.json file from the
resource folder.

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>

For example: OpsB_MsSql_content_2021.03.002.zip

Configure target and credential YAMLs with different OBMs


Use this option to skip through certificate exchange steps to integrate external OBM (classic). You can use different names of target
and credential YAMLs files to integrate more than one OBM to one AI Operations Management.

Update the YAML files:

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.

Configure credentials and target


Follow the sequence to configure the target and credentials using ops-monitoring ctl :

1. ops-monitoring-ctl config set cs.server https://fqdn:19443


2. ops-monitoring-ctl config set cs.user (prompts username)
3. ops-monitoring-ctl config set cs.password (prompts password)
4. ops-monitoring-ctl create -f amc-credential-obm-certificate.yaml
5. ops-monitoring-ctl create -f amc-credential-obm-rtsm.yaml
6. ops-monitoring-ctl create -f amc-target-obm-rtsm.yaml
7. ops-monitoring-ctl create -f amc-target-oa.yaml
8. ops-monitoring-ctl create -f collector.yaml

Create hosts, port, and proxy configurations


Go to opr\integration\collection\target\amc-target-oa.yaml and update the parameters as required:

portFile: <portfile name>


etcHostsFile: <hostfile name>
proxyFile: <proxyfile name>

Create etc_hosts file configuration


Create etc_hosts.txt with the following format:
<IP address> <FQDN> <short name>
For example: 12.123.12.14 abcd.swinfra.net abcd
Run this command:

ops-monitoring-ctl create file -n etc_hosts.txt --readfile <etc_hosts.txt file path> -type generic

Create proxy file configuration


Create proxy.xml with the following format:

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

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>


<proxies>
<proxy>
<server>myproxy1.mydomain.com:8888</server>
<for>
<target>*.fw1.mydomain.com</target>
</for>
</proxy>
<proxy>
<server>myproxy2.mydomain.com:8888</server>
<for>
<target>*.fw2.mydomain.com</target>
</for>
</proxy>
</proxies>

Run the command:

ops-monitoring-ctl create file -n proxy.xml --readfile <proxy.xml file path> --type generic

Create port file configuration


Create portFile.txt with the following format:
<FQDN>:<PortNum>
For example: abcd.swinfra.net:0000
Run the command:

ops-monitoring-ctl create file -n port.txt --readfile < port.txt file path> -type generic

Deploy the content pack and start collection


Use the ops-content-ctl tool to upload the custom content to the AI Operations Management Content Manager and you must
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.

Validate GPG signature


GnuPrivacy Guard (GPG) is cryptographic software that you can use to encrypt or sign data and scripts to ensure their authenticity.
In this context, the custom metric ingestion tools that you download should be signed with a secret key so that you can verify that the
packages that you are installing have come from Open Text.
In this task, you will install GPG and then use it to verify if the Custom Metric Ingestion tools are digitally signed by Open Text.

Install the GPG tool


Note

Skip this step if you have the GPG tool on your


system.

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

Please select what kind of key you want:


(1) DSA and Elgamal (default)
(2) DSA (sign only)
(5) RSA (sign only)
Your selection?

5. When prompted to enter a key size. Enter 1024.


6. When prompted to enter a key length. Enter 1y.
For example:

Specify how long the key should be valid.


0 = key does not expire
<n> = key expires in n days
<n>w = key expires in n weeks
<n>m = key expires in n months
<n>y = key expires in n years
Key is valid for? (0)

7. Enter the following when prompted:


Real name: Enter your name
Email address: Enter your email id
Comment: Enter any comment
8. Enter a password.

A keyring gets created.

Download and import the keys


1. Download the public keys ( MF_public_keys.tar.gz ) from the Download File on to your local directory and extract them.
2. Run the command to import the keys into the GPG tool:

gpg --import /path_to_the_key/file_name_of_the_key

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.

Validate the signature


Run the command to verify that the Custom Metric Ingestion tools are digitally signed by Open Text:

gpg --verify <filename.sig> <tool name>

Here,

<filename.sig> Name of the signature file that you download along with the Custom Metric Ingestion tools.

<tool name> Name of the Custom Metric Ingestion tools.

For example:

gpg --verify CMI_24.4.001.zip.sig CMI_24.4.001.zip


gpg: Signature made Mon 17 Jun 2024 10:54:35 AM PDT
gpg: using RSA key XXXX
gpg: issuer "[email protected]"

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

1.3.1.1.4. Modify the workbooks


The <DataSource>.xlsx and <Configuration.xlsx> files get populated with default values for most columns. You need to review
the contents and make the required changes to ensure that the mandatory columns are populated. If you need aggregation or
forecasting, then adjust the corresponding columns.

Modify the <DataSource>.xlsx


Note

<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>:

Modify the columns to generate aggregation tables (daily and hourly)


Data
Column name Description
type

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.

Aggregation(d/h/ By default, this field is set to d, h.


String
d,h) You may choose to use the default value or set the value as daily(d), or hourly(h).

If you set the Aggregation as daily, hourly, or both daily and hourly, you must specify the aggregation type. The default
value is g.

Set this value to indicate the type of aggregation: GenericAggregateRuleConfiguration (g), or


Aggregation Typ PercentileAggregateRuleConfiguration (p), or both (g,p).
String
e(g/p/g,p)
GenericAggregateRuleConfiguration: Generic aggregate configuration enables you to roll up data using simple
aggregate functions ( min, max, average ).
PercentileAggregateRuleConfiguration: Percentile aggregation computes the value below which 'x' percentage of
the field values exist.

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.

Modify the columns to generate forecast tables


Column Data
Description
name type

Forecast Req The default value is n.


String
uired (y/n) Specify y if you want to predict values for time series data.

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

By default, this field is set to fp, dtt.

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.

dtt specifies the days to the threshold.

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​​.

Modify the Configuration.xlsx


The Configuration.xlsx enables you to update the retention period. The following table provides you with the information to modify
the Configuration.xlsx:

Provision retention period


Column Data
Description
name type

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.

Verify the columns to generate aggregation tables (daily and hourly)


The Configuration.xlsx files get populated with default values for most columns. You need to review the contents and make the
required changes to ensure that the mandatory columns are populated.

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.

Modify the following in the Aggregation worksheet:

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.

Specify the summarization interval in minutes.


groupBy
Integer It should contain values in the Unix epoch form. The groupByInterval value can't be less than 1 and greater than 1440 ( 1 day )
Interval
minutes. Specify 1440 for daily and 60 for hourly aggregation.

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

If you don't specify orderBy, installation of custom content would fail.

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.

Update the retention period in the Aggregation worksheet.

Modify the columns to generate forecast tables


Modify the following in the Forecast worksheet:

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

1.3.1.1.5. Metrics override


This page provides information on how to use the metrics override feature. You can use the -b argument to override metrics by making
bulk update to metrics values in the DataSource.xlsx file.

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.

The following table details the raw schema keys.

Key Data type Description

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)

The following table details the aggregation schema keys.

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)

The following table details the forecast schema keys.

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)

For more understanding, see the following bulk file example.

[
{
"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)

/* The following fields belong to basic aggregation_schema */


"aggregationRequired": "y", // String value y/n (Aggregation Required column in the datasource.xlsx file)
"aggregation": "d,h", // String value of d/h/d,h ( d-> Daily , h-> Hourly ) (Aggregation column in the datasource.xlsx file)
"aggregationType": "g,p", // String value of g/p/g,p (g -> GenericAggregation , p-> PercentileAggregation) (Aggregation Type colum in
the DataSource.xlsx file)
"aggregationFunction": "min", // String value of sum/average/min/max/count/lastval (Aggregation Function colum in the DataSource.xlsx
file)
"percentile": 100, // Integer value between 1-100 (Percentile column in the DataSource.xlsx file)

/* The following fields belong to basic forecast_schema */


"forecastRequired": "y", // String value y/n (Forecast Required column in the DataSource.xlsx file)
"forecastRuleType": "fp,dtt", // String value of fp/dtt/fp,dtt (Forecast RuleType column in the DataSource.xlsx file)
"forecastPoint": "30,60,90", // String value for number of days to be forecast comma separated (ForecastPoint column in the Data
Source.xlsx file)
"forecastFPMinCondition": "30-35,60-65", //String value (, (comma separated) and - (hyphen) split) for min forecast day and forecast poin
t (ForecastFP Condition(Min-Forecast) column in the DataSource.xlsx file)
"forecastFPMaxCondition": "30-35,60-65" //String value (, (comma separated) and - (hyphen) split) for max forecast day and forecast poi
nt (ForecastFP Condition(Max-Forecast) column in the DataSource.xlsx file)
"forecastThresholdValue": "30,60,90", // String value for number of days to be forecast comma separated (ForecastThreshold col
umn in the DataSource.xlsx file)
"forecastDTTMinCondition": "30-35,60-65", //String value (, (comma separated) and - (hyphen) split) for min forecast day and forecast poi
nt (ForecastDTT Condition(Min-Forecast) column in the DataSource.xlsx file)
"forecastDTTMaxCondition": "30-35,60-65" //String value (, (comma separated) and - (hyphen) split) for max forecast day and forecast p
oint (ForecastDTT Condition(Max-Forecast) 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

1.3.1.1.6. Manage custom content


After you install the custom content, you may use the Set up monitoring CLI for Agent Metric Collector to manage it throughout its
lifecycle. You can upgrade, uninstall and delete the custom content.

Upgrade custom content


Note

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:

Option 1: Using the ops-content-ctl tool


1. Download the content:

ops-content-ctl download content -n <content_name> -v <content_version>

For example:

ops-content-ctl download content -n OpsB_Apache_Content -v 2020.08.001

2. Modify and save the JSON files.

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>

For example, rename OpsB_Apache_Content_2020.08.001.zip to OpsB_Apache_Content_2020.08.002.zip

<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, rename OpsB_Apache_Content_2020.08.001.zip to OpsB_Apache_Content_2020.08.001.002.zip

4. Upload the renamed content:

ops-content-ctl upload content -f <renamed_file_name>

For example:

ops-content-ctl upload content -f OpsB_Apache_Content_2020.08.001.002.zip

5. Upgrade to the new version of the content:

ops-content-ctl upgrade content -n <content_name> -v <new_content_version>

For example:

ops-content-ctl upgrade content -n OpsB_Apache_Content -v 2020.08.001.002

Option 2: Using the CMI tool


You can modify the following:

Add a column - You must update the <DataSource.xlsx>


Include data aggregations and forecast - You must update the <DataSource.xlsx> and Configuration.xlsx. For information

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

about modifying the excel workbooks, see "Modify the workbooks".

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>

For example, rename OpsB_Apache_Content_2020.08.001.zip to OpsB_Apache_Content_2020.08.002.zip

<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, rename OpsB_Apache_Content_2020.08.001.zip to OpsB_Apache_Content_2020.08.001.002.zip

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.

Start/Delete/Verify the collection


1. Follow the steps to start the collection:
i. Unzip the content pack and locate the YAML files for AMC configurations under the opr\integration\collection\oa\
<content_name> folder.
For example: opr\integration\collection\oa\agent_infra
ii. Run the command to create and start the collection:

ops-monitoring-ctl create -f <path to configuration yaml file>

Here, replace <path to configuration yaml file> with the path of the configuration yaml file.
For example:

ops-monitoring-ctl create -f opr\integration\collection\oa\msadmp\ad_collector.yaml

iii. Run the command to delete the collection:

ops-monitoring-ctl delete -f <path to configuration yaml file>

Here, replace <path to configuration yaml file> with the path of the configuration yaml file.
For example:

ops-monitoring-ctl delete -f opr\integration\collection\oa\msadmp\ad_collector.yaml

iv. Run the command to verify the status of the collection:


ops-monitoring-ctl get collector-status

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

1.3.1.2. Custom metric ingestion using the streaming


policies
After you configure system infrastructure reports using metric streaming policies, data for all instances gets collected. OPTIC
Reporting capability supports metrics streaming from the following metric classes into OPTIC Data Lake: APPLICATION, GLOBAL,
CPU, DISK, NETIF, FILESYSTEM. If you want to integrate other metrics of your choice (those that aren't used in out of the box
reports) into OPTIC Data Lake, follow the steps:

Task 1: Update the configuration file


1. On OBM, go to Administration > Monitoring > Policy Templates.
2. Click Template By Type, expand Configuration and click Configurations File.

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.

Task 2: Update metric streaming configuration


1. On OBM, go to Administration > Monitoring > Policy Templates.
2. Select Template By Type, expand Configurations and click Metric Streaming Configuration

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

Task 3: Assign and deploy the updated aspect


1. On OBM, go to Administration > Monitoring > Management Templates & Aspects .
2. Expand Configuration Folders, expand Infrastructure Management, and then click Systems Infrastructure Aspects.

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:

1. Click Policy Templates.


2. Click the Version drop-down for Sys_SystemMetrics_MetricStoreMapping and select the version of the aspect you
created.
3. Click the Version drop-down for Sys_SystemMetrics_MetricStoreStreaming and select the version of the aspect you
created.
5. Click Save. The version of the System Metrics Metric Store Streaming gets incremented by 0.1.

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

1.3.2. Open data ingestion


Data ingestion allows you to ingest data from different external data sources and store it in the OPTIC DL store. This data can be later
used and accessed for further analysis.

Ingestion method and interface


Streaming is the method to ingest real-time data into OPTIC DL. The following diagram illustrates the data flow into OPTIC DL Store
and the access to stored data.

To ingest the data into OPTIC DL, you can use the HTTPS streaming interface. OPTIC DL RESTful APIs are documented using the
OpenAPI Specification.

The available OPTIC DL interfaces are:

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.

For more details on the APIs, see the Developer Central.

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

To ingest data into the OPTIC DL store, you must

1. Identify the data to ingest into the OPTIC DL store.


2. Decide the structure of the data. You must define the datasets to hold the data in Vertica. For more information, see the
Guidelines to structure the data.
3. Find the aggregate and forecasting requirements.
4. Stream the ingestion data in JSON format.
You can use the streaming method to continuously ingest data in near real time. You can ingest data in small micro batches and
ingest a few KB of data per request.
5. Find the data retention needs for raw and aggregated data.
6. Find the size of the deployment using the sizing calculator for the application.

Data ingestion workflow

To use the Open Data Ingestion APIs, you must:

1. Identify the data.


2. Decide the type of ingestion and processing (aggregate, forecast) requirements.
3. Define the raw and summary datasets.
4. Create datasets and aggregation using OPTIC DL Administration APIs.
5. Create streaming clients to ingest data to OPTIC DL.
6. Access data using OPTIC DL Data Access REST interface or using JDBC/ODBC interface.

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

1.3.2.2. Data model guidelines


Data model definitions in the OPTIC Reporting content should follow data model guidelines. The following are a few data model
guidelines:

Dataset naming conventions


Common system fields
Guidelines for field names
Guidelines for aggregation dataset
Data Ingestion

Data model guidelines use the following terms:

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.

Dataset naming conventions


Table names should be unique and contain only lower case alphabets [a-z], numbers [0-9 ], and word separators. It's
recommended to begin the names with alphabets and the maximum length of name is 120 characters.
Names of datasets should follow the format <domain prefix>_<table class> . AI Operations Management datasets should typically
use opsb as domain prefix. CMDB entity datasets will use cmdb as domain prefix and Operations Events integrated via OBM will
follow opr prefix (representing IT Operations).

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.

The generic IT Operations


AI
area for which solutions
Operations opr Operations
are offered by OpenText
Management
products/solutions.

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.

Common system fields


The following table summarizes the mandatory AI Operations Management system field definitions used in any dataset. It's expected
that the populated system fields are aligned to the semantics defined and also, minimizing the scope for null values in the database.

System Data Maximum Display


Unit Description
field type length label

cmdb_glo CMDB
UUID The global CMDB id of the monitored entity (CI).
bal_id global ID

cmdb_id UUID CMDB ID The CMDB id of the monitored entity (CI).

Possible Values are "push" or "pull".


A push is when a data producer (producer instance id) actively pushes data directly to
collection
Collection OPTIC Data Lake. For example: SiS or an agent pushing data directly to OPTIC Data Lake.
_data_flo string 80
Data Flow A pull request is when a data producer provides the data via an API, but a separate process
w
does periodic, scheduled collection of data. For example: A collection service such as AI
Operations Management collects agent data.

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

The actual collector that's actively collecting the data.


collection Collection Example values are: SiteScope Streaming, Operations Agent Streaming, Collection Service -
string 255
_type Type Agent, VMware, BPM Probe, RUM Engine, OBM Server Event Forwarding, Synthetic, AWS,
Prometheus, SCOM MP.

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

System Data Maximum Display


Unit Description
field type length label

timestam
integer Timestamp Unix epoch time at which the counter value (sample) was gathered.
p_utc_s

Guidelines for field names


Field names must follow the format <NAME>_<AGGREGATION_TYPE>_<UNIT>.

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

Following is the wrong method:


12/06/2022:06:30:00 dbname1 metric1val
12/06/2022:06:30:00 dbname1 metric2val
12/06/2022:06:30:00 dbname1 metric3val

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.

Create JSON as defined in RFC 8259.


Don't use nested JSON objects. This is because one JSON object represents one row in the dataset.
The size of the HTTP request must be in a few KBs for optimal performance.
The clients must send parallel HTTP requests for better performance considering HTTP is a request/response protocol.

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

1.3.2.4. Get started


This topic guides you to:

Create a sample dataset.


Use Streaming to ingest data in the sample dataset.
Access the data using the Data Access interface.

Make sure you have completed the steps in the Plan and Prepare section before you proceed with this topic.

Get IdM access token to create the dataset


Get the IdM access token to create the dataset using the di_admin user (the user you created in the Prepare section) with dataset
creation API privileges. You will require an access token to invoke OPTIC DL Administration API. You must use Identity Management
(IdM) to get the token. Create a file auth_diadmin.json as follows with the username and password value used in your setup:

{
"passwordCredentials" : {
"username" : "di_admin",
"password" : "<password>"
},
"tenantName" : "Provider"
}

Send an HTTP POST request to IdM service using the following command:

$ curl -k -X POST https://<HOST>:<PORT>/idm-service/v3.0/tokens \


-H 'content-type: application/json' -d @<auth_diadmin.json>

A response similar to the following appears:

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.

Get the IdM access token to ingest the dataset


Perform this step only for streaming the data. Get the IdM access token to ingest the dataset using the di_ingestion user (the user you
created in the Prepare section) with data ingestion API privileges. You will require an access token to invoke OPTIC DL HTTP Receiver
API to stream data. You must use Identity Management (IdM) to get the token. Create a file auth_diingest.json as follows with the userna
me and password value used in your setup:

{
"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:

$ curl -k -X POST https://<HOST>:<PORT>/idm-service/v3.0/tokens \


-H 'content-type: application/json' -d @<auth_diingest.json>

A response similar to the following appears:

{
"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.

Get IdM access token to access the dataset


Get the IdM access token to access the data using the di_data_access user (the user you created in the Prepare section). You will require
an access token to invoke OPTIC DL Data Access API to access data. You must use Identity Management (IdM) to get the token. Create
a file auth_didataaccess.json as follows with the username and password value used in your setup:

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:

$ curl -k -X POST https://<HOST>:<PORT>/idm-service/v3.0/tokens \-H 'content-type: application/json' -d @<auth_didataaccess.json>

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:

$ curl -k -X POST https://<HOST>:<PORT>/idm-service/v3.0/tokens \


-H Content-Type: application/json \
--data-raw '{
"refresh_credentials":{ "refresh_token":"<REFRESH_TOKEN>" }
}'

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

The Body is empty.

You will see a 204 return code on a successful revoke.

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

1.3.2.4.1. Open data ingestion API tutorial for


streaming
This topic gives you a tutorial on creating a simple dataset, defining roll up on that dataset, and ingesting data using the streaming
interface to OPTIC DL. You can find the complete list of APIs here.

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.

Step 1: Send a POST request to the Administration interface to create the


dataset
Create a dataset and a JSON file for the dataset. For example: The dataset name is node_demo and the JSON file name
is dataset.json . This dataset contains one metric which is cpu_util .

{
"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:

$ curl -k -X POST https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/dataSetConfiguration \


-H 'content-type: application/json' -H 'X-Auth-Token: <token id noted from the IdM auth_diadmin.json POST reponse>' -d @<dataset.json>

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"
}
]
}

Step 2: Send a POST request to the Administration interface to create the


aggregation
The following examples describe how to create the aggregation for hourly and daily rollup.

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:

$ curl -k -X POST https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/aggregateConfiguration \


-H 'content-type: application/json' -H 'X-Auth-Token: <token id noted from the IdM auth_diadmin.json POST reponse>' -d @<hourly-aggregation.jso
n>

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

"displayName": "Average CPU Utilization",


"description": "Average hourly 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": "avg"
},
{
"aggregationType": "GenericAggregateRuleConfiguration",
"sourceFieldId": "cpu_util",
"destinationFieldId": "min_cpu_util",
"destinationField": "min_cpu_util",
"displayName": "Minimum CPU Utilization",
"description": "Minimum hourly 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 hourly 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 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:

$ curl -k -X POST https://<EXTERNAL_ACCESS_HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/aggregateConfiguration \


-H 'content-type: application/json' -H 'X-Auth-Token: eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzkwODE5NzdkNTdmODBhMDE3ZDU3Zjgz
YjVlMDEyMCIsImlzcyI6IklkTSAxLjM0LjAtYnVpbGQuMjQ5IiwiY29tLmhwZS5pZG06dHJ1c3RvciI6bnVsbCwiZXhwIjoxNjM4OTU5NjQ2LCJjb20uaHAuY2xvd
WQ6dGVuYW50Ijp7ImlkIjoiMmM5MDgxOTc3ZDU3ZjgwYTAxN2Q1N2Y4MzBlOTAwYzMiLCJuYW1lIjoiUHJvdmlkZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiYW
RtaW4iLCJpYXQiOjE2Mzg5NTc4NDYsImp0aSI6IjU1MzQxNjc5LWUwMGItNGI4NC05MDRiLWZmNWNlYTE4YWFkOCJ9.OL7fVW2Xg2lc0gBomsUe2mHGA
Xz6_AmdxFSSzzKO95w'-d @daily-aggregation.json

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"
]
}
}

Step 3: Send a POST request to the Administration interface to create the


forecast
Forecasting is done based on historical data. The " analysisPeriod " field indicates the history period to be considered for deriving forecast
model. This is an optional parameter and if not specified, six weeks of history is considered for the analysis.

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:

$ curl -k -X POST https://<HOST>:<PORT>/itom-data-ingestion-administration/urest/v3/timeseriesForecastConfiguration \


-H 'content-type: application/json' -H 'X-Auth-Token: <token id noted from the IdM auth_diadmin.json POST reponse>' -d @<forecast.json>

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"
]
}

Step 4: Send the data using the streaming interface


OPTIC DL HTTP Streaming interface accepts a single JSON or a JSON stream or a JSON array in the request. For example: Send the
following data.json array as request:

[{"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:

$ curl -k -X POST https://<HOST>:<PORT>/itom-data-ingestion-receiver/data \


-H 'content-type: application/json' -H 'X-Auth-Token: <token id noted from the IdM auth_diingest.json POST reponse>' -H 'X-MonitoredCollection: no
de_demo'-d @<data.json>

Step 5: View the data using the data access interface


Run the following command to send a GET request to view the metadata details of the dataset:

$ curl -k -X GET https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata -H 'content-type: application/json' -H 'X-Auth-Token:


<token id noted from the IdM reponse>'

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"
}
]
}

Record dataset ID, of which you need to fetch the data.

Data Access API (Data by ID)

Execute the Data Access API call via the following curl call to fetch the details of the dataset:

$ curl -k -X GET https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSet/45035996273896960 -H 'content-type: application/json' -H 'X-


Auth-Token: eyJ0eXAiOiJKV1MiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzkwODA1ZDgwNzc1MGQxMDE4MDc3NTk4MTJkMDE0ZSIsImlzcyI6IklkTSAxLjM1LjAt
YnVpbGQuMzczIiwiY29tLmhwZS5pZG06dHJ1c3RvciI6bnVsbCwiZXhwIjoxNjUxMzE5MDc1LCJjb20uaHAuY2xvdWQ6dGVuYW50Ijp7ImlkIjoiMmM5MDgw
NWQ4MDc3NTBkMTAxODA3NzUxMDNlYjAwY2EiLCJuYW1lIjoiUHJvdmlkZXIiLCJlbmFibGVkIjp0cnVlfSwicHJuIjoiZGlkYXRhYWNjZXNzIiwiaWF0IjoxNjUxMz
E3Mjc1LCJqdGkiOiIwZGRkZmViMi01ZThkLTRiNjgtOGEyNC0wZWFiNmZjZTUzMGMifQ.1T0EqKXwflYqnZMDUvBH5YMgGaWY62PlM6HvaRcjQzc'

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

1.3.2.4.1.1. Sample JSON files


You can refer to the following JSON file examples:

Send a POST request to the Administration interface to create the


dataset
{
"id":"opsb_ext_node_id",
"name":"opsb_ext_node",
"displayName":"Open data Ingestion Node metrics",
"description":"Sample dataset with Node metrics for Open data ingestion demo",
"entityTypeCanonicalName":"node",
"fields":[
{
"id":"cpu_util_pct_id",
"name":"cpu_util_pct",
"type":"numeric",
"displayName":"CPU Utilization %",
"description":"CPU Utilization in percentage",
"fieldCanonicalName":"cpu_utilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"id":"disk_util_pct_id",
"name":"disk_util_pct",
"type":"numeric",
"displayName":"Disk Utilization %",
"description":"Disk Utilization in percentage",
"fieldCanonicalName":"disk_utilization",
"tags":[
{
"name":"fieldType",
"value":"metric"
},
{
"name":"measurementUnit",
"value":"percentage"
}
]
},
{
"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",

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"
}
]
}

Send a POST request to the Administration interface to create the


aggregation
{
"id":"opsb_ext_node_1h_id",
"name":"opsb_ext_node_1h",
"sourceDataSetId":"opsb_ext_node_id",
"destinationDataSetId":"opsb_ext_node_1h_id",
"destinationDataSet":"opsb_ext_node_1h",
"displayName":"Node Data Set Hourly",
"description":"Sample hourly dataset for Node metric",
"entityTypeCanonicalName":"node",
"aggregateRules":[
{
"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":[
{

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"]
}
}

Send a POST request to the Administration interface to create the


forecast
{
"id": "opsb_ext_node_forecast_id",
"name": "opsb_ext_node_forecast",
"displayName": "Node Forecast (ODI)",
"algorithm": "linear",
"sourceDataSetId": "opsb_ext_node_1d_id",
"destinationDataSetId": "opsb_ext_node_forecast_id",
"destinationDataSet": "opsb_ext_node_forecast",
"analysisPeriod": 90,
"forecastDefinition": [
{
"sourceFieldId" : "cpu_util_pct_avg_id",
"forecastFieldId" : "cpu_util_pct_fp_30_id",
"forecastField" : "cpu_util_pct_fp_30",
"forecastFieldDisplayName" : "ForecastRuleFP CPU Utilization %",

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
}

Send the data using the streaming interface

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

1.3.2.5. Send the data to OPTIC Data Lake


This topic gives you the steps to create the package to deploy the metadata files that consist of the JSON files.

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 OPTIC Data Lake REST APIs.


Create the folders manually and deploy the artifacts using the ops-content-ctl tool.

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.

Create the folders manually


Follow these steps:

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 > enrichment >


JSON files for data enrichment for forecast .
forecast

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.

3. Create a zip file of the content folder.


4. Download and configure the ops-content-ctl tool. For steps, see Administer OPTIC Reporting.
5. Run the ops-content-ctl tool to deploy the content to OPTIC Data Lake:

./ops-content-ctl upload content -f <content.zip>


./ops-content-ctl install content -n <content name> -v <version>
./ops-content-ctl list content -n <content name> -v <version>

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.3.2.6. Use APIs


OPTIC DL provides you set of RESTful APIs. Using these APIs, you can configure OPTIC DL, ingest the data into OPTIC DL from different
data sources using the HTTPS streaming interface. OPTIC DL RESTful APIs are documented using the OpenAPI Specification. You can
find the complete list of APIs here.

The available OPTIC DL interfaces are:

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.

OPTIC DL Administration REST APIs

API group Supported operations

dataset-config API to configure the dataset.

aggregate-config API to configure the aggregate/forecast dataset to roll up the data.

postload-config API to configure the task flow to define the sequence for task execution.

retention-config API to configure the retention period for the dataset.

dataset-status API to view the status of dataset configuration

OPTIC DL Data Access APIs

API Supported operations

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

1.3.2.6.1. OPTIC DL Administration REST Interface


The OPTIC DL Administration REST Interface helps you to configure the datasets and data processing rules like aggregate in OPTIC DL.

API group Supported operations

dataset-config API to configure the dataset.

aggregate-config API to configure the aggregate/forecast dataset to roll up the data.

postload-config API to configure the task flow to define the sequence of aggregate and forecast task execution.

retention-config API to configure the retention period for the dataset.

dataset-status API to view the status of dataset configuration

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

For forecast configuration:

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

To view the status of all datasets:

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

1.3.2.6.2. OPTIC DL HTTP Receiver Interface


You can ingest data from the external sources into OPTIC DL using the OPTIC DL HTTP Receiver Interface. The messages must be in
JSON format and streamed over HTTP/1.1 protocol.

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.

A similar output as follows appears:

headerFieldnameForTopic: messagetopic
headerFieldnameForTopicKey: messagekey

Note down headerFieldnameForTopic and headerFieldnameForTopicKey values and use that as the topic header and key header.

Payload

HTTP POST Request body must contain Messages in JSON format.

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.

JSON Object example:

{ "system" : "myhost.com" , "id" : 1 , "cpuutil" : 1.2 , "memutil": 6.3 , "user" : "root" }

JSON Object array example :

[{ "system" : "myhost1.com" , "id" : 1 , "cpuutil" : 1.2 , "memutil": 6.3 , "user" : "root" },


{ "system" : "myhost2.com" , "id" : 2 , "cpuutil" : 5.6 , "memutil": 16.8 , "user" : "admin" }]

JSON Object Stream example :

{ "system" : "myhost1.com" , "id" : 1 , "cpuutil" : 1.2 , "memutil": 6.3 , "user" : "root" }


{ "system" : "myhost2.com" , "id" : 2 , "cpuutil" : 5.6 , "memutil": 16.8 , "user" : "admin" }
{ "system" : "myhost3.com" , "id" : 3 , "cpuutil" : 9.7 , "memutil": 56.8 , "user" : "lxuser" }

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

200 Message successfully published to OPTIC DL Message Bus

If content type is other than application/json


400 JSON content is invalid
Headers not proper

401 Authentication token specified in X-Auth-Token is invalid

403 Authorization failed

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.

500 Internal server error.

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 an unsuccessful data submission, the response body appears as follows:

{"code":RESPONSE CODE ,"status":"Bad Request.","message":ERROR MESSAGE}

For example, response code 400 for improper headers appears as follows:

{"code":400,"status":"Bad Request.","message":"Unsupported header value"}

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

1.3.2.6.3. OPTIC DL Data Access API


The OPTIC DL Data Access REST API helps you to view the data stored in OPTIC Data Lake.

DataSetMetadata API
You can use this API to perform the following operations:

Operation URI

Get metadata of the datasets (tables) for all


datasets in the OPTIC DL store https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata

Get metadata of the datasets (tables) for a


particular dataset based on datasetID in the OPTIC https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata/{dataSetId
DL store }

For more information on each of the APIs, you can see the swagger documentation documented using OpenAPI specification here.

Get metadata of the datasets in the datastore


To get metadata of the datasets in the OPTIC Data Lake store.

URI

https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSetMetadata

Method

GET - View the Metadata of the datasets.

Get metadata of the dataset with Id in the datastore


To get metadata of the dataset with Id {dataSetId} in the OPTIC Data Lake store.

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.

Get data of the datasets with Id in the datastore

URI

https://<HOST>:<PORT>/itom-data-ingestion-store/urest/v2/dataSet/{dataSetId}

Method

GET - To view the data from datasets in the OPTIC DL store.

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

1.3.2.7. Enable Troubleshoot Performance Dashboard


Troubleshoot Performance dashboard enables you to plot the timeseries graph of metrics in a dataset and either Hyperscale
Observability or OPTIC Reporting capability uses the Troubleshoot Performance dashboards. To enable the Troubleshoot Performance
dashboard for a dataset, it's necessary to add five ( instanceType, instanceTitle, fieldType, fieldGroup, and data_grain ) tags in the Metadata
(Raw dataset configuration) and Enrichment (Aggregate dataset configuration) JSON.

Guidelines to add/enable Troubleshoot Performance tags


Note

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.

Syntax: { "name":"instanceType", "value":"<INSTANCE TYPE>,#<SEQUENCE NUMBER>"},{"name":"instanceTitle","value":"<INSTANCE TYPE>,


#<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.

field name tag value tag name

node_fqdn interface,#1 instanceTitle

node_fqdn interface,#1 instanceType

netif_name interface,#2 instanceTitle

netif_name interface,#2 instanceType

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

groupByFields array are found in the enrichment


JSONs.

Important

The Troubleshoot Performance chart can't be enabled for Forecast dataset. For more information, see Forecast display
issue.

Troubleshoot Performance tags


1. fieldGroup and data_grain :

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.

Syntax: {"name": "fieldGroup", "value": "<field group name>"}

The data_grain tag allows the Troubleshoot Performance API to select the dataset based on the time parameter. If the selected
time is:

0 hours to 36 hours: Data is fetched from the Raw table.


>36 hours and <= 2 weeks: Data is fetched from the Hourly table.
>2 weeks and <= 1 year: Data is fetched from the Daily table.

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.

Syntax: {"name": "instanceType", "value": "<Instance 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.

Syntax: {"name": "fieldType", "value": "metric"}

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

1.3.2.8. Create custom BVD reports


This topic provides information on creating your own reports using BVD.

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>

Access BVD stencil


1. Go to Administration > Resources.
2. Under VISIO STENCIL AND TOOLS, click Download to download the BVD stencil.

3. Extract the contents of the BusinessValueDashboardStencil.zip.


4. Open the Microsoft Visio tool. Go to Shapes > Stencils > More Shapes and click Open Stencil.

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

2. Select all elements (ctrl+a)


3. Click Save as and select SVG Scalable Vector Graphics (*.svg) to save the file

Upload SVG file to BVD


You must convert the visio files into SVG files before uploading them into BVD.

1. Convert visio to .svg file format.


1. In the visio file, select all elements (ctrl+a)
2. In the File menu, click Export and then click Change File Type.
3. Click SVG Scalable Vector Graphics (*.svg) and click Save as.

Important

Save the file with a different name. Avoid using report names. For example:
SystemInfrastructureSummary.svg

2. Log into BVD


1. Enter the following URL on a browser to access BVD:

https://<external access host>:<external access port>/bvd

2. On the BVD home page enter your name and password.


3. Click Log In. The BVD console opens.
3. Upload the SVG file to BVD
1. Access Administration > Dashboards and click + Add
2. Select the SVG file, and then click Upload Dashboard. The BVD dashboard editor opens and displays the uploaded
dashboard
3. You can change the properties of the dashboard (for example, the SVG file associated with the dashboard, the title, or the
background color)

Create data collector


1. Go to Administration > Data Collectors
2. Click New and select Data query. Specify the following settings:
Display name: For easier identification, the display label should reflect the data you are collecting, for example "Data
between 2020 and 2021" or "Query for Sold Items". The display label must be unique. It's added as the first tag of the
generated data channel
Description: Optional. Describe which data you want to retrieve with this query
Tags: Add additional tags to the data channel which describe or differentiate the queried data
Format: Decide if you want to use the Default format or the Use in Widget Group format. If you want to use your queried
data in a widget group, the query must return a column with the name id that contains unique values
Query: Enter the query you want to execute on the defined database. The query must begin with a SELECT statement and

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

mustn't contain a semicolon at the end.

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

3. Click SAVE DATA QUERY.

Associate columns with data field


1. Go to Administration > Dashboards
2. Choose the dashboard (Display name) that you have uploaded in the previous step and click Edit
3. Select the widget
4. In the Properties pane:
Under Data channel, select the data query that you created
Under Data field, attach the appropriate data columns
5. Click SAVE to save the dashboard

View the report


1. Click in the title bar
2. In the Dashboards menu, click the dashboard (Display name) that you created

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

1.4. AI Operations Management Data Model


This section provides information about datasets, which correspond to tables in the database. The datasets are present in the
mf_shared_provider_default schema in the database and are populated based on the OPTIC Data Lake integrations configured in the
application:

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.

List of units in the schemas


The following table lists the units used in the schemas and the descriptions:

Unit abbreviations Unit type Description

count Count Count

count_per_s Count Count per second

count_per_min Count Count per minute

b Data byte

kb Data Kilobytes

bps Data Bytes per second

kbps Data Kilobytes per second

mbps, mb_per_s Data Megabytes per second

kwh Energy Kilo watt per hour

hz Frequency Hertz

mhz Frequency Megahertz

pct Percentage Percent

pctl Percentage Percentile

us Time Microsecond

ms Time Millisecond

s Time Second

min Time Minute

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

Unit abbreviations Unit type Description

mt Weight Metric ton

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

1.4.1. Schema updates


This release offers the following schema updates:

OPTIC Reporting
The following new schemas are added in this release:

Operations Agent dataset


The following schema is available in this release to monitor and collect the application metrics for your infrastructure in OPTIC Data
Lake:

opsb_agent_application

Enterprise application Operations Bridge Unified Content for


Cassandra
The following new schemas are added in this release:

Operations Bridge Unified Content for Cassandra dataset


The following schemas are available in this release to monitor and collect the application metrics for your Operations Bridge Unified
Content for Cassandra:

Raw Tables Aggregated Tables (Hourly)

opsb_cassandra_buffer_pool opsb_cassandra_buffer_pool_1h opsb_cassandra_buffer_pool

opsb_cassandra_buffer_pool_networking opsb_cassandra_buffer_pool_networking_1h opsb_cassandra_buffer_pool

opsb_cassandra_client_connections opsb_cassandra_client_connections_1h opsb_cassandra_client_conn

opsb_cassandra_client_request_read opsb_cassandra_client_request_read_1h opsb_cassandra_client_requ

opsb_cassandra_client_request_write opsb_cassandra_client_request_write_1h opsb_cassandra_client_requ

opsb_cassandra_cluster_availability opsb_cassandra_cluster_availability_1h opsb_cassandra_cluster_ava

opsb_cassandra_cluster_state opsb_cassandra_cluster_state_1h opsb_cassandra_cluster_stat

opsb_cassandra_commit_log opsb_cassandra_commit_log_1h opsb_cassandra_commit_log

opsb_cassandra_compaction opsb_cassandra_compaction_1h opsb_cassandra_compaction

opsb_cassandra_datacenter_availability opsb_cassandra_datacenter_availability_1h opsb_cassandra_datacenter_

opsb_cassandra_dropped_message_read opsb_cassandra_dropped_message_read_1h opsb_cassandra_dropped_m

opsb_cassandra_garbage_collection opsb_cassandra_garbage_collection_1h opsb_cassandra_garbage_co

opsb_cassandra_node_availability opsb_cassandra_node_availability_1h opsb_cassandra_node_availa

opsb_cassandra_sstables_index opsb_cassandra_sstables_index_1h opsb_cassandra_sstables_in

opsb_cassandra_storage opsb_cassandra_storage_1h opsb_cassandra_storage_1d

opsb_cassandra_threadpools_internal_compaction_executor opsb_cassandra_threadpools_internal_compaction_executor_1h opsb_cassandra_threadpools

opsb_cassandra_threadpools_internal_gossip_stage opsb_cassandra_threadpools_internal_gossip_stage_1h opsb_cassandra_threadpools

opsb_cassandra_threadpools_internal_memtable_reclaim_memory opsb_cassandra_threadpools_internal_memtable_reclaim_memory_1h opsb_cassandra_threadpools

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

1.4.2. Enterprise application


This page captures the data model for the enterprise application that's used in OPTIC Data Lake. The data model includes the raw and
aggregated datasets from enterprise application. You can leverage these metrics in custom report queries.

Management Pack for IBM WebSphere Application Server


Forecast
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily)
Tables

opsb_websphere_ejb opsb_websphere_ejb_1h opsb_websphere_ejb_1d

opsb_websphere_ejb_descriptor opsb_websphere_ejb_descriptor_1h opsb_websphere_ejb_descriptor_1d

opsb_websphere_jdbc opsb_websphere_jdbc_1h opsb_websphere_jdbc_1d

opsb_websphere_jdbc_descriptor opsb_websphere_jdbc_descriptor_1h opsb_websphere_jdbc_descriptor_1d

opsb_websphere_jvm_perf opsb_websphere_jvm_perf_1h opsb_websphere_jvm_perf_1d

opsb_websphere_server_status opsb_websphere_server_status_1h opsb_websphere_server_status_1d Not


available
opsb_websphere_servlet opsb_websphere_servlet_1h opsb_websphere_servlet_1d

opsb_websphere_servlet_session_module opsb_websphere_servlet_session_module_1h opsb_websphere_servlet_session_module_1d

opsb_websphere_thread opsb_websphere_thread_1h opsb_websphere_thread_1d

opsb_websphere_thread_descriptor opsb_websphere_thread_descriptor_1h opsb_websphere_thread_descriptor_1d

opsb_websphere_transact opsb_websphere_transact_1h opsb_websphere_transact_1d

opsb_websphere_webapp opsb_websphere_webapp_1h opsb_websphere_webapp_1d

Management Pack for Jboss Application Server


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_jboss_appstatus Not available Not available

opsb_jboss_availability opsb_jboss_availability_1h opsb_jboss_availability_1d

opsb_jboss_gc opsb_jboss_gc_1h opsb_jboss_gc_1d

opsb_jboss_j2eeejbmsg opsb_jboss_j2eeejbmsg_1h opsb_jboss_j2eeejbmsg_1d

opsb_jboss_j2eeejbstful opsb_jboss_j2eeejbstful_1h opsb_jboss_j2eeejbstful_1d

opsb_jboss_j2eeejbstless opsb_jboss_j2eeejbstless_1h opsb_jboss_j2eeejbstless_1d

opsb_jboss_j2eeservlet opsb_jboss_j2eeservlet_1h opsb_jboss_j2eeservlet_1d

opsb_jboss_j2eewebapp opsb_jboss_j2eewebapp_1h opsb_jboss_j2eewebapp_1d

opsb_jboss_jarejbmessage opsb_jboss_jarejbmessage_1h opsb_jboss_jarejbmessage_1d

opsb_jboss_jarejbstateful opsb_jboss_jarejbstateful_1h opsb_jboss_jarejbstateful_1d


Not available
opsb_jboss_jarejbstateles opsb_jboss_jarejbstateles_1h opsb_jboss_jarejbstateles_1d

opsb_jboss_jdbc opsb_jboss_jdbc_1h opsb_jboss_jdbc_1d

opsb_jboss_jdbcpool opsb_jboss_jdbcpool_1h opsb_jboss_jdbcpool_1d

opsb_jboss_jmsqueue opsb_jboss_jmsqueue_1h opsb_jboss_jmsqueue_1d

opsb_jboss_jmstopic opsb_jboss_jmstopic_1h opsb_jboss_jmstopic_1d

opsb_jboss_jvm opsb_jboss_jvm_1h opsb_jboss_jvm_1d

opsb_jboss_transactions opsb_jboss_transactions_1h opsb_jboss_transactions_1d

opsb_jboss_webapp opsb_jboss_webapp_1h opsb_jboss_webapp_1d

opsb_jboss_webconhttp opsb_jboss_webconhttp_1h opsb_jboss_webconhttp_1d

opsb_jboss_webservlet opsb_jboss_webservlet_1h opsb_jboss_webservlet_1d

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

Management Pack for Microsoft Active Directory


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_ad_availability opsb_ad_availability_1h opsb_ad_availability_1d

opsb_ad_database_cache opsb_ad_database_cache_1h opsb_ad_database_cache_1d

opsb_ad_dfs_replicated_folder opsb_ad_dfs_replicated_folder_1h opsb_ad_dfs_replicated_folder_1d

opsb_ad_dfs_replication_conn opsb_ad_dfs_replication_conn_1h opsb_ad_dfs_replication_conn_1d

opsb_ad_directory_services opsb_ad_directory_services_1h opsb_ad_directory_services_1d

opsb_ad_dit_db_disk opsb_ad_dit_db_disk_1h opsb_ad_dit_db_disk_1d

opsb_ad_dit_db_filesize opsb_ad_dit_db_filesize_1h opsb_ad_dit_db_filesize_1d

opsb_ad_dit_log_disk opsb_ad_dit_log_disk_1h opsb_ad_dit_log_disk_1d

opsb_ad_dns opsb_ad_dns_1h opsb_ad_dns_1d

opsb_ad_federation_server opsb_ad_federation_server_1h opsb_ad_federation_server_1d

opsb_ad_fsmo opsb_ad_fsmo_1h opsb_ad_fsmo_1d

opsb_ad_fsmo_role_movement opsb_ad_fsmo_role_movement_1h opsb_ad_fsmo_role_movement_1d

opsb_ad_gc_replication opsb_ad_gc_replication_1h opsb_ad_gc_replication_1d


Not available
opsb_ad_khi_memory opsb_ad_khi_memory_1h opsb_ad_khi_memory_1d

opsb_ad_khi_network_interface opsb_ad_khi_network_interface_1h opsb_ad_khi_network_interface_1d

opsb_ad_khi_physical_disk opsb_ad_khi_physical_disk_1h opsb_ad_khi_physical_disk_1d

opsb_ad_khi_processor_info opsb_ad_khi_processor_info_1h opsb_ad_khi_processor_info_1d

opsb_ad_ntds opsb_ad_ntds_1h opsb_ad_ntds_1d

opsb_ad_ntds_process opsb_ad_ntds_process_1h opsb_ad_ntds_process_1d

opsb_ad_process opsb_ad_process_1h opsb_ad_process_1d

opsb_ad_replication_latency opsb_ad_replication_latency_1h opsb_ad_replication_latency_1d

opsb_ad_response_time opsb_ad_response_time_1h opsb_ad_response_time_1d

opsb_ad_service_health opsb_ad_service_health_1h opsb_ad_service_health_1d

opsb_ad_smb_conn_status opsb_ad_smb_conn_status_1h opsb_ad_smb_conn_status_1d

opsb_ad_sysvol opsb_ad_sysvol_1h opsb_ad_sysvol_1d

opsb_ad_trust opsb_ad_trust_1h opsb_ad_trust_1d

Management Pack for Microsoft Exchange Server


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_exch_active_manager opsb_exch_active_manager_1h opsb_exch_active_manager_1d

opsb_exch_activesync_connection opsb_exch_activesync_connection_1h opsb_exch_activesync_connection_1d

opsb_exch_activesync_perf opsb_exch_activesync_perf_1h opsb_exch_activesync_perf_1d

opsb_exch_asp_dotnet opsb_exch_asp_dotnet_1h opsb_exch_asp_dotnet_1d

opsb_exch_availability opsb_exch_availability_1h opsb_exch_availability_1d

opsb_exch_blocked_emails opsb_exch_blocked_emails_1h opsb_exch_blocked_emails_1d

opsb_exch_blocked_recipient opsb_exch_blocked_recipient_1h opsb_exch_blocked_recipient_1d

opsb_exch_content_filter_agent opsb_exch_content_filter_agent_1h opsb_exch_content_filter_agent_1d

opsb_exch_eac Not available

opsb_exch_hub_transport_dsn opsb_exch_hub_transport_dsn_1h opsb_exch_hub_transport_dsn_1d

opsb_exch_imap4_perf opsb_exch_imap4_perf_1h opsb_exch_imap4_perf_1d

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

opsb_exch_info_store_client opsb_exch_info_store_client_1h opsb_exch_info_store_client_1d

opsb_exch_mail_flow_check opsb_exch_mail_flow_check_1h opsb_exch_mail_flow_check_1d

opsb_exch_mailbox_database_perf opsb_exch_mailbox_database_perf_1h opsb_exch_mailbox_database_perf_1d

opsb_exch_mailbox_details opsb_exch_mailbox_details_1h opsb_exch_mailbox_details_1d

opsb_exch_mailbox_summary_data opsb_exch_mailbox_summary_data_1h opsb_exch_mailbox_summary_data_1d

opsb_exch_managed_service Not available

opsb_exch_mapi_connectivity opsb_exch_mapi_connectivity_1h opsb_exch_mapi_connectivity_1d

opsb_exch_memory_info opsb_exch_memory_info_1h opsb_exch_memory_info_1d

opsb_exch_network_interface opsb_exch_network_interface_1h opsb_exch_network_interface_1d

opsb_exch_owa_connection_check opsb_exch_owa_connection_check_1h opsb_exch_owa_connection_check_1d

opsb_exch_owa_perf opsb_exch_owa_perf_1h opsb_exch_owa_perf_1d


Not available
opsb_exch_owa_server Not available

opsb_exch_physical_disk opsb_exch_physical_disk_1h opsb_exch_physical_disk_1d

opsb_exch_pop3_perf opsb_exch_pop3_perf_1h opsb_exch_pop3_perf_1d

opsb_exch_processor_info opsb_exch_processor_info_1h opsb_exch_processor_info_1d

opsb_exch_processor_time opsb_exch_processor_time_1h opsb_exch_processor_time_1d

opsb_exch_public_folder_db opsb_exch_public_folder_db_1h opsb_exch_public_folder_db_1d

opsb_exch_public_folder_details opsb_exch_public_folder_details_1h opsb_exch_public_folder_details_1d

opsb_exch_rpc_client_perf opsb_exch_rpc_client_perf_1h opsb_exch_rpc_client_perf_1d

opsb_exch_service_status opsb_exch_service_status_1h opsb_exch_service_status_1d

opsb_exch_smtp_receive opsb_exch_smtp_receive_1h opsb_exch_smtp_receive_1d

opsb_exch_smtp_send_new opsb_exch_smtp_send_new_1h opsb_exch_smtp_send_new_1d

opsb_exch_smtp_send_old opsb_exch_smtp_send_old_1h opsb_exch_smtp_send_old_1d

opsb_exch_store_infomation_perf opsb_exch_store_infomation_perf_1h opsb_exch_store_infomation_perf_1d

opsb_exch_store_interface_perf opsb_exch_store_interface_perf_1h opsb_exch_store_interface_perf_1d

opsb_exch_top_destination opsb_exch_top_destination_1h opsb_exch_top_destination_1d

opsb_exch_top_recipient_details opsb_exch_top_recipient_details_1h opsb_exch_top_recipient_details_1d

opsb_exch_top_sender opsb_exch_top_sender_1h opsb_exch_top_sender_1d

opsb_exch_top_source opsb_exch_top_source_1h opsb_exch_top_source_1d

opsb_exch_transport_queue_info opsb_exch_transport_queue_info_1h opsb_exch_transport_queue_info_1d

opsb_exch_transport_queue_perf opsb_exch_transport_queue_perf_1h opsb_exch_transport_queue_perf_1d

opsb_exch_webserver_connection opsb_exch_webserver_connection_1h opsb_exch_webserver_connection_1d

opsb_exch_webserver_url_monitor Not available

opsb_exch_workload_management opsb_exch_workload_management_1h opsb_exch_workload_management_1d

Management Pack for Microsoft SQL Server


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_mssql_virtual_device_size opsb_mssql_virtual_device_size_1h opsb_mssql_virtual_device_size_1d

opsb_mssql_table_size opsb_mssql_table_size_1h opsb_mssql_table_size_1d

opsb_mssql_server_workload opsb_mssql_server_workload_1h opsb_mssql_server_workload_1d

opsb_mssql_server_status opsb_mssql_server_status_1h opsb_mssql_server_status_1d

opsb_mssql_server_perf opsb_mssql_server_perf_1h opsb_mssql_server_perf_1d

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

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast


Not availableTables

opsb_mssql_server_fault opsb_mssql_server_fault_1h opsb_mssql_server_fault_1d

opsb_mssql_server_conf opsb_mssql_server_conf_1h opsb_mssql_server_conf_1d

opsb_mssql_server_admin opsb_mssql_server_admin_1h opsb_mssql_server_admin_1d

opsb_mssql_filegroup_size opsb_mssql_filegroup_size_1h opsb_mssql_filegroup_size_1d

opsb_mssql_db_status opsb_mssql_db_status_1h opsb_mssql_db_status_1d

opsb_mssql_db_size opsb_mssql_db_size_1h opsb_mssql_db_size_1d

Management Pack for PostgreSQL


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_postgres_db_conn_status opsb_postgres_db_conn_status_1h opsb_postgres_db_conn_status_1d


Not available
opsb_postgres_db_stat opsb_postgres_db_stat_1h opsb_postgres_db_stat_1d

Management Pack for Oracle Database


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_ora_dataguard_status opsb_ora_dataguard_status_1h opsb_ora_dataguard_status_1d

opsb_ora_db_space_util opsb_ora_db_space_util_1h opsb_ora_db_space_util_1d

opsb_ora_instance_status opsb_ora_instance_status_1h opsb_ora_instance_status_1d

opsb_ora_io_perf opsb_ora_io_perf_1h opsb_ora_io_perf_1d

opsb_ora_perf opsb_ora_perf_1h opsb_ora_perf_1d

opsb_ora_query_perf opsb_ora_query_perf_1h opsb_ora_query_perf_1d Not available

opsb_ora_replication_metrics opsb_ora_replication_metrics_1h opsb_ora_replication_metrics_1d

opsb_ora_segment_space_util opsb_ora_segment_space_util_1h opsb_ora_segment_space_util_1d

opsb_ora_storage_metrics opsb_ora_storage_metrics_1h opsb_ora_storage_metrics_1d

opsb_ora_tablespace_metrics opsb_ora_tablespace_metrics_1h opsb_ora_tablespace_metrics_1d

opsb_ora_users_sessions opsb_ora_users_sessions_1h opsb_ora_users_sessions_1d

Management Pack for Oracle Weblogic


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_weblogic_cluster opsb_weblogic_cluster_1h opsb_weblogic_cluster_1d

opsb_weblogic_ejb_cache opsb_weblogic_ejb_cache_1h opsb_weblogic_ejb_cache_1d

opsb_weblogic_ejb_pool opsb_weblogic_ejb_pool_1h opsb_weblogic_ejb_pool_1d

opsb_weblogic_ejb_transaction opsb_weblogic_ejb_transaction_1h opsb_weblogic_ejb_transaction_1d

opsb_weblogic_gridlink opsb_weblogic_gridlink_1h opsb_weblogic_gridlink_1d

opsb_weblogic_jca_conn_pool opsb_weblogic_jca_conn_pool_1h opsb_weblogic_jca_conn_pool_1d

opsb_weblogic_jdbc opsb_weblogic_jdbc_1h opsb_weblogic_jdbc_1d

opsb_weblogic_jdk_gc opsb_weblogic_jdk_gc_1h opsb_weblogic_jdk_gc_1d

opsb_weblogic_jdk_total_gc opsb_weblogic_jdk_total_gc_1h opsb_weblogic_jdk_total_gc_1d

opsb_weblogic_jms opsb_weblogic_jms_1h opsb_weblogic_jms_1d

opsb_weblogic_jms_module_state opsb_weblogic_jms_module_state_1h opsb_weblogic_jms_module_state_1d

opsb_weblogic_jms_processed_msg opsb_weblogic_jms_processed_msg_1h opsb_weblogic_jms_processed_msg_1d

opsb_weblogic_jms_util opsb_weblogic_jms_util_1h opsb_weblogic_jms_util_1d


Not available

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

opsb_weblogic_jvm opsb_weblogic_jvm_1h opsb_weblogic_jvm_1d

opsb_weblogic_maxthreadsconst opsb_weblogic_maxthreadsconst_1h opsb_weblogic_maxthreadsconst_1d

opsb_weblogic_minthreadsconst opsb_weblogic_minthreadsconst_1h opsb_weblogic_minthreadsconst_1d

opsb_weblogic_security opsb_weblogic_security_1h opsb_weblogic_security_1d

opsb_weblogic_server_status opsb_weblogic_server_status_1h opsb_weblogic_server_status_1d

opsb_weblogic_servlet_session opsb_weblogic_servlet_session_1h opsb_weblogic_servlet_session_1d

opsb_weblogic_servlets opsb_weblogic_servlets_1h opsb_weblogic_servlets_1d

opsb_weblogic_threadpool opsb_weblogic_threadpool_1h opsb_weblogic_threadpool_1d

opsb_weblogic_transaction opsb_weblogic_transaction_1h opsb_weblogic_transaction_1d

opsb_weblogic_xml_cache opsb_weblogic_xml_cache_1h opsb_weblogic_xml_cache_1d

opsb_weblogic_cluster_status Not available

opsb_weblogic_gridlink_state Not available

Management Pack for SAP


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_sap_app_thread opsb_sap_app_thread_1h opsb_sap_app_thread_1d

opsb_sap_buffer_perf opsb_sap_buffer_perf_1h opsb_sap_buffer_perf_1d

opsb_sap_config_mgr_cls_loader opsb_sap_config_mgr_cls_loader_1h opsb_sap_config_mgr_cls_loader_1d

opsb_sap_connection_status opsb_sap_connection_status_1h opsb_sap_connection_status_1d

opsb_sap_db_info_perf opsb_sap_db_info_perf_1h opsb_sap_db_info_perf_1d

opsb_sap_doc_status_perf opsb_sap_doc_status_perf_1h opsb_sap_doc_status_perf_1d

opsb_sap_ep_perf opsb_sap_ep_perf_1h opsb_sap_ep_perf_1d

opsb_sap_http_provider opsb_sap_http_provider_1h opsb_sap_http_provider_1d

opsb_sap_icm_perf opsb_sap_icm_perf_1h opsb_sap_icm_perf_1d

opsb_sap_icm_status opsb_sap_icm_status_1h opsb_sap_icm_status_1d

opsb_sap_jms_perf opsb_sap_jms_perf_1h opsb_sap_jms_perf_1d

opsb_sap_jmx_adapter opsb_sap_jmx_adapter_1h opsb_sap_jmx_adapter_1d

opsb_sap_jndi_registry opsb_sap_jndi_registry_1h opsb_sap_jndi_registry_1d

opsb_sap_job_repository_perf opsb_sap_job_repository_perf_1h opsb_sap_job_repository_perf_1d

opsb_sap_log_config opsb_sap_log_config_1h opsb_sap_log_config_1d

opsb_sap_memory opsb_sap_memory_1h opsb_sap_memory_1d


Not available
opsb_sap_memory_perf opsb_sap_memory_perf_1h opsb_sap_memory_perf_1d

opsb_sap_message_server opsb_sap_message_server_1h opsb_sap_message_server_1d

opsb_sap_p4_and_iiop_provider opsb_sap_p4_and_iiop_provider_1h opsb_sap_p4_and_iiop_provider_1d

opsb_sap_session_manager opsb_sap_session_manager_1h opsb_sap_session_manager_1d

opsb_sap_spool_perf opsb_sap_spool_perf_1h opsb_sap_spool_perf_1d

opsb_sap_stat_record_perf opsb_sap_stat_record_perf_1h opsb_sap_stat_record_perf_1d

opsb_sap_system_thread opsb_sap_system_thread_1h opsb_sap_system_thread_1d

opsb_sap_system_up_perf opsb_sap_system_up_perf_1h opsb_sap_system_up_perf_1d

opsb_sap_transaction_status opsb_sap_transaction_status_1h opsb_sap_transaction_status_1d

opsb_sap_update_perf opsb_sap_update_perf_1h opsb_sap_update_perf_1d

opsb_sap_user_perf opsb_sap_user_perf_1h opsb_sap_user_perf_1d

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

opsb_sap_web_container opsb_sap_web_container_1h opsb_sap_web_container_1d

opsb_sap_work_process_perf opsb_sap_work_process_perf_1h opsb_sap_work_process_perf_1d

opsb_sap_workload_sum_perf opsb_sap_workload_sum_perf_1h opsb_sap_workload_sum_perf_1d

Management Pack for SAP HANA


Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_hana_column_partition opsb_hana_column_partition_1h opsb_hana_column_partition_1d

opsb_hana_current_mem_usg_rate opsb_hana_current_mem_usg_rate_1h opsb_hana_current_mem_usg_rate_1d

opsb_hana_data_backup_page opsb_hana_data_backup_page_1h opsb_hana_data_backup_page_1d

opsb_hana_db_allocation opsb_hana_db_allocation_1h opsb_hana_db_allocation_1d

opsb_hana_db_connection_status opsb_hana_db_connection_status_1h opsb_hana_db_connection_status_1d

opsb_hana_db_resource_usage opsb_hana_db_resource_usage_1h opsb_hana_db_resource_usage_1d

opsb_hana_db_transactions opsb_hana_db_transactions_1h opsb_hana_db_transactions_1d

opsb_hana_delta_storage_memory opsb_hana_delta_storage_memory_1h opsb_hana_delta_storage_memory_1d

opsb_hana_disk_usage opsb_hana_disk_usage_1h opsb_hana_disk_usage_1d

opsb_hana_execution_count opsb_hana_execution_count_1h opsb_hana_execution_count_1d Not available

opsb_hana_heap_memory opsb_hana_heap_memory_1h opsb_hana_heap_memory_1d

opsb_hana_license_usage opsb_hana_license_usage_1h opsb_hana_license_usage_1d

opsb_hana_log_backup_status opsb_hana_log_backup_status_1h opsb_hana_log_backup_status_1d

opsb_hana_replication_status opsb_hana_replication_status_1h opsb_hana_replication_status_1d

opsb_hana_service_cpu_usage opsb_hana_service_cpu_usage_1h opsb_hana_service_cpu_usage_1d

opsb_hana_service_status opsb_hana_service_status_1h opsb_hana_service_status_1d

opsb_hana_shared_memory opsb_hana_shared_memory_1h opsb_hana_shared_memory_1d

opsb_hana_system_statistics opsb_hana_system_statistics_1h opsb_hana_system_statistics_1d

opsb_hana_table_record opsb_hana_table_record_1h opsb_hana_table_record_1d

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

1.4.2.1. Management Pack for IBM WebSphere


Application Server
This section provides you information about the Management Pack for IBM WebSphere Application Server:

Forecast
Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily)
Tables

opsb_websphere_ejb opsb_websphere_ejb_1h opsb_websphere_ejb_1d

opsb_websphere_ejb_descriptor opsb_websphere_ejb_descriptor_1h opsb_websphere_ejb_descriptor_1d

opsb_websphere_jdbc opsb_websphere_jdbc_1h opsb_websphere_jdbc_1d

opsb_websphere_jdbc_descriptor opsb_websphere_jdbc_descriptor_1h opsb_websphere_jdbc_descriptor_1d

opsb_websphere_jvm_perf opsb_websphere_jvm_perf_1h opsb_websphere_jvm_perf_1d

opsb_websphere_server_status opsb_websphere_server_status_1h opsb_websphere_server_status_1d Not


available
opsb_websphere_servlet opsb_websphere_servlet_1h opsb_websphere_servlet_1d

opsb_websphere_servlet_session_module opsb_websphere_servlet_session_module_1h opsb_websphere_servlet_session_module_1d

opsb_websphere_thread opsb_websphere_thread_1h opsb_websphere_thread_1d

opsb_websphere_thread_descriptor opsb_websphere_thread_descriptor_1h opsb_websphere_thread_descriptor_1d

opsb_websphere_transact opsb_websphere_transact_1h opsb_websphere_transact_1d

opsb_websphere_webapp opsb_websphere_webapp_1h opsb_websphere_webapp_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

APPINSTANCE websphere_ejb_app_instance string 255 Instance of the Application

SERVERINST websphere_srv_instance string 255 Instance of the server

PORT port string 255 Port Number

SRVRNAME srv_name string 255 Server name

DMNNAME domain_name string 255 Domain Manager Name

APPNAME ejb_app_name string 255 Application name

EJBNAME ejb_name string 255 EJB name

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

EJBMETHRESPTIME ejb_avg_resp_time_ms double 48 Average EJB response time in milliseconds

EJBMETHCALLSRTAPP ejb_method_calls_app_count_per_min double 48 Number of EJB method calls per minute for an application

EJBPOOLSIZE ejb_avg_pool_size_count double 48 Average size of the EJB pool

Number of times an EJB was written to or loaded from the


EJBENTDATLDSTRTAPP ejb_txn_app_count_per_min double 48
database per minute for an application

Average percentage of time a call to retrieve an EJB from the


EJBPOOLMISSPCTAPP ejb_avg_pool_miss_app_pct double 48
pool failed for each 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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

port string 255 lastval Port Number

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

ejb_app_name string 255 lastval Application name

ejb_name string 255 lastval EJB name

The Average percentage of active beans in


ejb_pool_active_beans_app_avg_pct double 48 average
the pool for an application

The Minimum percentage of active beans


ejb_pool_active_beans_app_min_pct double 48 min
in the pool for an application

The Maximum percentage of active beans


ejb_pool_active_beans_app_max_pct double 48 max
in the pool for an application

The Percentile of the percentage of active


ejb_pool_active_beans_app_pctl_pct double 48 90 percentile
beans in the pool for an application

Average number of EJB Concurrent Lives


ejb_avg_concurr_lives_app_count double 48 lastval
for an application

The Average number of EJB Concurrent


ejb_avg_concurr_lives_app_avg_count double 48 average
Lives for an application

The Minimum average number of EJB


ejb_avg_concurr_lives_app_min_count double 48 min
Concurrent Lives for an application

The Maximum average number of EJB


ejb_avg_concurr_lives_app_max_count double 48 max
Concurrent Lives for an application

The Average EJB response time in


ejb_avg_resp_time_avg_ms double 48 average
milliseconds

The Minimum average EJB response time


ejb_avg_resp_time_min_ms double 48 min
in milliseconds

The Maximum average EJB response time


ejb_avg_resp_time_max_ms double 48 max
in milliseconds

The Average number of EJB method calls


ejb_method_calls_app_avg_count_per_min double 48 average
per minute for an application

The Minimum number of EJB method calls


ejb_method_calls_app_min_count_per_min double 48 min
per minute for an application

The Maximum number of EJB method calls


ejb_method_calls_app_max_count_per_min double 48 max
per minute for an application

ejb_avg_pool_size_count double 48 lastval Average size of the EJB pool

ejb_avg_pool_size_avg_count double 48 average The Average size of the EJB pool

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

The Average number of times an EJB was


ejb_txn_app_avg_count_per_min double 48 average written to or loaded from the database per
minute for an application

The Minimum number of times an EJB was


ejb_txn_app_min_count_per_min double 48 min written to or loaded from the database per
minute for an application

The Maximum number of times an EJB was


ejb_txn_app_max_count_per_min double 48 max written to or loaded from the database per
minute for an application

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

The Average percentage of time a call to


ejb_avg_pool_miss_app_avg_pct double 48 average retrieve an EJB from the pool failed for
each application

The Minimum average percentage of time


ejb_avg_pool_miss_app_min_pct double 48 min a call to retrieve an EJB from the pool
failed for each application

The Maximum average percentage of time


ejb_avg_pool_miss_app_max_pct double 48 max a call to retrieve an EJB from the pool
failed for each application

The Percentile of the average percentage


ejb_avg_pool_miss_app_pctl_pct double 48 90 percentile of time a call to retrieve an EJB from the
pool failed for each application

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval
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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For 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 497
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
Type

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to 255
which the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to apply
tenant_id tenant_id string 255
row level access policies to control access
to data.

The start time of the aggregation period in


timestamp_utc_s timestamp_utc_s integer 24
UNIX epoch format in seconds

websphere_ejb_app_instance websphere_ejb_app_instance string Instance of the Application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in


timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to
__count__ integer
build this particular record in the
aggregate destination table.

This field gives the timezone aware


timestamp at which this particular record
__update_time__ timestamp_tz in the aggregate destination table got last
updated by aggregation. The timestamp
will be in the Vertica server timezone.

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

port string 255 lastval Port Number

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

ejb_app_name string 255 lastval Application name

ejb_name string 255 lastval EJB name

The Average percentage of active beans in


ejb_pool_active_beans_app_avg_pct double 48 average
the pool for an application

The Minimum percentage of active beans


ejb_pool_active_beans_app_min_pct double 48 min
in the pool for an application

The Maximum percentage of active beans


ejb_pool_active_beans_app_max_pct double 48 max
in the pool for an application

The Percentile of the percentage of active


ejb_pool_active_beans_app_pctl_pct double 48 90 percentile
beans in the pool for an application

Average number of EJB Concurrent Lives


ejb_avg_concurr_lives_app_count double 48 lastval
for an application

The Average number of EJB Concurrent


ejb_avg_concurr_lives_app_avg_count double 48 average
Lives for an application

The Minimum average number of EJB


ejb_avg_concurr_lives_app_min_count double 48 min
Concurrent Lives for an application

The Maximum average number of EJB


ejb_avg_concurr_lives_app_max_count double 48 max
Concurrent Lives for an application

The Average EJB response time in


ejb_avg_resp_time_avg_ms double 48 average
milliseconds

The Minimum average EJB response time


ejb_avg_resp_time_min_ms double 48 min
in milliseconds

The Maximum average EJB response time


ejb_avg_resp_time_max_ms double 48 max
in milliseconds

The Average number of EJB method calls


ejb_method_calls_app_avg_count_per_min double 48 average
per minute for an application

The Minimum number of EJB method calls


ejb_method_calls_app_min_count_per_min double 48 min
per minute for an application

The Maximum number of EJB method calls


ejb_method_calls_app_max_count_per_min double 48 max
per minute for an application

ejb_avg_pool_size_count double 48 lastval Average size of the EJB pool

ejb_avg_pool_size_avg_count double 48 average The Average size of the EJB pool

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

The Average number of times an EJB was


ejb_txn_app_avg_count_per_min double 48 average written to or loaded from the database per
minute for an application

The Minimum number of times an EJB was


ejb_txn_app_min_count_per_min double 48 min written to or loaded from the database per
minute for an application

The Maximum number of times an EJB was


ejb_txn_app_max_count_per_min double 48 max written to or loaded from the database per
minute for an application

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

The Average percentage of time a call to


ejb_avg_pool_miss_app_avg_pct double 48 average retrieve an EJB from the pool failed for
each application

The Minimum average percentage of time


ejb_avg_pool_miss_app_min_pct double 48 min a call to retrieve an EJB from the pool
failed for each application

The Maximum average percentage of time


ejb_avg_pool_miss_app_max_pct double 48 max a call to retrieve an EJB from the pool
failed for each application

The Percentile of the average percentage


ejb_avg_pool_miss_app_pctl_pct double 48 90 percentile of time a call to retrieve an EJB from the
pool failed for each application

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval
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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For 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 500
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
Type

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to 255
which the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to apply
tenant_id tenant_id string 255
row level access policies to control access
to data.

The start time of the aggregation period in


timestamp_utc_s timestamp_utc_s integer 24
UNIX epoch format in seconds

websphere_ejb_app_instance websphere_ejb_app_instance string Instance of the Application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in


timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to
__count__ integer
build this particular record in the
aggregate destination table.

This field gives the timezone aware


timestamp at which this particular record
__update_time__ timestamp_tz in the aggregate destination table got last
updated by aggregation. The timestamp
will be in the Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

APPINSTANCE websphere_ejb_app_instance string 255 Instance of the cluster

SERVERINST websphere_srv_instance string 255 Instance of the server

PORT port string 255 Port

SRVRNAME srv_name string 255 Server name

DMNNAME domain_name string 255 Domain Manager Name

APPNAME ejb_app_name string 255 Application name

EJBPOOLUTIL ejb_pool_active_beans_pct double 48 Percentage of active beans in the pool

EJBCONCLIVES ejb_avg_concurr_lives_count double 48 Average number of EJB Concurrent Lives

EJBMETHCALLSRT ejb_method_calls_count_per_min double 48 Number of EJB method calls per minute

Number of times an EJB was written to or loaded from the


EJBENTDATLDSTRT ejb_txn_count_per_min double 48
database per minute

Average percentage of time a call to retrieve an EJB from the


EJBPOOLMISSPCT ejb_avg_pool_miss_pct double 48
pool failed

The rate at which the messages failed to be delivered to the


EJBMSGBACKOUTRATE ejb_msg_backout_count_per_s double 48
MessageDrivenBeans on message method.

The rate at which the returning object was discarded because


EJBRETURNDISCRDRT ejb_return_obj_discarded_count_per_s double 48
the (entity and stateless EJB) pool was full.

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

ejb_app_name string 255 lastval Application name

The Average percentage of active beans


ejb_pool_active_beans_avg_pct double 48 average
in the pool

The Minimum percentage of active beans


ejb_pool_active_beans_min_pct double 48 min
in the pool

The Maximum percentage of active beans


ejb_pool_active_beans_max_pct double 48 max
in the pool

The Percentile of the percentage of active


ejb_pool_active_beans_pctl_pct double 48 90 percentile
beans in the pool

ejb_avg_concurr_lives_count double 48 lastval Average number of EJB Concurrent Lives

The Average number of EJB Concurrent


ejb_avg_concurr_lives_avg_count double 48 average
Lives

The Minimum average number of EJB


ejb_avg_concurr_lives_min_count double 48 min
Concurrent Lives

The Maximum average number of EJB


ejb_avg_concurr_lives_max_count double 48 max
Concurrent Lives

The Average number of EJB method calls


ejb_method_calls_avg_count_per_min double 48 average
per minute

The Minimum number of EJB method calls


ejb_method_calls_min_count_per_min double 48 min
per minute

The Maximum number of EJB method calls


ejb_method_calls_max_count_per_min double 48 max
per minute

The Average number of times an EJB was


ejb_txn_avg_count_per_min double 48 average written to or loaded from the database per
minute

The Minimum number of times an EJB was


ejb_txn_min_count_per_min double 48 min written to or loaded from the database per
minute

The Maximum number of times an EJB


ejb_txn_max_count_per_min double 48 max was written to or loaded from the
database per minute

The Average percentage of time a call to


ejb_avg_pool_miss_avg_pct double 48 average
retrieve an EJB from the pool failed

The Minimum Average percentage of


ejb_avg_pool_miss_min_pct double 48 min time a call to retrieve an EJB from the pool
failed

The Maximum Average percentage of


ejb_avg_pool_miss_max_pct double 48 max time a call to retrieve an EJB from the pool
failed

The Percentile of the average percentage


ejb_avg_pool_miss_pctl_pct double 48 90 percentile of time a call to retrieve an EJB from the
pool failed

The Average rate at which the messages


failed to be delivered to the
ejb_msg_backout_avg_count_per_s double 48 average
MessageDrivenBeans on message
method.

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

The Minimum rate at which the messages


failed to be delivered to the
ejb_msg_backout_min_count_per_s double 48 min
MessageDrivenBeans on message
method.

The Maximum rate at which the messages


failed to be delivered to the
ejb_msg_backout_max_count_per_s double 48 max
MessageDrivenBeans on message
method.

The Average rate at which the returning


ejb_return_obj_discarded_avg_count_per_s double 48 average object was discarded because the (entity
and stateless EJB) pool was full.

The Minimum rate at which the returning


ejb_return_obj_discarded_min_count_per_s double 48 min object was discarded because the (entity
and stateless EJB) pool was full.

The Maximum rate at which the returning


ejb_return_obj_discarded_max_count_per_s double 48 max object was discarded because the (entity
and stateless EJB) pool was full.

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval
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
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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

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

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example: +1,
+4.5, -8

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to 255
which the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to
tenant_id tenant_id string 255
apply row level access policies to control
access to data.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_ejb_app_instance websphere_ejb_app_instance string Instance of the cluster 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to
__count__ integer
build this particular record in the
aggregate destination table.

This field gives the timezone aware


timestamp at which this particular record
__update_time__ timestamp_tz in the aggregate destination table got last
updated by aggregation. The timestamp
will be in the Vertica server timezone.

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

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

ejb_app_name string 255 lastval Application name

The Average percentage of active beans


ejb_pool_active_beans_avg_pct double 48 average
in the pool

The Minimum percentage of active beans


ejb_pool_active_beans_min_pct double 48 min
in the pool

The Maximum percentage of active beans


ejb_pool_active_beans_max_pct double 48 max
in the pool

The Percentile of the percentage of active


ejb_pool_active_beans_pctl_pct double 48 90 percentile
beans in the pool

ejb_avg_concurr_lives_count double 48 lastval Average number of EJB Concurrent Lives

The Average number of EJB Concurrent


ejb_avg_concurr_lives_avg_count double 48 average
Lives

The Minimum average number of EJB


ejb_avg_concurr_lives_min_count double 48 min
Concurrent Lives

The Maximum average number of EJB


ejb_avg_concurr_lives_max_count double 48 max
Concurrent Lives

The Average number of EJB method calls


ejb_method_calls_avg_count_per_min double 48 average
per minute

The Minimum number of EJB method calls


ejb_method_calls_min_count_per_min double 48 min
per minute

The Maximum number of EJB method calls


ejb_method_calls_max_count_per_min double 48 max
per minute

The Average number of times an EJB was


ejb_txn_avg_count_per_min double 48 average written to or loaded from the database per
minute

The Minimum number of times an EJB was


ejb_txn_min_count_per_min double 48 min written to or loaded from the database per
minute

The Maximum number of times an EJB


ejb_txn_max_count_per_min double 48 max was written to or loaded from the
database per minute

The Average percentage of time a call to


ejb_avg_pool_miss_avg_pct double 48 average
retrieve an EJB from the pool failed

The Minimum Average percentage of


ejb_avg_pool_miss_min_pct double 48 min time a call to retrieve an EJB from the pool
failed

The Maximum Average percentage of


ejb_avg_pool_miss_max_pct double 48 max time a call to retrieve an EJB from the pool
failed

The Percentile of the Average percentage


ejb_avg_pool_miss_pctl_pct double 48 90 percentile of time a call to retrieve an EJB from the
pool failed

The Average rate at which the messages


failed to be delivered to the
ejb_msg_backout_avg_count_per_s double 48 average
MessageDrivenBeans on message
method.

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

The Minimum rate at which the messages


failed to be delivered to the
ejb_msg_backout_min_count_per_s double 48 min
MessageDrivenBeans on message
method.

The Maximum rate at which the messages


failed to be delivered to the
ejb_msg_backout_max_count_per_s double 48 max
MessageDrivenBeans on message
method.

The Average rate at which the returning


ejb_return_obj_discarded_avg_count_per_s double 48 average object was discarded because the (entity
and stateless EJB) pool was full.

The Minimum rate at which the returning


ejb_return_obj_discarded_min_count_per_s double 48 min object was discarded because the (entity
and stateless EJB) pool was full.

The Maximum rate at which the returning


ejb_return_obj_discarded_max_count_per_s double 48 max object was discarded because the (entity
and stateless EJB) pool was full.

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval
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
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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

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

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example: +1,
+4.5, -8

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to 255
which the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to
tenant_id tenant_id string 255
apply row level access policies to control
access to data.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_ejb_app_instance websphere_ejb_app_instance string Instance of the cluster 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to
__count__ integer
build this particular record in the
aggregate destination table.

This field gives the timezone aware


timestamp at which this particular record
__update_time__ timestamp_tz in the aggregate destination table got last
updated by aggregation. The timestamp
will be in the Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

JDBCINSTANCE websphere_jdbc_instance string 255 Instance of JDBC

SERVERINST websphere_srv_instance string 255 Instance of the server

JDBCNAME jdbc_name string 255 JDBC name

PORT port string 255 Port

SRVRNAME srv_name string 255 Server name

DMNNAME domain_name string 255 Domain Manager Name

Average number of JDBC connections in the connection


JDBCCONNPOOLSIZE jdbc_avg_conn_pool_size_count double 48
pool.

Average number of threads waiting for a JDBC


JDBCCONNPOOLWAITERS jdbc_avg_conn_pool_waiters_app_count double 48
connection from connection pools for an application

Average time that a client waited for a JDBC connection


JDBCCONPOOLWAITTIME jdbc_avg_conn_pool_wait_time_app_ms double 48
in milliseconds for an application

JDBCCONNPOOLUTIL jdbc_conn_pool_use_pct double 48 Percentage of JDBC connection pool in use.

Percentage of time that all JDBC connections in a pool


JDBCCONNPOOLMAXPCT jdbc_conn_pool_all_use_pct double 48
are in use.

Number of times a client timed out waiting for a JDBC


JDBCCONPOOLTMEOUTRT jdbc_conn_pool_timeout_app_count_per_min double 48
connection from the pool for an application per minute.

Number of JDBC connections allocated and returned by


JDBCCONPOOLTHRUPUT jdbc_conn_pool_throughput_app_count_per_s double 48
applications per second for an application.

The rate at which the prepared statements are discarded


JDBCPREPREDSTDISCRT jdbc_prepared_stmt_discarded_count_per_s double 48 by the least recently used (LRU) algorithm of the
statement cache

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in


timestamp_utc_collector timestamp_utc_collector_s integer 24
unix epoch

Source of the Metric Collection that produced this data


collection_source collection_source string 255 row. It can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id producer_instance_id string 255
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id cmdb_id uuid should be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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.
collection_data_flow collection_data_flow string 80 Pull:Data producer provides data through an API 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 510
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

Name of the policy that produced this data row. It can be


the name of an Agent streaming policy or a remote
CollectionConfigName collection_policy_name string 255 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: "SiteScope
collection_type collection_type string 255 Streaming", "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM Engine", "OBM
Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being


MonitoredSystem node_fqdn string 255
monitored. That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must


MonitoredSystemID node_short_name string 255
not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

jdbc_name string 255 lastval JDBC name

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

Average number of JDBC connections


jdbc_avg_conn_pool_size_count double 48 lastval
in the connection pool.

The Average number of JDBC


jdbc_avg_conn_pool_size_avg_count double 48 average
connections in the connection pool.

The Minimum average number of JDBC


jdbc_avg_conn_pool_size_min_count double 48 min
connections in the connection pool.

The Maximum average number of


jdbc_avg_conn_pool_size_max_count double 48 max JDBC connections in the connection
pool.

Average number of threads waiting for


jdbc_avg_conn_pool_waiters_app_count double 48 lastval a JDBC connection from connection
pools for an application

The Average number of threads


jdbc_avg_conn_pool_waiters_app_avg_count double 48 average waiting for a JDBC connection from
connection pools for an application

The Minimum average number of


threads waiting for a JDBC connection
jdbc_avg_conn_pool_waiters_app_min_count double 48 min
from connection pools for an
application

The Maximum average number of


threads waiting for a JDBC connection
jdbc_avg_conn_pool_waiters_app_max_count double 48 max
from connection pools for an
application

The Average time that a client waited


jdbc_avg_conn_pool_wait_time_app_avg_ms double 48 average for a JDBC connection in milliseconds
for an application

The Minimum average time that a


jdbc_avg_conn_pool_wait_time_app_min_ms double 48 min client waited for a JDBC connection in
milliseconds for an application

The Maximum average time that a


jdbc_avg_conn_pool_wait_time_app_max_ms double 48 max client waited for a JDBC connection in
milliseconds for an application

The Average percentage of JDBC


jdbc_conn_pool_use_avg_pct double 48 average
connection pool in use.

The Minimum percentage of JDBC


jdbc_conn_pool_use_min_pct double 48 min
connection pool in use.

The Maximum percentage of JDBC


jdbc_conn_pool_use_max_pct double 48 max
connection pool in use.

The Percentile of the percentage of


jdbc_conn_pool_use_pctl_pct double 48 90 percentile
JDBC connection pool in use.

The Average percentage of time that


jdbc_conn_pool_all_use_avg_pct double 48 average all JDBC connections in a pool are in
use.

The Minimum percentage of time that


jdbc_conn_pool_all_use_min_pct double 48 min all JDBC connections in a pool are in
use.

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

The Maximum percentage of time that


jdbc_conn_pool_all_use_max_pct double 48 max all JDBC connections in a pool are in
use.

The Percentile of the percentage of


jdbc_conn_pool_all_use_pctl_pct double 48 90 percentile time that all JDBC connections in a
pool are in use.

The Average number of times a client


timed out waiting for a JDBC
jdbc_conn_pool_timeout_app_avg_count_per_min double 48 average
connection from the pool for an
application per minute.

The Minimum number of times a client


timed out waiting for a JDBC
jdbc_conn_pool_timeout_app_min_count_per_min double 48 min
connection from the pool for an
application per minute.

The Maximum number of times a


client timed out waiting for a JDBC
jdbc_conn_pool_timeout_app_max_count_per_min double 48 max
connection from the pool for an
application per minute.

The Average number of JDBC


connections allocated and returned by
jdbc_conn_pool_throughput_app_avg_count_per_s double 48 average
applications per second for an
application.

The Minimum number of JDBC


connections allocated and returned by
jdbc_conn_pool_throughput_app_min_count_per_s double 48 min
applications per second for an
application.

The Maximum number of JDBC


connections allocated and returned by
jdbc_conn_pool_throughput_app_max_count_per_s double 48 max
applications per second for an
application.

The Average rate at which the


prepared statements are discarded by
jdbc_prepared_stmt_discarded_avg_count_per_s double 48 average
the least recently used (LRU) algorithm
of the statement cache

The Minimum rate at which the


prepared statements are discarded by
jdbc_prepared_stmt_discarded_min_count_per_s double 48 min
the least recently used (LRU) algorithm
of the statement cache

The Maximum rate at which the


prepared statements are discarded by
jdbc_prepared_stmt_discarded_max_count_per_s double 48 max
the least recently used (LRU) algorithm
of the statement cache

Indicates the type of the data producer


producer_instance_type string 50 lastval that ingested the data. E.g UCMDB,
NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
type

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

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

Values are Push or Pull. Push:Data


producer (producer instance id)
actively pushes data directly to COSO.
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_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
monitored if using IPV4.

The IP address of the monitored


server. Encoded as IPv6 format. Fully
node_ipv6_address string 50 lastval
specified ipv6 format without any
simplification rules.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any
'.' (Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example:
+1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to which the data belongs

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.

The start time of the aggregation


timestamp_utc_s timestamp_utc_s integer period in UNIX epoch format in 24
seconds

websphere_jdbc_instance websphere_jdbc_instance string Instance of JDBC 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation


period in timestamp format.
timestamp_tz timestamp 26 average Aggregation is performed based on
Vertica timezone, so this value will be
in Vertica timezone

This field gives the number of source


table records considered for
__count__ integer aggregation to build this particular
record in the aggregate destination
table.

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 field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by aggregation.
The timestamp will be in the Vertica
server timezone.

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

jdbc_name string 255 lastval JDBC name

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

Average number of JDBC connections


jdbc_avg_conn_pool_size_count double 48 lastval
in the connection pool.

The Average number of JDBC


jdbc_avg_conn_pool_size_avg_count double 48 average
connections in the connection pool.

The Minimum average number of JDBC


jdbc_avg_conn_pool_size_min_count double 48 min
connections in the connection pool.

The Maximum average number of


jdbc_avg_conn_pool_size_max_count double 48 max JDBC connections in the connection
pool.

Average number of threads waiting for


jdbc_avg_conn_pool_waiters_app_count double 48 lastval a JDBC connection from connection
pools for an application

The Average number of threads


jdbc_avg_conn_pool_waiters_app_avg_count double 48 average waiting for a JDBC connection from
connection pools for an application

The Minimum average number of


threads waiting for a JDBC connection
jdbc_avg_conn_pool_waiters_app_min_count double 48 min
from connection pools for an
application

The Maximum average number of


threads waiting for a JDBC connection
jdbc_avg_conn_pool_waiters_app_max_count double 48 max
from connection pools for an
application

The Average time that a client waited


jdbc_avg_conn_pool_wait_time_app_avg_ms double 48 average for a JDBC connection in milliseconds
for an application

The Minimum average time that a


jdbc_avg_conn_pool_wait_time_app_min_ms double 48 min client waited for a JDBC connection in
milliseconds for an application

The Maximum average time that a


jdbc_avg_conn_pool_wait_time_app_max_ms double 48 max client waited for a JDBC connection in
milliseconds for an application

The Average percentage of JDBC


jdbc_conn_pool_use_avg_pct double 48 average
connection pool in use.

The Minimum percentage of JDBC


jdbc_conn_pool_use_min_pct double 48 min
connection pool in use.

The Maximum percentage of JDBC


jdbc_conn_pool_use_max_pct double 48 max
connection pool in use.

The Percentile of the percentage of


jdbc_conn_pool_use_pctl_pct double 48 90 percentile
JDBC connection pool in use.

The Average percentage of time that


jdbc_conn_pool_all_use_avg_pct double 48 average all JDBC connections in a pool are in
use.

The Minimum percentage of time that


jdbc_conn_pool_all_use_min_pct double 48 min all JDBC connections in a pool are in
use.

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

The Maximum percentage of time that


jdbc_conn_pool_all_use_max_pct double 48 max all JDBC connections in a pool are in
use.

The Percentile of the percentage of


jdbc_conn_pool_all_use_pctl_pct double 48 90 percentile time that all JDBC connections in a
pool are in use.

The Average number of times a client


timed out waiting for a JDBC
jdbc_conn_pool_timeout_app_avg_count_per_min double 48 average
connection from the pool for an
application per minute.

The Minimum number of times a client


timed out waiting for a JDBC
jdbc_conn_pool_timeout_app_min_count_per_min double 48 min
connection from the pool for an
application per minute.

The Maximum number of times a


client timed out waiting for a JDBC
jdbc_conn_pool_timeout_app_max_count_per_min double 48 max
connection from the pool for an
application per minute.

The Average number of JDBC


connections allocated and returned by
jdbc_conn_pool_throughput_app_avg_count_per_s double 48 average
applications per second for an
application.

The Minimum number of JDBC


connections allocated and returned by
jdbc_conn_pool_throughput_app_min_count_per_s double 48 min
applications per second for an
application.

The Maximum number of JDBC


connections allocated and returned by
jdbc_conn_pool_throughput_app_max_count_per_s double 48 max
applications per second for an
application.

The Average rate at which the


prepared statements are discarded by
jdbc_prepared_stmt_discarded_avg_count_per_s double 48 average
the least recently used (LRU) algorithm
of the statement cache

The Minimum rate at which the


prepared statements are discarded by
jdbc_prepared_stmt_discarded_min_count_per_s double 48 min
the least recently used (LRU) algorithm
of the statement cache

The Maximum rate at which the


prepared statements are discarded by
jdbc_prepared_stmt_discarded_max_count_per_s double 48 max
the least recently used (LRU) algorithm
of the statement cache

Indicates the type of the data producer


producer_instance_type string 50 lastval that ingested the data. E.g UCMDB,
NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
type

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

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

Values are Push or Pull. Push:Data


producer (producer instance id)
actively pushes data directly to COSO.
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_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
monitored if using IPV4.

The IP address of the monitored


server. Encoded as IPv6 format. Fully
node_ipv6_address string 50 lastval
specified ipv6 format without any
simplification rules.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any
'.' (Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example:
+1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to which the data belongs

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.

The start time of the aggregation


timestamp_utc_s timestamp_utc_s integer period in UNIX epoch format in 24
seconds

websphere_jdbc_instance websphere_jdbc_instance string Instance of JDBC 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation


period in timestamp format.
timestamp_tz timestamp 26 average Aggregation is performed based on
Vertica timezone, so this value will be
in Vertica timezone

This field gives the number of source


table records considered for
__count__ integer aggregation to build this particular
record in the aggregate destination
table.

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 field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by aggregation.
The timestamp will be in the Vertica
server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

JDBCINSTANCE websphere_jdbc_instance string 255 Instance of JDBC

SERVERINST websphere_srv_instance string 255 Instance of the server

JDBCNAME jdbc_name string 255 JDBC name

PORT port string 255 Port Number

SRVRNAME srv_name string 255 Server name

DMNNAME domain_name string 255 Domain Manager Name

Average number of threads waiting for a JDBC connection


JDBCCONPOOLWAIT jdbc_avg_conn_pool_threads_waiting_count double 48
from connection pools.

Number of times a client timed out waiting for a JDBC


JDBCCONPOOLTIMERT jdbc_conn_pool_time_out_count_per_min double 48
connection from the pool per minute.

Number of JDBC connections allocated and returned by


JDBCCONPOOLTHRU jdbc_conn_pool_throughput_count_per_s double 48
applications per second.

Average time that a client waited for a JDBC connection in


JDBCCONPOOLWTTIME jdbc_avg_conn_pool_wait_time_ms double 48
milliseconds.

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data


collection_source collection_source string 255 row. It can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id producer_instance_id string 255
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id cmdb_id uuid should be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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.
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "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 520
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The fully qualified hostname of the server being


MonitoredSystem node_fqdn string 255
monitored. That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

jdbc_name string 255 lastval JDBC name

port string 255 lastval Port Number

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

Average number of threads waiting for a


jdbc_avg_conn_pool_threads_waiting_count lastval
JDBC connection from connection pools.

The Average number of threads waiting


jdbc_avg_conn_pool_threads_waiting_avg_count average for a JDBC connection from connection
pools.

The Minimum average number of


jdbc_avg_conn_pool_threads_waiting_min_count min threads waiting for a JDBC connection
from connection pools.

The Maximum average number of


jdbc_avg_conn_pool_threads_waiting_max_count max threads waiting for a JDBC connection
from connection pools.

The Average number of times a client


jdbc_conn_pool_time_out_avg_count_per_min average timed out waiting for a JDBC connection
from the pool per minute.

The Minimum number of times a client


jdbc_conn_pool_time_out_min_count_per_min min timed out waiting for a JDBC connection
from the pool per minute.

The Maximum number of times a client


jdbc_conn_pool_time_out_max_count_per_min max timed out waiting for a JDBC connection
from the pool per minute.

The Average number of JDBC


jdbc_conn_pool_throughput_avg_count_per_s double 48 average connections allocated and returned by
applications per second.

The Minimum number of JDBC


jdbc_conn_pool_throughput_min_count_per_s double 48 min connections allocated and returned by
applications per second.

The Maximum number of JDBC


jdbc_conn_pool_throughput_max_count_per_s double 48 max connections allocated and returned by
applications per second.

The Average time that a client waited


jdbc_avg_conn_pool_wait_time_avg_ms average
for a JDBC connection in milliseconds.

The Minimum average time that a client


jdbc_avg_conn_pool_wait_time_min_ms min waited for a JDBC connection in
milliseconds.

The Maximum average time that a client


jdbc_avg_conn_pool_wait_time_max_ms max waited for a JDBC connection in
milliseconds.

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
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

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

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
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any
'.' (Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example:
+1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to which the data belongs

This field holds the tenant id to which


the row in dataset belongs to. Needed to
tenant_id tenant_id string 255
apply row level access policies to control
access to data.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_jdbc_instance websphere_jdbc_instance string Instance of JDBC 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone,
so this value will be in Vertica timezone

This field gives the number of source


table records considered for aggregation
__count__ integer
to build this particular record in the
aggregate destination table.

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 field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by aggregation.
The timestamp will be in the Vertica
server timezone.

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

jdbc_name string 255 lastval JDBC name

port string 255 lastval Port Number

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager Name

Average number of threads waiting for a


jdbc_avg_conn_pool_threads_waiting_count double 48 lastval
JDBC connection from connection pools.

The Average number of threads waiting


jdbc_avg_conn_pool_threads_waiting_avg_count double 48 average for a JDBC connection from connection
pools.

The Minimum average number of


jdbc_avg_conn_pool_threads_waiting_min_count double 48 min threads waiting for a JDBC connection
from connection pools.

The Maximum average number of


jdbc_avg_conn_pool_threads_waiting_max_count double 48 max threads waiting for a JDBC connection
from connection pools.

The Average number of times a client


jdbc_conn_pool_time_out_avg_count_per_min double 48 average timed out waiting for a JDBC connection
from the pool per minute.

The Minimum number of times a client


jdbc_conn_pool_time_out_min_count_per_min double 48 min timed out waiting for a JDBC connection
from the pool per minute.

The Maximum number of times a client


jdbc_conn_pool_time_out_max_count_per_min double 48 max timed out waiting for a JDBC connection
from the pool per minute.

The Average number of JDBC


jdbc_conn_pool_throughput_avg_count_per_s double 48 average connections allocated and returned by
applications per second.

The Minimum number of JDBC


jdbc_conn_pool_throughput_min_count_per_s double 48 min connections allocated and returned by
applications per second.

The Maximum number of JDBC


jdbc_conn_pool_throughput_max_count_per_s double 48 max connections allocated and returned by
applications per second.

The Average time that a client waited


jdbc_avg_conn_pool_wait_time_avg_ms double 48 average
for a JDBC connection in milliseconds.

The Minimum average time that a client


jdbc_avg_conn_pool_wait_time_min_ms double 48 min waited for a JDBC connection in
milliseconds.

The Maximum average time that a client


jdbc_avg_conn_pool_wait_time_max_ms double 48 max waited for a JDBC connection in
milliseconds.

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
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

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

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
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any
'.' (Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example:
+1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to which the data belongs

This field holds the tenant id to which


the row in dataset belongs to. Needed to
tenant_id tenant_id string 255
apply row level access policies to control
access to data.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_jdbc_instance websphere_jdbc_instance string Instance of JDBC 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone,
so this value will be in Vertica timezone

This field gives the number of source


table records considered for aggregation
__count__ integer
to build this particular record in the
aggregate destination table.

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 field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by aggregation.
The timestamp will be in the Vertica
server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

JVMINST websphere_jvm_instance string 255 Instance of JVM

SERVERINST websphere_srv_instance string 255 Instance of the server

SRVRNAME srv_name string 255 Server name

CPUUSAGEPERCT cpu_usage_pct integer 24 Percentage of process CPU usage

THREADSCOUNT threads_count integer 24 Count of threads

THREADSCOUNT_D threads_delta_count integer 24 Delta of threads count

GCCALLS gc_count integer 24 Garbage Collection Count

GCCALLS_D gc_delta_count integer 24 Delta of Garbage Collection Count

GCAVGCALLDUR gc_time_s double 48 Time taken for garbage collection in seconds.

GCAVGCALLDUR_D gc_delta_time_s double 48 Delta of Garbage Collection Time

UPTIME uptime_s double 48 JVM up time in seconds.

TTLHEAPSZ jvm_heap_size_kb double 48 JVM runtime total heap size in kilobytes.

USDHEAPSZ jvm_used_heap_size_kb double 48 Heap space used in the JVM in kilobytes.

USDHEAPSZ_P jvm_used_heap_size_pct double 48 Percentage of heap space used in the JVM in kilobytes.

FRHEAPSZ jvm_free_mem_available_kb double 48 JVM Free Memory available in kilobytes.

FRHEAPSZ_P jvm_free_mem_available_pct double 48 Percentage of JVM Free Memory available in kilobytes.

The average garbage collection value in seconds between two garbage


GCAVGCALLINTV gc_avg_interval_s double 48
collections.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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"

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

Metric Name/Global Data


Column Name Size Description
Name Type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval Server name

cpu_usage_avg_pct integer 24 average The Average percentage of process CPU usage

cpu_usage_min_pct integer 24 min The Minimum percentage of process CPU usage

cpu_usage_max_pct integer 24 max The Maximum percentage of process CPU usage

cpu_usage_pctl_pct integer 24 90 percentile The Percentile of the percentage of process CPU usage

threads_count integer 24 lastval Count of threads

threads_avg_count integer 24 average The Average count of threads

threads_min_count integer 24 min The Minimum count of threads

threads_max_count integer 24 max The Maximum count of threads

threads_delta_count integer 24 lastval Delta of threads count

threads_delta_avg_count integer 24 average The Average delta of threads count

threads_delta_min_count integer 24 min The Minimum delta of threads count

threads_delta_max_count integer 24 max The Maximum delta of threads count

gc_count integer 24 lastval Garbage Collection Count

gc_avg_count integer 24 average The Average garbage Collection Count

gc_min_count integer 24 min The Minimum garbage Collection Count

gc_max_count integer 24 max The Maximum garbage Collection Count

gc_delta_count integer 24 lastval Delta of Garbage Collection Count

gc_delta_avg_count integer 24 average The Average delta of Garbage Collection Count

gc_delta_min_count integer 24 min The Minimum delta of Garbage Collection Count

gc_delta_max_count integer 24 max The Maximum delta of Garbage Collection Count

The Average time taken for garbage collection in


gc_time_avg_s double 48 average
seconds.

The Minimum time taken for garbage collection in


gc_time_min_s double 48 min
seconds.

The Maximum time taken for garbage collection in


gc_time_max_s double 48 max
seconds.

gc_delta_time_avg_s double 48 average The Average delta of Garbage Collection Time

gc_delta_time_min_s double 48 min The Minimum delta of Garbage Collection Time

gc_delta_time_max_s double 48 max The Maximum delta of Garbage Collection Time

uptime_avg_s double 48 average The Average JVM up time in seconds.

uptime_min_s double 48 min The Minimum JVM up time in seconds.

uptime_max_s double 48 max The Maximum JVM up time in seconds.

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

The Average percentage of heap space used in the JVM


jvm_used_heap_size_pct_avg double 48 average
in kilobytes.

The Minimum percentage of heap space used in the


jvm_used_heap_size_pct_min double 48 min
JVM in kilobytes.

The Maximum percentage of heap space used in the


jvm_used_heap_size_pct_max double 48 max
JVM in kilobytes.

The Percentile of the percentage of heap space used in


jvm_used_heap_size_pct_pctl double 48 90 percentile
the JVM in kilobytes.

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.

The Average percentage of JVM Free Memory available


jvm_free_mem_available_pct_avg double 48 average
in kilobytes.

The Minimum percentage of JVM Free Memory available


jvm_free_mem_available_pct_min double 48 min
in kilobytes.

The Maximum percentage of JVM Free Memory


jvm_free_mem_available_pct_max double 48 max
available in kilobytes.

The Percentile of the percentage of JVM Free Memory


jvm_free_mem_available_pct_pctl double 48 90 percentile
available in kilobytes.

The Average garbage collection value in seconds


gc_avg_interval_avg_s double 48 average
between two garbage collections.

The Minimum average garbage collection value in


gc_avg_interval_min_s double 48 min
seconds between two garbage collections.

The Maximum average garbage collection value in


gc_avg_interval_max_s double 48 max
seconds between two garbage collections.

Indicates the type of the data producer that ingested


producer_instance_type string 50 lastval
the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id string 255 lastval
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id uuid lastval should be used 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]


cmdb_global_id uuid lastval should be used in 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.
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope
collection_type string 255 lastval Streaming", "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM Engine", "OBM
Server Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored if using


node_ipv4_address string 50 lastval
IPV4.

The IP address of the monitored server. Encoded as


node_ipv6_address string 50 lastval IPv6 format. Fully specified ipv6 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 531
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
Type

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must


node_short_name string 255 lastval
not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being


node_fqdn node_fqdn string 255
monitored. That is the server to which the data belongs

This field holds the tenant id to which the row in


tenant_id tenant_id string dataset belongs to. Needed to apply row level access 255
policies to control access to data.

The start time of the aggregation period in UNIX epoch


timestamp_utc_s timestamp_utc_s integer 24
format in seconds

websphere_jvm_instance websphere_jvm_instance string Instance of JVM 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in timestamp


timestamp_tz timestamp 26 average format. Aggregation is performed based on Vertica
timezone, so this value will be in Vertica timezone

This field gives the number of source table records


__count__ integer considered for aggregation to build this particular
record in the aggregate destination table.

This field gives the timezone aware timestamp at which


this particular record in the aggregate destination table
__update_time__ timestamp_tz
got last updated by aggregation. The timestamp will be
in the Vertica server timezone.

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

srv_name string 255 lastval Server name

cpu_usage_avg_pct integer 24 average The Average percentage of process CPU usage

cpu_usage_min_pct integer 24 min The Minimum percentage of process CPU usage

cpu_usage_max_pct integer 24 max The Maximum percentage of process CPU usage

cpu_usage_pctl_pct integer 24 90 percentile The Percentile of the percentage of process CPU usage

threads_count integer 24 lastval Count of threads

threads_avg_count integer 24 average The Average count of threads

threads_min_count integer 24 min The Minimum count of threads

threads_max_count integer 24 max The Maximum count of threads

threads_delta_count integer 24 lastval Delta of threads count

threads_delta_avg_count integer 24 average The Average delta of threads count

threads_delta_min_count integer 24 min The Minimum delta of threads count

threads_delta_max_count integer 24 max The Maximum delta of threads count

gc_count integer 24 lastval Garbage Collection Count

gc_avg_count integer 24 average The Average garbage Collection Count

gc_min_count integer 24 min The Minimum garbage Collection Count

gc_max_count integer 24 max The Maximum garbage Collection Count

gc_delta_count integer 24 lastval Delta of Garbage Collection Count

gc_delta_avg_count integer 24 average The Average delta of Garbage Collection Count

gc_delta_min_count integer 24 min The Minimum delta of Garbage Collection Count

gc_delta_max_count integer 24 max The Maximum delta of Garbage Collection Count

The Average time taken for garbage collection in


gc_time_avg_s double 48 average
seconds.

The Minimum time taken for garbage collection in


gc_time_min_s double 48 min
seconds.

The Maximum time taken for garbage collection in


gc_time_max_s double 48 max
seconds.

gc_delta_time_avg_s double 48 average The Average delta of Garbage Collection Time

gc_delta_time_min_s double 48 min The Minimum delta of Garbage Collection Time

gc_delta_time_max_s double 48 max The Maximum delta of Garbage Collection Time

uptime_avg_s double 48 average The Average JVM up time in seconds.

uptime_min_s double 48 min The Minimum JVM up time in seconds.

uptime_max_s double 48 max The Maximum JVM up time in seconds.

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

The Average percentage of heap space used in the JVM


jvm_used_heap_size_pct_avg double 48 average
in kilobytes.

The Minimum percentage of heap space used in the


jvm_used_heap_size_pct_min double 48 min
JVM in kilobytes.

The Maximum percentage of heap space used in the


jvm_used_heap_size_pct_max double 48 max
JVM in kilobytes.

The Percentile of the percentage of heap space used in


jvm_used_heap_size_pct_pctl double 48 90 percentile
the JVM in kilobytes.

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.

The Average percentage of JVM Free Memory available


jvm_free_mem_available_pct_avg double 48 average
in kilobytes.

The Minimum percentage of JVM Free Memory available


jvm_free_mem_available_pct_min double 48 min
in kilobytes.

The Maximum percentage of JVM Free Memory


jvm_free_mem_available_pct_max double 48 max
available in kilobytes.

The Percentile of the percentage of JVM Free Memory


jvm_free_mem_available_pct_pctl double 48 90 percentile
available in kilobytes.

The Average garbage collection value in seconds


gc_avg_interval_avg_s double 48 average
between two garbage collections.

The Minimum average garbage collection value in


gc_avg_interval_min_s double 48 min
seconds between two garbage collections.

The Maximum average garbage collection value in


gc_avg_interval_max_s double 48 max
seconds between two garbage collections.

Indicates the type of the data producer that ingested


producer_instance_type string 50 lastval
the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id string 255 lastval
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id uuid lastval should be used 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]


cmdb_global_id uuid lastval should be used in 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.
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope
collection_type string 255 lastval Streaming", "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM Engine", "OBM
Server Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored if using


node_ipv4_address string 50 lastval
IPV4.

The IP address of the monitored server. Encoded as


node_ipv6_address string 50 lastval IPv6 format. Fully specified ipv6 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 534
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
Type

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must


node_short_name string 255 lastval
not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being


node_fqdn node_fqdn string 255
monitored. That is the server to which the data belongs

This field holds the tenant id to which the row in


tenant_id tenant_id string dataset belongs to. Needed to apply row level access 255
policies to control access to data.

The start time of the aggregation period in UNIX epoch


timestamp_utc_s timestamp_utc_s integer 24
format in seconds

websphere_jvm_instance websphere_jvm_instance string Instance of JVM 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in timestamp


timestamp_tz timestamp 26 average format. Aggregation is performed based on Vertica
timezone, so this value will be in Vertica timezone

This field gives the number of source table records


__count__ integer considered for aggregation to build this particular
record in the aggregate destination table.

This field gives the timezone aware timestamp at which


this particular record in the aggregate destination table
__update_time__ timestamp_tz
got last updated by aggregation. The timestamp will be
in the Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

SERVERINST websphere_srv_instance string 255 Instance of the server

WEBSPHERE_NAME websphere_name string 255 Websphere name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

websphere_name string 255 lastval Websphere name

The time duration (in minutes) in an hour when the


uptime_min double sum
Websphere server is in running state.

The Average percentage of time in an hour when the


uptime_avg_pct double avg
Websphere server is in running state.

The time duration (in minutes) in an hour when the


downtime_min double sum
Websphere server is not in running state.

The Average percentage of time in an hour when the


downtime_avg_pct double avg
Websphere server is not in running state.

The time duration (in minutes) in an hour when Websphere


unknown_time_min double sum
server is not in running state due to unknown outage.

The Average percentage of time in an hour when the


unknown_time_avg_pct double avg Websphere server is not in running state due to unknown
outage.

The time duration (in minutes) in an hour when the


planned_downtime_min double sum Websphere server is not in running state due to planned
outage.

The Average percentage of time in an hour when the


planned_downtime_avg_pct double avg Websphere server is not in running state due to planned
outage.

Indicates the type of the data producer that ingested the data.
producer_instance_type string 50 lastval
E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id uuid lastval be used 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


cmdb_global_id uuid lastval be used in 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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "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


node_ipv6_address string 50 lastval format. Fully specified ipv6 format without any simplification
rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being monitored.


node_fqdn node_fqdn string 255
That is the server to which the data belongs

This field holds the tenant id to which the row in dataset


tenant_id tenant_id string belongs to. Needed to apply row level access policies to 255
control access to data.

The start time of the aggregation period in UNIX epoch format


timestamp_utc_s timestamp_utc_s integer 24
in seconds

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in timestamp format.


timestamp_tz timestamp 26 average Aggregation is performed based on Vertica timezone, so this
value will be in Vertica timezone

This field gives the number of source table records considered


__count__ integer for aggregation to build this particular record in the aggregate
destination table.

This field gives the timezone aware timestamp at which this


particular record in the aggregate destination table got last
__update_time__ timestamp_tz
updated by aggregation. The timestamp will be in the Vertica
server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

SERVERINST websphere_srv_instance string 255 Instance of the server

WEBSPHERE_NAME websphere_name string 255 Websphere name

The time duration (in minutes) in an hour when the Websphere server is in
null uptime_min double
running state.

The percentage of time in an hour when the Websphere server is in


null uptime_pct 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 percentage of time in an hour when the Websphere server is not in


null downtime_pct double
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 percentage of time in an hour when the Websphere server is not


null planned_downtime_pct double
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.

The percentage of time in an hour when the Websphere server is not


null unknown_time_pct double
running due to unknown outage.

Timestamp with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

APPINSTANCE websphere_app_instance string 255 Instance of the application

SERVERINST websphere_srv_instance string 255 Instance of the server

APPNAME app_name string 255 Application name

SRVLTNAME servlet_name string 255 Servlet name

PORT port string 255 Port

SRVRNAME srv_name string 255 server name

DMNNAME domain_name string 255 Domain Manager name

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

WEBAPPSERVERRRT servlet_err_count_per_s double 48 Number of errors in a servlet 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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 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

app_name string 255 lastval Application name

servlet_name string 255 lastval Servlet name

port string 255 lastval Port

srv_name string 255 lastval server name

domain_name string 255 lastval Domain Manager name

The Average number of requests for a servlet per


servlet_req_app_avg_count_per_s double 48 average
second for an application

The Minimum number of requests for a servlet per


servlet_req_app_min_count_per_s double 48 min
second for an application

The Maximum number of requests for a servlet per


servlet_req_app_max_count_per_s double 48 max
second for an application

The Average response time for a web application


servlet_avg_resp_time_avg_ms average
servlet in milliseconds

The Minimum average response time for a web


servlet_avg_resp_time_min_ms min
application servlet in milliseconds

The Maximum average response time for a web


servlet_avg_resp_time_max_ms max
application servlet in milliseconds

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.

Indicates the type of the data producer that ingested


producer_instance_type string 50 lastval
the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id string 255 lastval
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id uuid lastval should be used 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]


cmdb_global_id uuid lastval should be used in 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.
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope
collection_type string 255 lastval Streaming", "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM Engine", "OBM
Server Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored if using


node_ipv4_address string 50 lastval
IPV4.

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

The IP address of the monitored server. Encoded as


node_ipv6_address string 50 lastval IPv6 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must


node_short_name string 255 lastval
not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being


node_fqdn node_fqdn string 255
monitored. That is the server to which the data belongs

This field holds the tenant id to which the row in


tenant_id tenant_id string dataset belongs to. Needed to apply row level access 255
policies to control access to data.

The start time of the aggregation period in UNIX epoch


timestamp_utc_s timestamp_utc_s integer 24
format in seconds

websphere_app_instance websphere_app_instance string Instance of the application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in timestamp


timestamp_tz timestamp 26 average format. Aggregation is performed based on Vertica
timezone, so this value will be in Vertica timezone

This field gives the number of source table records


__count__ integer considered for aggregation to build this particular
record in the aggregate destination table.

This field gives the timezone aware timestamp at which


this particular record in the aggregate destination table
__update_time__ timestamp_tz
got last updated by aggregation. The timestamp will be
in the Vertica server timezone.

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

app_name string 255 lastval Application name

servlet_name string 255 lastval Servlet name

port string 255 lastval Port

srv_name string 255 lastval server name

domain_name string 255 lastval Domain Manager name

The Average number of requests for a servlet per


servlet_req_app_avg_count_per_s double 48 average
second for an application

The Minimum number of requests for a servlet per


servlet_req_app_min_count_per_s double 48 min
second for an application

The Maximum number of requests for a servlet per


servlet_req_app_max_count_per_s double 48 max
second for an application

The Average response time for a web application


servlet_avg_resp_time_avg_ms double 48 average
servlet in milliseconds

The Minimum average response time for a web


servlet_avg_resp_time_min_ms double 48 min
application servlet in milliseconds

The Maximum average response time for a web


servlet_avg_resp_time_max_ms double 48 max
application servlet in milliseconds

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.

Indicates the type of the data producer that ingested


producer_instance_type string 50 lastval
the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id string 255 lastval
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id uuid lastval should be used 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]


cmdb_global_id uuid lastval should be used in 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.
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope
collection_type string 255 lastval Streaming", "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM Engine", "OBM
Server Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored if using


node_ipv4_address string 50 lastval
IPV4.

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

The IP address of the monitored server. Encoded as


node_ipv6_address string 50 lastval IPv6 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must


node_short_name string 255 lastval
not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being


node_fqdn node_fqdn string 255
monitored. That is the server to which the data belongs

This field holds the tenant id to which the row in


tenant_id tenant_id string dataset belongs to. Needed to apply row level access 255
policies to control access to data.

The start time of the aggregation period in UNIX epoch


timestamp_utc_s timestamp_utc_s integer 24
format in seconds

websphere_app_instance websphere_app_instance string Instance of the application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in timestamp


timestamp_tz timestamp 26 average format. Aggregation is performed based on Vertica
timezone, so this value will be in Vertica timezone

This field gives the number of source table records


__count__ integer considered for aggregation to build this particular
record in the aggregate destination table.

This field gives the timezone aware timestamp at which


this particular record in the aggregate destination table
__update_time__ timestamp_tz
got last updated by aggregation. The timestamp will be
in the Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

APPINSTANCE websphere_app_instance string 255 Instance of the application

SERVERINST websphere_srv_instance string 255 Instance of the server

APPNAME app_name string 255 Application name

PORT port string 255 Port

SRVRNAME srv_name string 255 server name

DMNNAME domain_name string 255 Domain Manager name

SERVSESSAVELIFE servlet_avg_session_lifetime_ms double 48 Average servlet session lifetime in milliseconds

SERVSESSACT servlet_session_accessed_count double 48 Number of servlet sessions currently being accessed

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

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the 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 547
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

app_name string 255 lastval Application name

port string 255 lastval Port

srv_name string 255 lastval server name

domain_name string 255 lastval Domain Manager name

The Average of servlet session lifetime in


servlet_avg_session_lifetime_avg_ms average
milliseconds

The Minimum of average servlet session


servlet_avg_session_lifetime_min_ms min
lifetime in milliseconds

The Maximum of average servlet session


servlet_avg_session_lifetime_max_ms max
lifetime in milliseconds

Number of servlet sessions currently being


servlet_session_accessed_count double 48 lastval
accessed

The Average number of servlet sessions


servlet_session_accessed_avg_count double 48 average
currently being accessed

The Minimum number of servlet sessions


servlet_session_accessed_min_count double 48 min
currently being accessed

The Maximum number of servlet sessions


servlet_session_accessed_max_count double 48 max
currently being accessed

The Average number of servlet sessions


servlet_session_invalidated_avg_count_per_s double 48 average
being invalidated per second

The Minimum number of servlet sessions


servlet_session_invalidated_min_count_per_s double 48 min
being invalidated per second

The Maximum number of servlet sessions


servlet_session_invalidated_max_count_per_s double 48 max
being invalidated per second

Indicates the type of the data producer that


producer_instance_type string 50 lastval
ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer


producer_instance_id string 255 lastval
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
collection_data_flow string 80 lastval provides data through an API 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 549
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
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"

A detailed description of the actual collector


that actively collects data. For example:
"SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored


node_ipv4_address string 50 lastval
if using IPV4.

The IP address of the monitored server.


node_ipv6_address string 50 lastval Encoded as IPv6 format. Fully specified ipv6
format without any simplification rules.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example: +1,
+4.5, -8

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to which 255
the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to apply
tenant_id tenant_id string 255
row level access policies to control access to
data.

The start time of the aggregation period in


timestamp_utc_s timestamp_utc_s integer 24
UNIX epoch format in seconds

websphere_app_instance websphere_app_instance string Instance of the application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in


timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to build
__count__ integer
this particular record in the aggregate
destination table.

This field gives the timezone aware


timestamp at which this particular record in
__update_time__ timestamp_tz the aggregate destination table got last
updated by aggregation. The timestamp will
be in the Vertica server timezone.

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

app_name string 255 lastval Application name

port string 255 lastval Port

srv_name string 255 lastval server name

domain_name string 255 lastval Domain Manager name

The Average of servlet session lifetime in


servlet_avg_session_lifetime_avg_ms double 48 average
milliseconds

The Minimum of average servlet session


servlet_avg_session_lifetime_min_ms double 48 min
lifetime in milliseconds

The Maximum of average servlet session


servlet_avg_session_lifetime_max_ms double 48 max
lifetime in milliseconds

Number of servlet sessions currently being


servlet_session_accessed_count double 48 lastval
accessed

The Average number of servlet sessions


servlet_session_accessed_avg_count double 48 average
currently being accessed

The Minimum number of servlet sessions


servlet_session_accessed_min_count double 48 min
currently being accessed

The Maximum number of servlet sessions


servlet_session_accessed_max_count double 48 max
currently being accessed

The Average number of servlet sessions


servlet_session_invalidated_avg_count_per_s double 48 average
being invalidated per second

The Minimum number of servlet sessions


servlet_session_invalidated_min_count_per_s double 48 min
being invalidated per second

The Maximum number of servlet sessions


servlet_session_invalidated_max_count_per_s double 48 max
being invalidated per second

Indicates the type of the data producer that


producer_instance_type string 50 lastval
ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer


producer_instance_id string 255 lastval
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
collection_data_flow string 80 lastval provides data through an API 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 551
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
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"

A detailed description of the actual collector


that actively collects data. For example:
"SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored


node_ipv4_address string 50 lastval
if using IPV4.

The IP address of the monitored server.


node_ipv6_address string 50 lastval Encoded as IPv6 format. Fully specified ipv6
format without any simplification rules.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example: +1,
+4.5, -8

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to which 255
the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to apply
tenant_id tenant_id string 255
row level access policies to control access to
data.

The start time of the aggregation period in


timestamp_utc_s timestamp_utc_s integer 24
UNIX epoch format in seconds

websphere_app_instance websphere_app_instance string Instance of the application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period in


timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to build
__count__ integer
this particular record in the aggregate
destination table.

This field gives the timezone aware


timestamp at which this particular record in
__update_time__ timestamp_tz the aggregate destination table got last
updated by aggregation. The timestamp will
be in the Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

THRDPOOLINST websphere_thread_pool_instance string 255 Instance of the thread pool

SERVERINST websphere_srv_instance string 255 Instance of the server

THRDPOOLNAME thread_pool_name string 255 Thread pool name

PORT port string 255 Port

DMNNAME domain_name string 255 Domain Manager name

SRVRNAME srv_name string 255 Server name

Average number of active threads in a pool during collection


THREADPOOLACTTHRDS thread_pool_avg_active_threads_count double 48
interval.

Average number of threads (active and idle) in a pool during


THREADPOOLAVESIZE thread_pool_avg_threads_count double 48
collection interval.

THREADPOOLUTILPCT thread_pool_threads_used_pct double 48 Percentage of threads used in a pool during collection interval

Percentage of time number of threads in pool reached


THREADPOOLPCTMAXAPP thread_pool_threads_max_size_app_pct double 48
configured maximum size for an application.

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to 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 553
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

thread_pool_name string 255 lastval Thread pool name

port string 255 lastval Port

domain_name string 255 lastval Domain Manager name

srv_name string 255 lastval Server name

Average number of active threads in


thread_pool_avg_active_threads_count double 48 lastval
a pool during collection interval.

The Average number of active


thread_pool_avg_active_threads_avg_count double 48 average threads in a pool during collection
interval.

The Minimum average number of


thread_pool_avg_active_threads_min_count double 48 min active threads in a pool during
collection interval.

The Maximum average number of


thread_pool_avg_active_threads_max_count double 48 max active threads in a pool during
collection interval.

Average number of threads (active


thread_pool_avg_threads_count double 48 lastval and idle) in a pool during collection
interval.

The Average number of threads


thread_pool_avg_threads_avg_count double 48 average (active and idle) in a pool during
collection interval.

The Minimum average number of


thread_pool_avg_threads_min_count double 48 min threads (active and idle) in a pool
during collection interval.

The Maximum average number of


thread_pool_avg_threads_max_count double 48 max threads (active and idle) in a pool
during collection interval.

The Average percentage of threads


thread_pool_threads_used_avg_pct double 48 average used in a pool during collection
interval

The Minimum percentage of threads


thread_pool_threads_used_min_pct double 48 min used in a pool during collection
interval

The Maximum percentage of threads


thread_pool_threads_used_max_pct double 48 max used in a pool during collection
interval

The Percentile of the percentage of


thread_pool_threads_used_pctl_pct double 48 90 percentile threads used in a pool during
collection interval

The Average percentage of time


number of threads in pool reached
thread_pool_threads_max_size_app_avg_pct double 48 average
configured maximum size for an
application.

The Maximum percentage of time


number of threads in pool reached
thread_pool_threads_max_size_app_max_pct double 48 max
configured maximum size for an
application.

The Minimum percentage of time


number of threads in pool reached
thread_pool_threads_max_size_app_min_pct double 48 min
configured maximum size for an
application.

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

The Percentile of the percentage of


time number of threads in pool
thread_pool_threads_max_size_app_pctl_pct double 48 90 percentile
reached configured maximum size
for an application.

Indicates the type of the data


producer_instance_type string 50 lastval producer that ingested the data. E.g
UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
type

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

Values are Push or Pull. Push:Data


producer (producer instance id)
actively pushes data directly to
COSO. Pull:Data producer provides
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
monitored if using IPV4.

The IP address of the monitored


server. Encoded as IPv6 format. Fully
node_ipv6_address string 50 lastval
specified ipv6 format without any
simplification rules.

IP Type of the monitored node (IPV4


node_ip_type string 80 lastval
or IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain
any '.' (Period) character.

Time zone offset to UTC in hours of


node_timezone_offset_h string 80 lastval the server being monitored. For
example: +1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to 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 556
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
Type

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.

The start time of the aggregation


timestamp_utc_s timestamp_utc_s integer period in UNIX epoch format in 24
seconds

websphere_srv_instance websphere_srv_instance string Instance of the server 255

websphere_thread_pool_instance websphere_thread_pool_instance string Instance of the thread pool 255

The start time of the aggregation


period in timestamp format.
timestamp_tz timestamp 26 average Aggregation is performed based on
Vertica timezone, so this value will
be in Vertica timezone

This field gives the number of source


table records considered for
__count__ integer aggregation to build this particular
record in the aggregate destination
table.

This field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by
aggregation. The timestamp will be
in the Vertica server timezone.

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

thread_pool_name string 255 lastval Thread pool name

port string 255 lastval Port

domain_name string 255 lastval Domain Manager name

srv_name string 255 lastval Server name

Average number of active threads in


thread_pool_avg_active_threads_count double 48 lastval
a pool during collection interval.

The Average number of active


thread_pool_avg_active_threads_avg_count double 48 average threads in a pool during collection
interval.

The Minimum average number of


thread_pool_avg_active_threads_min_count double 48 min active threads in a pool during
collection interval.

The Maximum average number of


thread_pool_avg_active_threads_max_count double 48 max active threads in a pool during
collection interval.

Average number of threads (active


thread_pool_avg_threads_count double 48 lastval and idle) in a pool during collection
interval.

The Average number of threads


thread_pool_avg_threads_avg_count double 48 average (active and idle) in a pool during
collection interval.

The Minimum average number of


thread_pool_avg_threads_min_count double 48 min threads (active and idle) in a pool
during collection interval.

The Maximum average number of


thread_pool_avg_threads_max_count double 48 max threads (active and idle) in a pool
during collection interval.

The Average percentage of threads


thread_pool_threads_used_avg_pct double 48 average used in a pool during collection
interval

The Minimum percentage of threads


thread_pool_threads_used_min_pct double 48 min used in a pool during collection
interval

The Maximum percentage of threads


thread_pool_threads_used_max_pct double 48 max used in a pool during collection
interval

The Percentile of the percentage of


thread_pool_threads_used_pctl_pct double 48 90 percentile threads used in a pool during
collection interval

The Average percentage of time


number of threads in pool reached
thread_pool_threads_max_size_app_avg_pct double 48 average
configured maximum size for an
application.

The Maximum percentage of time


number of threads in pool reached
thread_pool_threads_max_size_app_max_pct double 48 max
configured maximum size for an
application.

The Minimum percentage of time


number of threads in pool reached
thread_pool_threads_max_size_app_min_pct double 48 min
configured maximum size for an
application.

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

The Percentile of the percentage of


time number of threads in pool
thread_pool_threads_max_size_app_pctl_pct double 48 90 percentile
reached configured maximum size
for an application.

Indicates the type of the data


producer_instance_type string 50 lastval producer that ingested the data. E.g
UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
type

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

Values are Push or Pull. Push:Data


producer (producer instance id)
actively pushes data directly to
COSO. Pull:Data producer provides
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
monitored if using IPV4.

The IP address of the monitored


server. Encoded as IPv6 format. Fully
node_ipv6_address string 50 lastval
specified ipv6 format without any
simplification rules.

IP Type of the monitored node (IPV4


node_ip_type string 80 lastval
or IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain
any '.' (Period) character.

Time zone offset to UTC in hours of


node_timezone_offset_h string 80 lastval the server being monitored. For
example: +1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to 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 559
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
Type

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.

The start time of the aggregation


timestamp_utc_s timestamp_utc_s integer period in UNIX epoch format in 24
seconds

websphere_srv_instance websphere_srv_instance string Instance of the server 255

websphere_thread_pool_instance websphere_thread_pool_instance string Instance of the thread pool 255

The start time of the aggregation


period in timestamp format.
timestamp_tz timestamp 26 average Aggregation is performed based on
Vertica timezone, so this value will
be in Vertica timezone

This field gives the number of source


table records considered for
__count__ integer aggregation to build this particular
record in the aggregate destination
table.

This field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by
aggregation. The timestamp will be
in the Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

THRDPOOLINST websphere_thread_pool_instance string 255 Instance of the thread pool

SERVERINST websphere_srv_instance string 255 Instance of the server

THRDPOOLNAME thread_pool_name string 255 Thread pool name

PORT port string 255 Port

DMNNAME domain_name string 255 Domain Manager name

SRVRNAME srv_name string 255 Server name

Percentage of time number of threads in pool reached configured


THREADPOOLPCTMAX thread_pool_threads_max_size_pct double 48
maximum size.

THREADPOOLCREATERT threads_created_count_per_min double 48 Number of threads created per minute.

THREADPOOLHUNGRT threads_declared_hung_count_per_s double 48 The rate at which the threads are declared hung.

CCRTTHREADPLHNGCT threads_concurr_hung_count double 48 The number of concurrently hung threads.

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80
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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

thread_pool_name string 255 lastval Thread pool name

port string 255 lastval Port

domain_name string 255 lastval Domain Manager name

srv_name string 255 lastval Server name

The Average percentage of time


thread_pool_threads_max_size_avg_pct double 48 average number of threads in pool reached
configured maximum size.

The Minimum percentage of time


thread_pool_threads_max_size_min_pct double 48 min number of threads in pool reached
configured maximum size.

The Maximum percentage of time


thread_pool_threads_max_size_max_pct double 48 max number of threads in pool reached
configured maximum size.

The Percentile of time number of


thread_pool_threads_max_size_pctl_pct double 48 90 percentile threads in pool reached configured
maximum size.

The Average number of threads created


threads_created_avg_count_per_min double 48 average
per minute.

The Minimum number of threads


threads_created_min_count_per_min double 48 min
created per minute.

The Maximum number of threads


threads_created_max_count_per_min double 48 max
created per minute.

The Average rate at which the threads


threads_declared_hung_avg_count_per_s double 48 average
are declared hung.

The Minimum rate at which the threads


threads_declared_hung_min_count_per_s double 48 min
are declared hung.

The Maximum rate at which the threads


threads_declared_hung_max_count_per_s double 48 max
are declared hung.

The number of concurrently hung


threads_concurr_hung_count double 48 lastval
threads.

The Average number of concurrently


threads_concurr_hung_avg_count double 48 average
hung threads.

The Minimum number of concurrently


threads_concurr_hung_min_count double 48 min
hung threads.

The Maximum number of concurrently


threads_concurr_hung_max_count double 48 max
hung threads.

Indicates the type of the data producer


producer_instance_type string 50 lastval that ingested the data. E.g UCMDB,
NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
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

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

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
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any
'.' (Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example:
+1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to which the data belongs

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.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_srv_instance websphere_srv_instance string Instance of the server 255

websphere_thread_pool_instance websphere_thread_pool_instance string Instance of the thread pool 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone,
so this value will be in Vertica timezone

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 field gives the number of source


table records considered for
__count__ integer aggregation to build this particular
record in the aggregate destination
table.

This field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by aggregation.
The timestamp will be in the Vertica
server timezone.

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

thread_pool_name string 255 lastval Thread pool name

port string 255 lastval Port

domain_name string 255 lastval Domain Manager name

srv_name string 255 lastval Server name

The Average percentage of time


thread_pool_threads_max_size_avg_pct double 48 average number of threads in pool reached
configured maximum size.

The Minimum percentage of time


thread_pool_threads_max_size_min_pct double 48 min number of threads in pool reached
configured maximum size.

The Maximum percentage of time


thread_pool_threads_max_size_max_pct double 48 max number of threads in pool reached
configured maximum size.

The Percentile of time number of


thread_pool_threads_max_size_pctl_pct double 48 90 percentile threads in pool reached configured
maximum size.

The Average number of threads created


threads_created_avg_count_per_min double 48 average
per minute.

The Minimum number of threads


threads_created_min_count_per_min double 48 min
created per minute.

The Maximum number of threads


threads_created_max_count_per_min double 48 max
created per minute.

The Average rate at which the threads


threads_declared_hung_avg_count_per_s double 48 average
are declared hung.

The Minimum rate at which the threads


threads_declared_hung_min_count_per_s double 48 min
are declared hung.

The Maximum rate at which the threads


threads_declared_hung_max_count_per_s double 48 max
are declared hung.

The number of concurrently hung


threads_concurr_hung_count double 48 lastval
threads.

The Average number of concurrently


threads_concurr_hung_avg_count double 48 average
hung threads.

The Minimum number of concurrently


threads_concurr_hung_min_count double 48 min
hung threads.

The Maximum number of concurrently


threads_concurr_hung_max_count double 48 max
hung threads.

Indicates the type of the data producer


producer_instance_type string 50 lastval that ingested the data. E.g UCMDB,
NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval producer instance within a producer
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

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

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
collection_data_flow string 80 lastval 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_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming",
"Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server
Event Forwarding", "SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any
'.' (Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example:
+1, +4.5, -8

The fully qualified hostname of the


node_fqdn node_fqdn string server being monitored. That is the 255
server to which the data belongs

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.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_srv_instance websphere_srv_instance string Instance of the server 255

websphere_thread_pool_instance websphere_thread_pool_instance string Instance of the thread pool 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone,
so this value will be in Vertica timezone

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 field gives the number of source


table records considered for
__count__ integer aggregation to build this particular
record in the aggregate destination
table.

This field gives the timezone aware


timestamp at which this particular
record in the aggregate destination
__update_time__ timestamp_tz
table got last updated by aggregation.
The timestamp will be in the Vertica
server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

TRANSINSTANCE websphere_txn_instance string 255 Instance of the transaction

SERVERINST websphere_srv_instance string 255 Instance of the server

PORT port string 255 Port

SRVRNAME srv_name string 255 Server name

DMNNAME domain_name string 255 Domain Manager name

APPTRANSNAME app_txn_name string 255 Application transaction name

TRANGLOBDUR global_avg_txn_duration_ms double 48 Average duration of global transactions in milliseconds

TRANLOCDUR local_avg_txn_duration_ms double 48 Average duration of local transactions in milliseconds

Average duration of commits for global transactions in


TRANGLOBCOMMDUR global_avg_txn_commit_duration_ms double 48
milliseconds

Average duration of commits for local transactions in


TRANLOCCOMMITDUR local_avg_txn_commit_duration_ms double 48
milliseconds.

TRANROLLBACKRT txn_rolled_back_count_per_s double 48 Number of global and local transactions rolled back per second

Number of global and local transactions that timed out per


TRANTIMEOUTRT txn_timed_out_count_per_s double 48
second

Number of global and local transactions that were committed per


TRANCOMMITRT txn_committed_count_per_s double 48
second

TRANTHROUGHPUT txn_count_per_s double 48 Transaction throughput

Number of global and local transactions that were begun per


TRANSTARTRT txn_begun_count_per_s double 48
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


collection_source collection_source string 255 can 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80
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.
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

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively collects


data. For example: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager name

app_txn_name string 255 lastval Application transaction name

The Average duration of global transactions in


global_avg_txn_duration_avg_ms average
milliseconds

The Minimum average duration of global


global_avg_txn_duration_min_ms min
transactions in milliseconds

The Maximum average duration of global


global_avg_txn_duration_max_ms max
transactions in milliseconds

The Average duration of local transactions in


local_avg_txn_duration_avg_ms average
milliseconds

The Minimum average duration of local


local_avg_txn_duration_min_ms min
transactions in milliseconds

The Maximum average duration of local


local_avg_txn_duration_max_ms max
transactions in milliseconds

The Average duration of commits for global


global_avg_txn_commit_duration_avg_ms average
transactions in milliseconds

The Minimum average duration of commits for


global_avg_txn_commit_duration_min_ms min
global transactions in milliseconds

The Maximum average duration of commits for


global_avg_txn_commit_duration_max_ms max
global transactions in milliseconds

The Average duration of commits for local


local_avg_txn_commit_duration_avg_ms average
transactions in milliseconds.

The Minimum average duration of commits for


local_avg_txn_commit_duration_min_ms min
local transactions in milliseconds.

The Maximum average duration of commits for


local_avg_txn_commit_duration_max_ms max
local transactions in milliseconds.

The Average number of global and local


txn_rolled_back_count_per_avg_s double 48 average
transactions rolled back per second

The Minimum number of global and local


txn_rolled_back_count_per_min_s double 48 min
transactions rolled back per second

The Maximum number of global and local


txn_rolled_back_count_per_max_s double 48 max
transactions rolled back per second

The Average number of global and local


txn_timed_out_count_per_avg_s double 48 average
transactions that timed out per second

The Minimum number of global and local


txn_timed_out_count_per_min_s double 48 min
transactions that timed out per second

The Maximum number of global and local


txn_timed_out_count_per_max_s double 48 max
transactions that timed out per second

The Average number of global and local


txn_committed_count_per_avg_s double 48 average
transactions that were committed per second

The Minimum number of global and local


txn_committed_count_per_min_s double 48 min
transactions that were committed per second

The Maximum number of global and local


txn_committed_count_per_max_s double 48 max
transactions that were committed per second

txn_avg_count_per_s double 48 average The Average transaction throughput

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

txn_min_count_per_s double 48 min The Minimum transaction throughput

txn_max_count_per_s double 48 max The Maximum transaction throughput

The Average number of global and local


txn_begun_count_per_avg_s double 48 average
transactions that were begun per second

The Minimum number of global and local


txn_begun_count_per_min_s double 48 min
transactions that were begun per second

The Maximum number of global and local


txn_begun_count_per_max_s double 48 max
transactions that were begun per second

Indicates the type of the data producer that


producer_instance_type string 50 lastval
ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer


producer_instance_id string 255 lastval
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 COSO. Pull:Data producer provides
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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:
"SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored if


node_ipv4_address string 50 lastval
using IPV4.

The IP address of the monitored server.


node_ipv6_address string 50 lastval Encoded as IPv6 format. Fully specified ipv6
format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the server


node_timezone_offset_h string 80 lastval
being monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being


node_fqdn node_fqdn string monitored. That is the server to which the data 255
belongs

This field holds the tenant id to which the row in


tenant_id tenant_id string dataset belongs to. Needed to apply row level 255
access policies to control access to data.

The start time of the aggregation period in UNIX


timestamp_utc_s timestamp_utc_s integer 24
epoch format in seconds

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

websphere_srv_instance websphere_srv_instance string Instance of the server 255

websphere_txn_instance websphere_txn_instance string Instance of the transaction 255

The start time of the aggregation period in


timestamp format. Aggregation is performed
timestamp_tz timestamp 26 average
based on Vertica timezone, so this value will be
in Vertica timezone

This field gives the number of source table


records considered for aggregation to build this
__count__ integer
particular record in the aggregate destination
table.

This field gives the timezone aware timestamp


at which this particular record in the aggregate
__update_time__ timestamp_tz destination table got last updated by
aggregation. The timestamp will be in the
Vertica server timezone.

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

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager name

app_txn_name string 255 lastval Application transaction name

The Average duration of global transactions in


global_avg_txn_duration_avg_ms double 48 average
milliseconds

The Minimum average duration of global


global_avg_txn_duration_min_ms double 48 min
transactions in milliseconds

The Maximum average duration of global


global_avg_txn_duration_max_ms double 48 max
transactions in milliseconds

The Average duration of local transactions in


local_avg_txn_duration_avg_ms double 48 average
milliseconds

The Minimum average duration of local


local_avg_txn_duration_min_ms double 48 min
transactions in milliseconds

The Maximum average duration of local


local_avg_txn_duration_max_ms double 48 max
transactions in milliseconds

The Average duration of commits for global


global_avg_txn_commit_duration_avg_ms double 48 average
transactions in milliseconds

The Minimum average duration of commits for


global_avg_txn_commit_duration_min_ms double 48 min
global transactions in milliseconds

The Maximum average duration of commits for


global_avg_txn_commit_duration_max_ms double 48 max
global transactions in milliseconds

The Average duration of commits for local


local_avg_txn_commit_duration_avg_ms double 48 average
transactions in milliseconds.

The Minimum average duration of commits for


local_avg_txn_commit_duration_min_ms double 48 min
local transactions in milliseconds.

The Maximum average duration of commits for


local_avg_txn_commit_duration_max_ms double 48 max
local transactions in milliseconds.

The Average number of global and local


txn_rolled_back_count_per_avg_s double 48 average
transactions rolled back per second

The Minimum number of global and local


txn_rolled_back_count_per_min_s double 48 min
transactions rolled back per second

The Maximum number of global and local


txn_rolled_back_count_per_max_s double 48 max
transactions rolled back per second

The Average number of global and local


txn_timed_out_count_per_avg_s double 48 average
transactions that timed out per second

The Minimum number of global and local


txn_timed_out_count_per_min_s double 48 min
transactions that timed out per second

The Maximum number of global and local


txn_timed_out_count_per_max_s double 48 max
transactions that timed out per second

The Average number of global and local


txn_committed_count_per_avg_s double 48 average
transactions that were committed per second

The Minimum number of global and local


txn_committed_count_per_min_s double 48 min
transactions that were committed per second

The Maximum number of global and local


txn_committed_count_per_max_s double 48 max
transactions that were committed per second

txn_avg_count_per_s double 48 average The Average transaction throughput

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

txn_min_count_per_s double 48 min The Minimum transaction throughput

txn_max_count_per_s double 48 max The Maximum transaction throughput

The Average number of global and local


txn_begun_count_per_avg_s double 48 average
transactions that were begun per second

The Minimum number of global and local


txn_begun_count_per_min_s double 48 min
transactions that were begun per second

The Maximum number of global and local


txn_begun_count_per_max_s double 48 max
transactions that were begun per second

Indicates the type of the data producer that


producer_instance_type string 50 lastval
ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer


producer_instance_id string 255 lastval
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 COSO. Pull:Data producer provides
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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:
"SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
Streaming", "Collection Service - Agent", "BPM
Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.

IPV4 address of the server being monitored if


node_ipv4_address string 50 lastval
using IPV4.

The IP address of the monitored server.


node_ipv6_address string 50 lastval Encoded as IPv6 format. Fully specified ipv6
format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored.


node_short_name string 255 lastval Name must not contain any '.' (Period)
character.

Time zone offset to UTC in hours of the server


node_timezone_offset_h string 80 lastval
being monitored. For example: +1, +4.5, -8

The fully qualified hostname of the server being


node_fqdn node_fqdn string monitored. That is the server to which the data 255
belongs

This field holds the tenant id to which the row in


tenant_id tenant_id string dataset belongs to. Needed to apply row level 255
access policies to control access to data.

The start time of the aggregation period in UNIX


timestamp_utc_s timestamp_utc_s integer 24
epoch format in seconds

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

websphere_srv_instance websphere_srv_instance string Instance of the server 255

websphere_txn_instance websphere_txn_instance string Instance of the transaction 255

The start time of the aggregation period in


timestamp format. Aggregation is performed
timestamp_tz timestamp 26 average
based on Vertica timezone, so this value will be
in Vertica timezone

This field gives the number of source table


records considered for aggregation to build this
__count__ integer
particular record in the aggregate destination
table.

This field gives the timezone aware timestamp


at which this particular record in the aggregate
__update_time__ timestamp_tz destination table got last updated by
aggregation. The timestamp will be in the
Vertica server timezone.

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

Metric Name/Global Data


Column Name Size Description
Name Type

APPINSTANCE websphere_app_instance string 255 Instance of the Application

SERVERINST websphere_srv_instance string 255 Instance of the server

APPNAME app_name string 255 Application name

PORT port string 255 Port

SRVRNAME srv_name string 255 Server name

DMNNAME domain_name string 255 Domain Manager

WEBAPPSERVREQRT servlet_session_invalidated_count_per_s double 48 Number of servlet sessions being invalidated per second.

WEBAPPSERVERRRT servlet_err_count_per_s double 48 Number of errors in a servlet per second.

WEBAPPSERVLOAD webapp_servlets_loaded_count_per_s double 48 Number of servlets currently loaded for a web application

Number of servlets reloaded for a web application per


WEBAPPSERVRELRT webapp_servlets_reloaded_count_per_min double 48
minute.

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row.


collection_source collection_source string 255 It can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within


producer_instance_id producer_instance_id string 255
a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id cmdb_id uuid should be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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.
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the 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 577
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

app_name string 255 lastval Application name

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager

The Average number of servlet sessions


servlet_session_invalidated_avg_count_per_s double 48 average
being invalidated per second.

The Minimum number of servlet sessions


servlet_session_invalidated_min_count_per_s double 48 min
being invalidated per second.

The Maximum number of servlet sessions


servlet_session_invalidated_max_count_per_s double 48 max
being invalidated per second.

The Average number of errors in a servlet


servlet_err_avg_count_per_s double 48 average
per second.

The Minimum number of errors in a


servlet_err_min_count_per_s double 48 min
servlet per second.

The Maximum number of errors in a


servlet_err_max_count_per_s double 48 max
servlet per second.

The Average number of servlets currently


webapp_servlets_loaded_avg_count_per_s double 48 average
loaded for a web application

The Minimum number of servlets currently


webapp_servlets_loaded_min_count_per_s double 48 min
loaded for a web application

The Maximum number of servlets


webapp_servlets_loaded_max_count_per_s double 48 max
currently loaded for a web application

The Average number of servlets reloaded


webapp_servlets_reloaded_avg_count_per_min average
for a web application per minute.

The Minimum number of servlets reloaded


webapp_servlets_reloaded_min_count_per_min min
for a web application per minute.

The Maximum number of servlets


webapp_servlets_reloaded_max_count_per_min max reloaded for a web application per
minute.

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval
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
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
collection_data_flow string 80 lastval producer provides data through an API 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 579
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
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"

A detailed description of the actual


collector that actively collects data. For
example: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any '.'
(Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example: +1,
+4.5, -8

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to 255
which the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to
tenant_id tenant_id string 255
apply row level access policies to control
access to data.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_app_instance websphere_app_instance string Instance of the Application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to
__count__ integer
build this particular record in the
aggregate destination table.

This field gives the timezone aware


timestamp at which this particular record
__update_time__ timestamp_tz in the aggregate destination table got last
updated by aggregation. The timestamp
will be in the Vertica server timezone.

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

app_name string 255 lastval Application name

port string 255 lastval Port

srv_name string 255 lastval Server name

domain_name string 255 lastval Domain Manager

The Average number of servlet sessions


servlet_session_invalidated_avg_count_per_s double 48 average
being invalidated per second.

The Minimum number of servlet sessions


servlet_session_invalidated_min_count_per_s double 48 min
being invalidated per second.

The Maximum number of servlet sessions


servlet_session_invalidated_max_count_per_s double 48 max
being invalidated per second.

The Average number of errors in a servlet


servlet_err_avg_count_per_s double 48 average
per second.

The Minimum number of errors in a


servlet_err_min_count_per_s double 48 min
servlet per second.

The Maximum number of errors in a


servlet_err_max_count_per_s double 48 max
servlet per second.

The Average number of servlets currently


webapp_servlets_loaded_avg_count_per_s double 48 average
loaded for a web application

The Minimum number of servlets currently


webapp_servlets_loaded_min_count_per_s double 48 min
loaded for a web application

The Maximum number of servlets


webapp_servlets_loaded_max_count_per_s double 48 max
currently loaded for a web application

The Average number of servlets reloaded


webapp_servlets_reloaded_avg_count_per_min double 48 average
for a web application per minute.

The Minimum number of servlets reloaded


webapp_servlets_reloaded_min_count_per_min double 48 min
for a web application per minute.

The Maximum number of servlets


webapp_servlets_reloaded_max_count_per_min double 48 max reloaded for a web application per
minute.

Indicates the type of the data producer


producer_instance_type string 50 lastval
that ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data


producer_instance_id string 255 lastval
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
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
collection_data_flow string 80 lastval producer provides data through an API 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 581
AI Operations Management - Containerized 24.4

Aggregation
Column Name Data Type Size Description
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"

A detailed description of the actual


collector that actively collects data. For
example: "SiteScope Streaming",
collection_type string 255 lastval "Operations Agent Streaming", "Collection
Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

IPV4 address of the server being


node_ipv4_address string 50 lastval
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.

IP Type of the monitored node (IPV4 or


node_ip_type string 80 lastval
IPV6).

Short name of the server being


node_short_name string 255 lastval monitored. Name must not contain any '.'
(Period) character.

Time zone offset to UTC in hours of the


node_timezone_offset_h string 80 lastval server being monitored. For example: +1,
+4.5, -8

The fully qualified hostname of the server


node_fqdn node_fqdn string being monitored. That is the server to 255
which the data belongs

This field holds the tenant id to which the


row in dataset belongs to. Needed to
tenant_id tenant_id string 255
apply row level access policies to control
access to data.

The start time of the aggregation period


timestamp_utc_s timestamp_utc_s integer 24
in UNIX epoch format in seconds

websphere_app_instance websphere_app_instance string Instance of the Application 255

websphere_srv_instance websphere_srv_instance string Instance of the server 255

The start time of the aggregation period


in timestamp format. Aggregation is
timestamp_tz timestamp 26 average
performed based on Vertica timezone, so
this value will be in Vertica timezone

This field gives the number of source table


records considered for aggregation to
__count__ integer
build this particular record in the
aggregate destination table.

This field gives the timezone aware


timestamp at which this particular record
__update_time__ timestamp_tz in the aggregate destination table got last
updated by aggregation. The timestamp
will be in the Vertica server timezone.

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

1.4.2.2. Management Pack for Jboss Application


Server
This section provides you information about the Management Pack for Jboss Application Server:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_jboss_appstatus Not available Not available

opsb_jboss_availability opsb_jboss_availability_1h opsb_jboss_availability_1d

opsb_jboss_gc opsb_jboss_gc_1h opsb_jboss_gc_1d

opsb_jboss_j2eeejbmsg opsb_jboss_j2eeejbmsg_1h opsb_jboss_j2eeejbmsg_1d

opsb_jboss_j2eeejbstful opsb_jboss_j2eeejbstful_1h opsb_jboss_j2eeejbstful_1d

opsb_jboss_j2eeejbstless opsb_jboss_j2eeejbstless_1h opsb_jboss_j2eeejbstless_1d

opsb_jboss_j2eeservlet opsb_jboss_j2eeservlet_1h opsb_jboss_j2eeservlet_1d

opsb_jboss_j2eewebapp opsb_jboss_j2eewebapp_1h opsb_jboss_j2eewebapp_1d

opsb_jboss_jarejbmessage opsb_jboss_jarejbmessage_1h opsb_jboss_jarejbmessage_1d

opsb_jboss_jarejbstateful opsb_jboss_jarejbstateful_1h opsb_jboss_jarejbstateful_1d


Not available
opsb_jboss_jarejbstateles opsb_jboss_jarejbstateles_1h opsb_jboss_jarejbstateles_1d

opsb_jboss_jdbc opsb_jboss_jdbc_1h opsb_jboss_jdbc_1d

opsb_jboss_jdbcpool opsb_jboss_jdbcpool_1h opsb_jboss_jdbcpool_1d

opsb_jboss_jmsqueue opsb_jboss_jmsqueue_1h opsb_jboss_jmsqueue_1d

opsb_jboss_jmstopic opsb_jboss_jmstopic_1h opsb_jboss_jmstopic_1d

opsb_jboss_jvm opsb_jboss_jvm_1h opsb_jboss_jvm_1d

opsb_jboss_transactions opsb_jboss_transactions_1h opsb_jboss_transactions_1d

opsb_jboss_webapp opsb_jboss_webapp_1h opsb_jboss_webapp_1d

opsb_jboss_webconhttp opsb_jboss_webconhttp_1h opsb_jboss_webconhttp_1d

opsb_jboss_webservlet opsb_jboss_webservlet_1h opsb_jboss_webservlet_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 Server name

APPLICATIONNAME app_name string 255 Deployed Application name on this server

The current runtime status of a deployment. Possible status modes are


OK(5), FAILED(0), and STOPPED(0) initializing(5) , initialized(5) ,error( 0
APPLICATIONSTATUS app_status integer 24 ),destroy (0) , destroying (0) indicates a dependency is missing or a service
could not start. STOPPED indicates that the deployment was not enabled or
was manually 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

The current state of the server controller; either STARTING(3.0),


SERVERSTATUS srv_status integer 24 RUNNING(3.0), RESTART_REQUIRED(1.0), RELOAD_REQUIRED (1.0)
,STOPPING(0.0) , UNKNOWN(2), STOPPED/NOT_RUNNING(2)

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

srv_name_id string 255 JBoss Server name

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBoss uniquely identify each server based on server host , server port and
JBOSSINST jboss_srv_instance_name string 255
server name

SERVERNAME srv_name string 255 JBoss Server name

The time duration (in minutes) in an hour when the AD service is in


null uptime_min double
running state.

The percentage of time in an hour when the AD service is in running


null uptime_pct double
state.

The time duration (in minutes) in an hour when the AD service is not in
null downtime_min double
running state.

The percentage of time in an hour when the AD service is not in running


null downtime_pct double
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.

The percentage of time in an hour when the AD service state information


null unknown_time_pct double
not available due to unknown outage.

Timestamp with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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
collection_data_flow collection_data_flow string 80
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
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 587
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 Server name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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_name_id string 255 The name representing this garbage collector

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

srv_name string 255 lastval Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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_name_id string 255 The name representing this garbage collector

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSS instance with server host, server port are uniquely


JBOSSINST jboss_srv_instance_name string 255
identified

SERVERNAME srv_name string 255 Server name

MESSAGEBEANNAME msg_bean_name string 255 Name of the message driven bean

Name of the deployed jar where the message driven bean


EJBJARNAME ejb_jar_name string 255
present

Name of the deployed ear where the message driven bean


J2EEAPPEARNAME ejb_ear_name string 255
present

STATELESSAVAILCT available_pool_instance_count integer 24 The number of available (i.e. not in use) instances in the pool

The number of bean instances that have been created per


STATELESSCREATECTRT bean_instance_created_count_per_s double 24
second

The number of bean instances that have been removed per


STATELESSREMOVECTRT bean_instance_removed_count_per_s double 24
second

STATELESSCURSIZE pool_curr_req_count integer 24 The current size of the pool

STATELESSMAXSIZE pool_max_req_count integer 24 The maximum size of 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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to 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 592
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

srv_name string 255 lastval Server name

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

pool_curr_req_avg_count integer 24 average The Average current size of the pool

pool_curr_req_min_count integer 24 min The Minimum current size of the pool

pool_curr_req_max_count integer 24 max The Maximum current size of the pool

pool_max_req_count lastval The maximum size of the pool

pool_max_req_avg_count average The Average maximum size of the pool

pool_max_req_max_count max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

msg_bean_name_id string 255 Name of the message driven bean

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

srv_name string 255 lastval Server name

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

pool_curr_req_avg_count integer 24 average The Average current size of the pool

pool_curr_req_min_count integer 24 min The Minimum current size of the pool

pool_curr_req_max_count integer 24 max The Maximum current size of the pool

pool_max_req_count integer 24 lastval The maximum size of the pool

pool_max_req_avg_count integer 24 average The Average maximum size of the pool

pool_max_req_max_count integer 24 max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

msg_bean_name_id string 255 Name of the message driven bean

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSS instance with server host, server port are uniquely


JBOSSINST jboss_srv_instance_name string 255
identified

SERVERNAME srv_name string 255 Server name

STATELESSBEANNAME bean_name string 255 Name of the Stateful session Bean

Name of the deployed jar where the stateful session bean bean
EJBJARNAME ejb_jar_name string 255
present

Name of the deployed ear where the stateful session bean


J2EEAPPEARNAME ejb_ear_name string 255
present

STATEFULTOTALSIZE bean_total_count integer 24 Total number of size of Stateful session bean

STATEFULCACHESIZE bean_cache_count double 24 Cache size of the stateful session bean

STATEFULPASSIVECOUNT passive_bean_count double 24 Passivated count of the stateful session bean

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

Time spend waiting to obtain an instance of the stateful bean


STATEFULWAITTIMERT wait_time_per_s integer 24
per second

STATEFULPEAKCONINVO peak_concurr_invocations_count integer 24 Peak concurrent invocations 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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

srv_name string 255 lastval Server name

bean_total_count integer 24 lastval Total number of size of Stateful session bean

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_count double 24 lastval Cache size of the 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_count double 24 lastval Passivated count 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

The Average time spend waiting to obtain an instance of the stateful


wait_time_avg_ms integer 24 average
bean

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_min_ms integer 24 min
bean

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_max_ms integer 24 max
bean

The Average time spend waiting to obtain an instance of the stateful


wait_time_per_avg_s integer 24 average
bean per second

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_per_min_s integer 24 min
bean per second

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_per_max_s integer 24 max
bean per second

peak_concurr_invocations_count integer 24 lastval Peak concurrent invocations of 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

The Average peak concurrent invocations of the stateful bean Per


peak_concurr_invocation_avg_count_per_s integer 24 average
Second

The Minimum peak concurrent invocations of the stateful bean Per


peak_concurr_invocation_min_count_per_s integer 24 min
Second

The Maximum peak concurrent invocations of the stateful bean Per


peak_concurr_invocation_max_count_per_s integer 24 max
Second

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Name of the Stateful session Bean

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

srv_name string 255 lastval Server name

bean_total_count integer 24 lastval Total number of size of Stateful session bean

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_count double 24 lastval Cache size of the 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_count double 24 lastval Passivated count 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

The Average time spend waiting to obtain an instance of the stateful


wait_time_avg_ms integer 24 average
bean

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_min_ms integer 24 min
bean

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_max_ms integer 24 max
bean

The Average time spend waiting to obtain an instance of the stateful


wait_time_per_avg_s integer 24 average
bean per second

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_per_min_s integer 24 min
bean per second

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_per_max_s integer 24 max
bean per second

peak_concurr_invocations_count integer 24 lastval Peak concurrent invocations of 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

The Average peak concurrent invocations of the stateful bean Per


peak_concurr_invocation_avg_count_per_s integer 24 average
Second

The Minimum peak concurrent invocations of the stateful bean Per


peak_concurr_invocation_min_count_per_s integer 24 min
Second

The Maximum peak concurrent invocations of the stateful bean Per


peak_concurr_invocation_max_count_per_s integer 24 max
Second

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Name of the Stateful session Bean

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSS instance with server host, server port are uniquely


JBOSSINST jboss_srv_instance_name string 255
identified

SERVERNAME srv_name string 255 Server name

STATELESSBEANNAME bean_name string 255 Stateless Session Bean Name

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

The number of bean instances that have been created per


STATELESSCREATECTRT bean_instance_created_count_per_s double 24
second

The number of bean instances that have been removed per


STATELESSREMOVECTRT bean_instance_removed_count_per_s double 24
second

STATELESSCURSIZE pool_curr_req_count integer 24 The current size of the pool of stateless session bean

STATELESSMAXSIZE pool_max_req_count integer 24 The maximum size of 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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the 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 604
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

srv_name string 255 lastval Server name

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

pool_max_req_count lastval The maximum size of the pool

pool_max_req_avg_count average The Average maximum size of the pool

pool_max_req_max_count max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Stateless Session Bean Name

ejb_ear_name_id string 255 Stateless Session Bean Deployed EAR Name

ejb_jar_name_id string 255 Stateless Session Bean Deployed JAR Name

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

srv_name string 255 lastval Server name

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

pool_max_req_count integer 24 lastval The maximum size of the pool

pool_max_req_avg_count integer 24 average The Average maximum size of the pool

pool_max_req_max_count integer 24 max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Stateless Session Bean Name

ejb_ear_name_id string 255 Stateless Session Bean Deployed EAR Name

ejb_jar_name_id string 255 Stateless Session Bean Deployed JAR Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 Server name

SERVLETNAME servlet_name string 255 Name of the servlet

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

SERVLETREQUESTCOUNT servlet_req_count integer 24 Number of all requests for 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC-DL. Pull:Data producer provides
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

srv_name string 255 lastval Server name

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_count integer 24 lastval Number of all requests for 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

servlet_name_id string 255 Name of the servlet

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

srv_name string 255 lastval Server name

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_count integer 24 lastval Number of all requests for 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

servlet_name_id string 255 Name of the servlet

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBoss uniquely identify each server based on server host , server port and
JBOSSINST jboss_srv_instance_name string 255
server name

SERVERNAME srv_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

ACTIVESESSIONS active_sessions_count integer 24 Number of active sessions

SESSIONSCREATED sessions_created_count integer 24 Total number of sessions created

EXPIREDSESSIONS expired_sessions_count integer 24 Total number of sessions that have expired

REJECTEDSESSIONS rejected_sessions_count integer 24 Total number of rejected sessions

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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 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

srv_name string 255 lastval Server name

active_sessions_count integer 24 lastval Number of active sessions

active_sessions_avg_count integer 24 average The Average number of active sessions

active_sessions_min_count integer 24 min The Minimum number of active sessions

active_sessions_max_count integer 24 max The Maximum number of active sessions

sessions_created_count integer 24 lastval Total number of sessions created

sessions_created_avg_count integer 24 average The Average total number of sessions created

sessions_created_min_count integer 24 min The Minimum total number of sessions created

sessions_created_max_count integer 24 max The Maximum total number of sessions created

expired_sessions_count integer 24 lastval Total number of sessions that have expired

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

rejected_sessions_count integer 24 lastval Total number of rejected sessions

rejected_sessions_avg_count integer 24 average The Average total number of rejected sessions

rejected_sessions_min_count integer 24 min The Minimum total number of rejected sessions

rejected_sessions_max_count integer 24 max The Maximum total number of rejected sessions

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

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval Server name

active_sessions_count integer 24 lastval Number of active sessions

active_sessions_avg_count integer 24 average The Average number of active sessions

active_sessions_min_count integer 24 min The Minimum number of active sessions

active_sessions_max_count integer 24 max The Maximum number of active sessions

sessions_created_count integer 24 lastval Total number of sessions created

sessions_created_avg_count integer 24 average The Average total number of sessions created

sessions_created_min_count integer 24 min The Minimum total number of sessions created

sessions_created_max_count integer 24 max The Maximum total number of sessions created

expired_sessions_count integer 24 lastval Total number of sessions that have expired

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

rejected_sessions_count integer 24 lastval Total number of rejected sessions

rejected_sessions_avg_count integer 24 average The Average total number of rejected sessions

rejected_sessions_min_count integer 24 min The Minimum total number of rejected sessions

rejected_sessions_max_count integer 24 max The Maximum total number of rejected sessions

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSS instance with server host, server port are uniquely


JBOSSINST jboss_srv_instance_name string 255
identified

SERVERNAME srv_name string 255 Server name

MESSAGEBEANNAME msg_bean_name string 255 Name of the message driven bean

Name of the deployed jar where the message driven bean


EJBJARNAME ejb_jar_name string 255
present

STATELESSAVAILCT available_pool_instance_count integer 24 The number of available (i.e. not in use) instances in the pool

The number of bean instances that have been created per


STATELESSCREATECTRT bean_instance_created_count_per_s double 24
second

The number of bean instances that have been removed per


STATELESSREMOVECTRT bean_instance_removed_count_per_s double 24
second

STATELESSCURSIZE pool_curr_req_count integer 24 The current size of the pool

STATELESSMAXSIZE pool_max_req_count integer 24 The maximum size of 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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the 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 620
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

srv_name string 255 lastval Server name

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

pool_curr_req_avg_count integer 24 average The Average current size of the pool

pool_curr_req_min_count integer 24 min The Minimum current size of the pool

pool_curr_req_max_count integer 24 max The Maximum current size of the pool

pool_max_req_count lastval The maximum size of the pool

pool_max_req_avg_count average The Average maximum size of the pool

pool_max_req_max_count max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

msg_bean_name_id string 255 Name of the message driven bean

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

srv_name string 255 lastval Server name

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

pool_curr_req_avg_count integer 24 average The Average current size of the pool

pool_curr_req_min_count integer 24 min The Minimum current size of the pool

pool_curr_req_max_count integer 24 max The Maximum current size of the pool

pool_max_req_count integer 24 lastval The maximum size of the pool

pool_max_req_avg_count integer 24 average The Average maximum size of the pool

pool_max_req_max_count integer 24 max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

msg_bean_name_id string 255 Name of the message driven bean

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSS instance with server host, server port are uniquely


JBOSSINST jboss_srv_instance_name string 255
identified

SERVERNAME srv_name string 255 JBoss Server name

STATELESSBEANNAME bean_name string 255 Name of the Stateful session Bean

Name of the deployed jar where the stateful session bean bean
EJBJARNAME ejb_jar_name string 255
present

STATEFULTOTALSIZE bean_total_count integer 24 Total number of size of Stateful session bean

STATEFULCACHESIZE bean_cache_count double 24 Cache size of the stateful session bean

STATEFULPASSIVECOUNT bean_passivated_count double 24 Passivated count of the stateful session bean

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

Time spend waiting to obtain an instance of the stateful bean


STATEFULWAITTIMERT wait_time_per_s integer 24
per second

STATEFULPEAKCONINVO peak_concurr_invocations_count integer 24 Peak concurrent invocations of the statefulbean

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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming", "Operations
collection_type collection_type string 255
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 626
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

srv_name string 255 lastval JBoss Server name

bean_total_count integer 24 lastval Total number of size of Stateful session bean

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_count double 24 lastval Cache size of the 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_count double 24 lastval Passivated count 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

The Average time spend waiting to obtain an instance of the stateful


wait_time_avg_ms integer 24 average
bean

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_min_ms integer 24 min
bean

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_max_ms integer 24 max
bean

The Average time spend waiting to obtain an instance of the stateful


wait_time_per_avg_s integer 24 average
bean per second

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_per_min_s integer 24 min
bean per second

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_per_max_s integer 24 max
bean per second

peak_concurr_invocations_count integer 24 lastval Peak concurrent invocations of the statefulbean

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

The Minimum peak concurrent invocations of the statefulbean Per


peak_concurr_invocation_min_count_per_s integer 24 min
Second

The Maximum peak concurrent invocations of the statefulbean Per


peak_concurr_invocation_max_count_per_s integer 24 max
Second

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Name of the Stateful session Bean

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

srv_name string 255 lastval JBoss Server name

bean_total_count integer 24 lastval Total number of size of Stateful session bean

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_count double 24 lastval Cache size of the 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_count double 24 lastval Passivated count 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

The Average time spend waiting to obtain an instance of the stateful


wait_time_avg_ms integer 24 average
bean

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_min_ms integer 24 min
bean

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_max_ms integer 24 max
bean

The Average time spend waiting to obtain an instance of the stateful


wait_time_per_avg_s integer 24 average
bean per second

The Minimum time spend waiting to obtain an instance of the stateful


wait_time_per_min_s integer 24 min
bean per second

The Maximum time spend waiting to obtain an instance of the stateful


wait_time_per_max_s integer 24 max
bean per second

peak_concurr_invocations_count integer 24 lastval Peak concurrent invocations of the statefulbean

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

The Minimum peak concurrent invocations of the statefulbean Per


peak_concurr_invocation_min_count_per_s integer 24 min
Second

The Maximum peak concurrent invocations of the statefulbean Per


peak_concurr_invocation_max_count_per_s integer 24 max
Second

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Name of the Stateful session Bean

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSS instance with server host, server port are uniquely


JBOSSINST jboss_srv_instance_name string 255
identified

SERVERNAME srv_name string 255 JBoss Server name

STATELESSBEANNAME bean_name string 255 Stateless Session Bean Name

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

The number of bean instances that have been removed per


STATELESSREMOVECTRT bean_instance_removed_count_per_s double 24
second

STATELESSCURSIZE pool_curr_req_count integer 24 The current size of the pool of stateless session bean

STATELESSMAXSIZE pool_max_req_count integer 24 The maximum size of 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

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 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 632
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

srv_name string 255 lastval JBoss Server name

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

pool_max_req_count lastval The maximum size of the pool

pool_max_req_avg_count average The Average maximum size of the pool

pool_max_req_max_count max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Stateless Session Bean Name

ejb_name_id string 255 Stateless Session Bean Deployed JAR Name

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

srv_name string 255 lastval JBoss Server name

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

pool_max_req_count integer 24 lastval The maximum size of the pool

pool_max_req_avg_count integer 24 average The Average maximum size of the pool

pool_max_req_max_count integer 24 max The Maximum maximum size of the pool

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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.

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

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

bean_name_id string 255 Stateless Session Bean Name

ejb_name_id string 255 Stateless Session Bean Deployed JAR Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

DATASOURCENAME jdbc_ds_name string 255 Name of the JDBC datasource

JDBCPRPDSTCACHACCCNT cache_access_count integer 24 The number of times that the statement cache was accessed

The number of prepared and callable statements currently cached in the


JDBCPRPDSTCACHCURCNT cache_curr_count integer 24
statement cache

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

srv_name string 255 lastval JBoss Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jdbc_ds_name_id string 255 Name of the JDBC datasource

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

srv_name string 255 lastval JBoss Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jdbc_ds_name_id string 255 Name of the JDBC datasource

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

DATASOURCENAME jdbc_ds_name string 255 Name of the JDBC datasource

JDBCPOOLACTIVECT pool_active_count integer 24 The pool active count of the datasource

JDBCPOOLAVAILABLECT pool_available_count integer 24 The pool available count of the datasource

JDBCPOOLCREATEDCT pool_created_count integer 24 The pool created count of the datasource

JDBCPOOLINUSECT physical_conn_in_use_count integer 24 The number of physical connections currently in use in datasource

JDBCPOOLMAXUSEDCT max_conn_used_count integer 24 The maximum number of connections used in datasource

JDBCPOOLDESTROYEDCT pool_destroyed_count integer 24 The pool The destroyed count in datasource

The number of physical connections currently in use in datasource in


JDBCPOOLINUSEPCT physical_conn_in_use_pct double 24
percentage

This metric monitors the percentage utilization of available JDBC


JDBCCONNPOOLTHRURT pool_conn_count_per_s double 24
connections in connection pool 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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
collection_data_flow collection_data_flow string 80
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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 644
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

pool_active_count integer 24 lastval The pool active count of the datasource

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_count integer 24 lastval The pool available 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_count integer 24 lastval The pool created 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_count integer 24 lastval The maximum number of connections used 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_count integer 24 lastval The pool The destroyed count 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 number of physical connections currently in use in datasource in


physical_conn_in_use_avg_pct double 24 average
percentage

The Minimum number of physical connections currently in use in datasource in


physical_conn_in_use_min_pct double 24 min
percentage

The Maximum number of physical connections currently in use in datasource in


physical_conn_in_use_max_pct double 24 max
percentage

The Percentile of the number of physical connections currently in use in


physical_conn_in_use_pctl_pct double 24 90 percentile
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jdbc_ds_name_id string 255 Name of the JDBC datasource

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

srv_name string 255 lastval JBoss Server name

pool_active_count integer 24 lastval The pool active count of the datasource

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_count integer 24 lastval The pool available 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_count integer 24 lastval The pool created 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_count integer 24 lastval The maximum number of connections used 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_count integer 24 lastval The pool The destroyed count 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 number of physical connections currently in use in datasource in


physical_conn_in_use_avg_pct double 24 average
percentage

The Minimum number of physical connections currently in use in datasource in


physical_conn_in_use_min_pct double 24 min
percentage

The Maximum number of physical connections currently in use in datasource in


physical_conn_in_use_max_pct double 24 max
percentage

The Percentile of the number of physical connections currently in use in


physical_conn_in_use_pctl_pct double 24 90 percentile
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jdbc_ds_name_id string 255 Name of the JDBC datasource

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

JMSQUEUENAME jms_que_name string 255 The name of jms queue

The number of messages that this queue is currently delivering to its


JMSDELIVERINGCNT delivering_msgs_count integer 24
consumers

JMSSCHEDULEDCNT scheduled_msgs_count integer 24 The number of scheduled messages in this queue

JMSCONSUMERCNT consumer_count integer 24 The number of consumers consuming messages from this queue

JMSMESSAGECNT que_msg_count integer 24 The number of messages currently in 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

srv_name string 255 lastval JBoss Server name

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_count integer 24 lastval The number of scheduled messages in this queue

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_count integer 24 lastval The number of messages currently in 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

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jms_que_name_id string 255 The name of jms queue

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

srv_name string 255 lastval JBoss Server name

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_count integer 24 lastval The number of scheduled messages in this queue

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_count integer 24 lastval The number of messages currently in 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

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jms_que_name_id string 255 The name of jms queue

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

JMSTOPICNAME jms_topic_name string 255 Name of the JMS Topic

The number of messages that this queue is currently delivering to its


JMSDELIVERINGCNT delivering_msgs_count integer 24
consumers

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

JMSMESSAGECNT que_msg_count integer 24 The number of messages currently in this queue

JMSMESSAGESADDED que_msgs_added_count integer 24 The number of messages added to this queue since it was created

The percentage of messages for all non-durable subscribers for this


JMSNONDURMSGCNT non_durable_msg_count integer 24
topic

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to 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 656
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

The number of messages that this queue is currently delivering to its


delivering_msgs_count integer 24 lastval
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


delivering_msgs_min_count integer 24 min
its consumers

The Maximum number of messages that this queue is currently delivering to


delivering_msgs_max_count integer 24 max
its 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_count integer 24 lastval The number of messages currently in 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

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jms_topic_name_id string 255 Name of the JMS Topic

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

srv_name string 255 lastval JBoss Server name

The number of messages that this queue is currently delivering to its


delivering_msgs_count integer 24 lastval
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


delivering_msgs_min_count integer 24 min
its consumers

The Maximum number of messages that this queue is currently delivering to


delivering_msgs_max_count integer 24 max
its 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_count integer 24 lastval The number of messages currently in 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

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

jms_topic_name_id string 255 Name of the JMS Topic

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

TRANSACTIONSABORTED aborted_txn_count integer 24 The number of aborted (i.e. rolled back) transactions.

The number of transactions that have been rolled back by application


TRANAPPROLLBACKS app_rollbacks_count integer 24 request. This includes those that timeout, since the timeout behaviour is
considered an attribute of the application configuration

TRANCOMMITTED committed_txns_count integer 24 The number of committed 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

The number of transactions that rolled back due to resource (participant)


TRANRESOUCEROLLBACKS resource_rollbacks_count integer 24
failure

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

The percent of transactions that rolled back due to resource (participant)


TRANRESROLLBACKSPCT resource_rollbacks_pct double 24
failure

The percent of transactions that have been rolled back by application


TRANAPPROLLBACKSPCT app_rollbacks_pct double 24 request. This includes those that timeout, since the timeout behaviour is
considered an attribute of the application configuration

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Metric Name/Global Data


Column Name Size Description
Name Type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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

committed_txns_count integer 24 lastval The number of committed transactions

committed_txns_avg_count integer 24 average The Average number of committed transactions

committed_txns_min_count integer 24 min The Minimum number of committed transactions

committed_txns_max_count integer 24 max The Maximum number of committed transactions

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

The Maximum number of transactions which have terminated with heuristic


heuristics_max_count integer 24 max
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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

committed_txns_count integer 24 lastval The number of committed transactions

committed_txns_avg_count integer 24 average The Average number of committed transactions

committed_txns_min_count integer 24 min The Minimum number of committed transactions

committed_txns_max_count integer 24 max The Maximum number of committed transactions

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

The Maximum number of transactions which have terminated with heuristic


heuristics_max_count integer 24 max
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

WEBAPPWARNAME web_app_war_name string 255 Name of the web application deployment war file

ACTIVESESSIONS active_sessions_count integer 24 Number of active sessions

SESSIONSCREATED sessions_created_count integer 24 Total sessions created

EXPIREDSESSIONS expired_sessions_count integer 24 Number of sessions that have expired

REJECTEDSESSIONS rejected_sessions_count integer 24 Number of rejected sessions

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

active_sessions_count integer 24 lastval Number of active sessions

active_sessions_avg_count integer 24 average The Average number of active sessions

active_sessions_min_count integer 24 min The Minimum number of active sessions

active_sessions_max_count integer 24 max The Maximum number of active sessions

sessions_created_count integer 24 lastval Total sessions created

sessions_created_avg_count integer 24 average The Average total sessions created

sessions_created_min_count integer 24 min The Minimum total sessions created

sessions_created_max_count integer 24 max The Maximum total sessions created

expired_sessions_count integer 24 lastval Number of sessions that have expired

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

rejected_sessions_count integer 24 lastval Number of rejected sessions

rejected_sessions_avg_count integer 24 average The Average number of rejected sessions

rejected_sessions_min_count integer 24 min The Minimum number of rejected sessions

rejected_sessions_max_count integer 24 max The Maximum number of rejected sessions

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

active_sessions_count integer 24 lastval Number of active sessions

active_sessions_avg_count integer 24 average The Average number of active sessions

active_sessions_min_count integer 24 min The Minimum number of active sessions

active_sessions_max_count integer 24 max The Maximum number of active sessions

sessions_created_count integer 24 lastval Total sessions created

sessions_created_avg_count integer 24 average The Average total sessions created

sessions_created_min_count integer 24 min The Minimum total sessions created

sessions_created_max_count integer 24 max The Maximum total sessions created

expired_sessions_count integer 24 lastval Number of sessions that have expired

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

rejected_sessions_count integer 24 lastval Number of rejected sessions

rejected_sessions_avg_count integer 24 average The Average number of rejected sessions

rejected_sessions_min_count integer 24 min The Minimum number of rejected sessions

rejected_sessions_max_count integer 24 max The Maximum number of rejected sessions

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

JBOSSINST jboss_srv_instance_name string 255 JBOSS instance with server host, server port are uniquely identified

SERVERNAME srv_name string 255 JBoss Server name

SERVLETNAME servlet_name string 255 Name of servlet

WEBAPPWARNAME web_app_war_name string 255 Name of the deployable war file where the servlet present

SERVLETMAXTIME max_req_processing_time_ms double 24 Maximal time for processing request

SERVLETMINTIME min_req_processing_time_ms double 24 Minimal time for processing request

SERVLETREQUESTCOUNT req_count integer 24 Number of all 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
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC-DL. Pull:Data producer provides
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

srv_name string 255 lastval JBoss Server name

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

req_count integer 24 lastval Number of all requests

req_avg_count integer 24 average The Average number of all requests

req_min_count integer 24 min The Minimum number of all requests

req_max_count integer 24 max The Maximum number of all 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

servlet_name_id string 255 Name of servlet

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

srv_name string 255 lastval JBoss Server name

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

req_count integer 24 lastval Number of all requests

req_avg_count integer 24 average The Average number of all requests

req_min_count integer 24 min The Minimum number of all requests

req_max_count integer 24 max The Maximum number of all 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

servlet_name_id string 255 Name of servlet

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

1.4.2.3. Management Pack for Microsoft Active


Directory
This section provides you information about the Management Pack for Microsoft Active Directory:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_ad_availability opsb_ad_availability_1h opsb_ad_availability_1d

opsb_ad_database_cache opsb_ad_database_cache_1h opsb_ad_database_cache_1d

opsb_ad_dfs_replicated_folder opsb_ad_dfs_replicated_folder_1h opsb_ad_dfs_replicated_folder_1d

opsb_ad_dfs_replication_conn opsb_ad_dfs_replication_conn_1h opsb_ad_dfs_replication_conn_1d

opsb_ad_directory_services opsb_ad_directory_services_1h opsb_ad_directory_services_1d

opsb_ad_dit_db_disk opsb_ad_dit_db_disk_1h opsb_ad_dit_db_disk_1d

opsb_ad_dit_db_filesize opsb_ad_dit_db_filesize_1h opsb_ad_dit_db_filesize_1d

opsb_ad_dit_log_disk opsb_ad_dit_log_disk_1h opsb_ad_dit_log_disk_1d

opsb_ad_dns opsb_ad_dns_1h opsb_ad_dns_1d

opsb_ad_federation_server opsb_ad_federation_server_1h opsb_ad_federation_server_1d

opsb_ad_fsmo opsb_ad_fsmo_1h opsb_ad_fsmo_1d

opsb_ad_fsmo_role_movement opsb_ad_fsmo_role_movement_1h opsb_ad_fsmo_role_movement_1d

opsb_ad_gc_replication opsb_ad_gc_replication_1h opsb_ad_gc_replication_1d


Not available
opsb_ad_khi_memory opsb_ad_khi_memory_1h opsb_ad_khi_memory_1d

opsb_ad_khi_network_interface opsb_ad_khi_network_interface_1h opsb_ad_khi_network_interface_1d

opsb_ad_khi_physical_disk opsb_ad_khi_physical_disk_1h opsb_ad_khi_physical_disk_1d

opsb_ad_khi_processor_info opsb_ad_khi_processor_info_1h opsb_ad_khi_processor_info_1d

opsb_ad_ntds opsb_ad_ntds_1h opsb_ad_ntds_1d

opsb_ad_ntds_process opsb_ad_ntds_process_1h opsb_ad_ntds_process_1d

opsb_ad_process opsb_ad_process_1h opsb_ad_process_1d

opsb_ad_replication_latency opsb_ad_replication_latency_1h opsb_ad_replication_latency_1d

opsb_ad_response_time opsb_ad_response_time_1h opsb_ad_response_time_1d

opsb_ad_service_health opsb_ad_service_health_1h opsb_ad_service_health_1d

opsb_ad_smb_conn_status opsb_ad_smb_conn_status_1h opsb_ad_smb_conn_status_1d

opsb_ad_sysvol opsb_ad_sysvol_1h opsb_ad_sysvol_1d

opsb_ad_trust opsb_ad_trust_1h opsb_ad_trust_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

SVRNAME dc_name string 255 Domain Controller

AVAILABILITY dc_availability integer 24 Indicates 1 if the Domain Controller is reachable, else, it is 0

GCAVAILABILITY gc_availability integer 24 Indicates 1 if the Global Catalog is reachable, else, it is 0

Indicates 1 if a Global Catalog is present on the Domain Controller, else it is


GCPRESENT gc_present integer 24
0

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

The Average percentage of time in an hour when the DC is unavailable due to


dc_unknown_time_avg_pct double avg
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dc_name_id string 255 Domain Controller

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

SVRNAME dc_name string 255 Domain Controller

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 DC is unavailable


null dc_planned_downtime_min double
due to server planned outage.

The percentage of time in an hour when the DC is unavailable due to


null dc_planned_downtime_pct double
server planned outage.

The time duration (in minutes) in an hour when the DC availablity is


null dc_unknown_time_min double
unknown due to unknown outage.

The percentage of time in an hour when the DC availablity is unknown


null dc_unknown_time_pct double
due to unknown outage.

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 percentage of time in an hour when the Global Catalog is


null gc_downtime_pct 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 percentage of time in an hour when the Global Catalog is


null gc_planned_downtime_pct 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.

The percentage of time in an hour when the Global Catalog availablity


null gc_unknown_time_pct double
is unknown due to unknown outage.

Timestamp with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Metric Name/Global Data


Column Name Size Description
Name Type

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME lsass_instance_name string 255 Instance name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

lsass_instance_name_id string 255 Instance name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

lsass_instance_name_id string 255 Instance name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME dfs_rep_folder_instance_name string 255 DFS Repliacted Folder Instance Name

The percentage of bandwidth that was saved by the DFS Replication


service for this replicated folder using a combination of remote
BANDWIDTH bandwidth_saving_pct string 255
differential compression (RDC) and other compression technologies that
minimize network bandwidth

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.

The number of files that were successfully received from sending


FILE_SUCCEDED file_installs_succeed_count string 255
members and installed locally on this server.

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.

The number of redundant file replication update records that were


UPDATESDROPPED file_rep_updates_drop_count string 255 ignored by the DFS Replication service because they did not change the
replicated file or 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dfs_rep_folder_instance_name_id string 255 DFS Repliacted Folder Instance 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dfs_rep_folder_instance_name_id string 255 DFS Repliacted Folder Instance 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME dfs_rep_conn_instance_name string 255 DFS Replication Connection Instance Name

The percentage of bandwidth that was saved by the DFS Replication


service for this connection using a combination of remote differential
BANDWIDTH bandwidth_savings_pct string 255
compression (RDC) and other compression technologies that minimize
network bandwidth use

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dfs_rep_conn_instance_name_id string 255 DFS Replication Connection Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dfs_rep_conn_instance_name_id string 255 DFS Replication Connection Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME dir_svc_instance_name string 255 The Directory Services Instance Name.

Number of objects received per second from


OBJECTS inbound_obj_count_per_s string 255
neighbors through inbound replication

OUTOBJECTS outbound_obj_count_per_s integer 24 Number of objects replicated out per second.

Number of sync requests made to the neighbors


SCHEMAMISMATCHCNT schema_mismatch_count string 255
that failed because their schema are out of sync.

Number of directory synchronizations that are


PENDINGREPSYNC pending_rep_sync_count string 255
queued for this server but not yet processed.

Original size in bytes of inbound compressed


INBOUNDBYTESCMP inbound_bytes_compressed_bps string 255 replication data per second(size before
compression, from DSAs in other sites).

Number of bytes replicated in that were not


INBOUNDBYTESNCMP inbound_bytes_noncompressed_bps string 255 compressed at the source per second (i.e., from
DSAs in the same site).

Number of object updates received in the current


INBOUNDOBJUPD inbound_obj_updates_remaining_count string 255 directory replication update packet that have not
yet been applied to the local server.

Number of pending update notifications that have


NOTIFYQUEUE notify_que_size_count string 255
been queued, but not yet transmitted to clients.

Current number of threads in use by the LDAP


LDAPACTIVTH ldap_active_threads_count string 255
subsystem of the local direcotry service.

Time (in milliseconds) taken for last successful


LDAPBINDTIME ldap_bind_time_ms string 255
LDAP bind.

LDAPCLIENTSES ldap_client_session_count string 255 Number of connected LDAP client sessions.

DIRECTORYWRITES dir_writes_count_per_s string 255 Number of directory writes per second.

DIRECTORYREADS dir_reads_count_per_s string 255 Number of directory reads per second.

DIRECTORYSEARCHES dir_searches_count_per_s string 255 Number of directory searches per second.

Number of net user and new local groups


OMESAMNTMEM sam_nontransitive_membership_eval_count_per_s string 255 evaluations per second when performing a non-
transitive membership evaluation

Number of objects remaining to examine while


SECDESC security_desc_propagator_runtime_que_count string 255 processing the current DS Security Descriptor
Propagator Event.

Number of new groups encountered per second


TWOSAMTRNMEM sam_transitive_membership_eval_count_per_s string 255 when performing a transitive membership
evaluation

The sample time field which holds value in unix


timestamp_utc timestamp_utc_s integer 24
epoch

The sample collection time field which holds value


timestamp_utc_collector timestamp_utc_collector_s integer 24
in unix epoch

Source of the Metric Collection that produced this


data row. It can be the name of hostname if the
collection_source collection_source string 255
source is AMC else if its empty it will be Agent
Streaming

This field holds the tenant id to which the row in


tenant_id tenant_id string 255 dataset belongs to. Needed to 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 712
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

Indicates the type of the data producer that


producer_instance_type producer_instance_type string 50
ingested the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer


producer_instance_id producer_instance_id string 255
instance within a producer type

Holds the local ID of the entity in UCMDB. [entity


cmdb_id cmdb_id uuid type] should be used 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 in the field name if
cmdb_global_id cmdb_global_id uuid
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 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
CollectionConfigName collection_policy_name string 255 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: "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


MonitoredSystem node_fqdn string 255 monitored. That is the server to which the data
belongs

IPV4 address of the server being monitored if using


node_ipv4_address node_ipv4_address string 50
IPV4.

The IP address of the monitored server. Encoded as


node_ipv6_address node_ipv6_address string 50 IPv6 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name


MonitoredSystemID node_short_name string 255
must not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For example: +1, +4.5, -8

Is the data received during downtime of related


null received_in_downtime boolean
entity

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

The Average number of objects received per second from


inbound_obj_avg_count_per_s string 255 average
neighbors through inbound replication

The Minimum number of objects received per second from


inbound_obj_min_count_per_s string 255 min
neighbors through inbound replication

The Maximum number of objects received per second from


inbound_obj_max_count_per_s string 255 max
neighbors through inbound replication

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.

The Average number of sync requests made to the


schema_mismatch_avg_count string 255 average
neighbors that failed because their schema are out of sync.

The Minimum number of sync requests made to the


schema_mismatch_min_count string 255 min
neighbors that failed because their schema are out of sync.

The Maximum number of sync requests made to the


schema_mismatch_max_count string 255 max
neighbors that failed because their schema are out of sync.

The Average number of directory synchronizations that are


pending_rep_sync_avg_count string 255 average
queued for this server but not yet processed.

The Minimum number of directory synchronizations that are


pending_rep_sync_min_count string 255 min
queued for this server but not yet processed.

The Maximum number of directory synchronizations that are


pending_rep_sync_max_count string 255 max
queued for this server but not yet processed.

The Average original size in bytes of inbound compressed


inbound_bytes_compressed_avg_bps string 255 average replication data per second(size before compression, from
DSAs in other sites).

The Minimum original size in bytes of inbound compressed


inbound_bytes_compressed_min_bps string 255 min replication data per second(size before compression, from
DSAs in other sites).

The Maximum original size in bytes of inbound compressed


inbound_bytes_compressed_max_bps string 255 max replication data per second(size before compression, from
DSAs in other sites).

The Average number of bytes replicated in that were not


inbound_bytes_noncompressed_avg_bps string 255 average compressed at the source per second (i.e., from DSAs in the
same site).

The Minimum number of bytes replicated in that were not


inbound_bytes_noncompressed_min_bps string 255 min compressed at the source per second (i.e., from DSAs in the
same site).

The Maximum number of bytes replicated in that were not


inbound_bytes_noncompressed_max_bps string 255 max compressed at the source per second (i.e., from DSAs in the
same site).

The Average number of object updates received in the


inbound_obj_updates_remaining_avg_count string 255 average current directory replication update packet that have not yet
been applied to the local server.

The Minimum number of object updates received in the


inbound_obj_updates_remaining_min_count string 255 min current directory replication update packet that have not yet
been applied to the local server.

The Maximum number of object updates received in the


inbound_obj_updates_remaining_max_count string 255 max current directory replication update packet that have not yet
been applied to the local server.

The Average number of pending update notifications that


notify_que_size_avg_count string 255 average
have been queued, but not yet transmitted to clients.

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

The Minimum number of pending update notifications that


notify_que_size_min_count string 255 min
have been queued, but not yet transmitted to clients.

The Maximum number of pending update notifications that


notify_que_size_max_count string 255 max
have been queued, but not yet transmitted to clients.

The Average current number of threads in use by the LDAP


ldap_active_threads_avg_count string 255 average
subsystem of the local direcotry service.

The Minimum current number of threads in use by the LDAP


ldap_active_threads_min_count string 255 min
subsystem of the local direcotry service.

The Maximum current number of threads in use by the LDAP


ldap_active_threads_max_count string 255 max
subsystem of the local direcotry service.

The Average time (in milliseconds) taken for last successful


ldap_bind_time_avg_ms string 255 average
LDAP bind.

The Minimum time (in milliseconds) taken for last successful


ldap_bind_time_min_ms string 255 min
LDAP bind.

The Maximum time (in milliseconds) taken for last


ldap_bind_time_max_ms string 255 max
successful LDAP bind.

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.

The Average number of net user and new local groups


sam_nontransitive_membership_eval_avg_count_per_s string 255 average evaluations per second when performing a non-transitive
membership evaluation

The Minimum number of net user and new local groups


sam_nontransitive_membership_eval_min_count_per_s string 255 min evaluations per second when performing a non-transitive
membership evaluation

The Maximum number of net user and new local groups


sam_nontransitive_membership_eval_max_count_per_s string 255 max evaluations per second when performing a non-transitive
membership evaluation

The Average number of objects remaining to examine while


security_desc_propagator_runtime_que_avg_count string 255 average processing the current DS Security Descriptor Propagator
Event.

The Minimum number of objects remaining to examine while


security_desc_propagator_runtime_que_min_count string 255 min processing the current DS Security Descriptor Propagator
Event.

The Maximum number of objects remaining to examine


security_desc_propagator_runtime_que_max_count string 255 max while processing the current DS Security Descriptor
Propagator Event.

The Average number of new groups encountered per second


sam_transitive_membership_eval_avg_count_per_s string 255 average
when performing a transitive membership evaluation

The Minimum number of new groups encountered per


sam_transitive_membership_eval_min_count_per_s string 255 min
second when performing a transitive membership evaluation

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

The Maximum number of new groups encountered per


sam_transitive_membership_eval_max_count_per_s string 255 max
second when performing a transitive membership evaluation

Indicates the type of the data producer that ingested the


producer_instance_type string 50 lastval
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within


producer_instance_id string 255 lastval
a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id uuid lastval should be used 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]


cmdb_global_id uuid lastval should be used in 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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "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


node_ipv6_address string 50 lastval format. Fully specified ipv6 format without any simplification
rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

ad_server_fqdn_id string 255 AD Server

dir_svc_instance_name_id string 255 The Directory Services Instance Name.

The fully qualified hostname of the server being monitored.


node_fqdn_id string 255
That is the server to which the data belongs

This field holds the tenant id to which the row in dataset


tenant_id_id string 255 belongs 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 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

The Average number of objects received per second from


inbound_obj_avg_count_per_s string 255 average
neighbors through inbound replication

The Minimum number of objects received per second from


inbound_obj_min_count_per_s string 255 min
neighbors through inbound replication

The Maximum number of objects received per second from


inbound_obj_max_count_per_s string 255 max
neighbors through inbound replication

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.

The Average number of sync requests made to the


schema_mismatch_avg_count string 255 average
neighbors that failed because their schema are out of sync.

The Minimum number of sync requests made to the


schema_mismatch_min_count string 255 min
neighbors that failed because their schema are out of sync.

The Maximum number of sync requests made to the


schema_mismatch_max_count string 255 max
neighbors that failed because their schema are out of sync.

The Average number of directory synchronizations that are


pending_rep_sync_avg_count string 255 average
queued for this server but not yet processed.

The Minimum number of directory synchronizations that are


pending_rep_sync_min_count string 255 min
queued for this server but not yet processed.

The Maximum number of directory synchronizations that are


pending_rep_sync_max_count string 255 max
queued for this server but not yet processed.

The Average original size in bytes of inbound compressed


inbound_bytes_compressed_avg_bps string 255 average replication data per second(size before compression, from
DSAs in other sites).

The Minimum original size in bytes of inbound compressed


inbound_bytes_compressed_min_bps string 255 min replication data per second(size before compression, from
DSAs in other sites).

The Maximum original size in bytes of inbound compressed


inbound_bytes_compressed_max_bps string 255 max replication data per second(size before compression, from
DSAs in other sites).

The Average number of bytes replicated in that were not


inbound_bytes_noncompressed_avg_bps string 255 average compressed at the source per second (i.e., from DSAs in the
same site).

The Minimum number of bytes replicated in that were not


inbound_bytes_noncompressed_min_bps string 255 min compressed at the source per second (i.e., from DSAs in the
same site).

The Maximum number of bytes replicated in that were not


inbound_bytes_noncompressed_max_bps string 255 max compressed at the source per second (i.e., from DSAs in the
same site).

The Average number of object updates received in the


inbound_obj_updates_remaining_avg_count string 255 average current directory replication update packet that have not yet
been applied to the local server.

The Minimum number of object updates received in the


inbound_obj_updates_remaining_min_count string 255 min current directory replication update packet that have not yet
been applied to the local server.

The Maximum number of object updates received in the


inbound_obj_updates_remaining_max_count string 255 max current directory replication update packet that have not yet
been applied to the local server.

The Average number of pending update notifications that


notify_que_size_avg_count string 255 average
have been queued, but not yet transmitted to clients.

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

The Minimum number of pending update notifications that


notify_que_size_min_count string 255 min
have been queued, but not yet transmitted to clients.

The Maximum number of pending update notifications that


notify_que_size_max_count string 255 max
have been queued, but not yet transmitted to clients.

The Average current number of threads in use by the LDAP


ldap_active_threads_avg_count string 255 average
subsystem of the local direcotry service.

The Minimum current number of threads in use by the LDAP


ldap_active_threads_min_count string 255 min
subsystem of the local direcotry service.

The Maximum current number of threads in use by the LDAP


ldap_active_threads_max_count string 255 max
subsystem of the local direcotry service.

The Average time (in milliseconds) taken for last successful


ldap_bind_time_avg_ms string 255 average
LDAP bind.

The Minimum time (in milliseconds) taken for last successful


ldap_bind_time_min_ms string 255 min
LDAP bind.

The Maximum time (in milliseconds) taken for last


ldap_bind_time_max_ms string 255 max
successful LDAP bind.

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.

The Average number of net user and new local groups


sam_nontransitive_membership_eval_avg_count_per_s string 255 average evaluations per second when performing a non-transitive
membership evaluation

The Minimum number of net user and new local groups


sam_nontransitive_membership_eval_min_count_per_s string 255 min evaluations per second when performing a non-transitive
membership evaluation

The Maximum number of net user and new local groups


sam_nontransitive_membership_eval_max_count_per_s string 255 max evaluations per second when performing a non-transitive
membership evaluation

The Average number of objects remaining to examine while


security_desc_propagator_runtime_que_avg_count string 255 average processing the current DS Security Descriptor Propagator
Event.

The Minimum number of objects remaining to examine while


security_desc_propagator_runtime_que_min_count string 255 min processing the current DS Security Descriptor Propagator
Event.

The Maximum number of objects remaining to examine


security_desc_propagator_runtime_que_max_count string 255 max while processing the current DS Security Descriptor
Propagator Event.

The Average number of new groups encountered per second


sam_transitive_membership_eval_avg_count_per_s string 255 average
when performing a transitive membership evaluation

The Minimum number of new groups encountered per


sam_transitive_membership_eval_min_count_per_s string 255 min
second when performing a transitive membership evaluation

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

The Maximum number of new groups encountered per


sam_transitive_membership_eval_max_count_per_s string 255 max
second when performing a transitive membership evaluation

Indicates the type of the data producer that ingested the


producer_instance_type string 50 lastval
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within


producer_instance_id string 255 lastval
a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id uuid lastval should be used 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]


cmdb_global_id uuid lastval should be used in 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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "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


node_ipv6_address string 50 lastval format. Fully specified ipv6 format without any simplification
rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

ad_server_fqdn_id string 255 AD Server

dir_svc_instance_name_id string 255 The Directory Services Instance Name.

The fully qualified hostname of the server being monitored.


node_fqdn_id string 255
That is the server to which the data belongs

This field holds the tenant id to which the row in dataset


tenant_id_id string 255 belongs 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

DITQLNAME dit_db_path string 255 Path of the Directory Information Tree(DIT) database file

The percentage of the used space of the drive hosting Directory


DITPTVALUE dit_db_disk_used_space_pct integer 24
Information Tree(DIT) database

Disk queue length of the drive hosting Directory Information Tree(DIT)


DITQLVALUE dit_db_disk_que_length_count integer 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
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCENAME dit_db_file_path string 255 Path of the Directory Information Tree(DIT) database file

INSTANCEVALUE dit_db_filesize_mb integer 24 Size of the Directory Information Tree(DIT) file 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

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

The percentage of used space of the drive containing Directory


LGPERFULLVALUE dit_log_disk_used_space_pct integer 24
Information Tree(DIT) log files

Disk queue length of the drive containing the Directory Information


LGQLENVALUE dit_log_disk_que_length_count integer 24
Tree(DIT) log 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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 Average percentage of used space of the drive containing Directory


dit_log_disk_used_space_avg_pct integer 24 average
Information Tree(DIT) log files

The Minimum percentage of used space of the drive containing Directory


dit_log_disk_used_space_min_pct integer 24 min
Information Tree(DIT) log files

The Maximum percentage of used space of the drive containing Directory


dit_log_disk_used_space_max_pct integer 24 max
Information 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dit_log_path_id string 255 Directory Information Tree(DIT) log file path

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 Average percentage of used space of the drive containing Directory


dit_log_disk_used_space_avg_pct integer 24 average
Information Tree(DIT) log files

The Minimum percentage of used space of the drive containing Directory


dit_log_disk_used_space_min_pct integer 24 min
Information Tree(DIT) log files

The Maximum percentage of used space of the drive containing Directory


dit_log_disk_used_space_max_pct integer 24 max
Information 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dit_log_path_id string 255 Directory Information Tree(DIT) log file path

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME fs_instance_name string 255 Instance Name

The number of incoming federation metadata requests per second


INSTANCE_VALUE fed_metadata_req_count_per_s string 255
that are sent to the federation server.

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

The Average number of incoming federation metadata requests per second


fed_metadata_req_avg_count_per_s string 255 average
that are sent to the federation server.

The Minimum number of incoming federation metadata requests per second


fed_metadata_req_min_count_per_s string 255 min
that are sent to the federation server.

The Maximum number of incoming federation metadata requests per second


fed_metadata_req_max_count_per_s string 255 max
that are sent to the federation server.

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

fs_instance_name_id string 255 Instance Name

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

The Average number of incoming federation metadata requests per second


fed_metadata_req_avg_count_per_s string 255 average
that are sent to the federation server.

The Minimum number of incoming federation metadata requests per second


fed_metadata_req_min_count_per_s string 255 min
that are sent to the federation server.

The Maximum number of incoming federation metadata requests per second


fed_metadata_req_max_count_per_s string 255 max
that are sent to the federation server.

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

fs_instance_name_id string 255 Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

DNS name of the Domain controller with which the Global Catalog has been
GCREPNAME gc_rep_name string 255
replicated

LATENCYDELTA gc_rep_delta_latency_s double 24 GC Replication delta latency 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

gc_rep_delta_latency_avg_s double 24 average The Average GC Replication delta latency in seconds

gc_rep_delta_latency_min_s double 24 min The Minimum GC Replication delta latency in seconds

gc_rep_delta_latency_max_s double 24 max The Maximum GC Replication delta 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

gc_rep_delta_latency_avg_s double 24 average The Average GC Replication delta latency in seconds

gc_rep_delta_latency_min_s double 24 min The Minimum GC Replication delta latency in seconds

gc_rep_delta_latency_max_s double 24 max The Maximum GC Replication delta 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME mem_instance_name string 255 Memory Instance Name

MEMORY dc_mem_usage_mb integer 24 Memory usage of 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

mem_instance_name_id string 255 Memory Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

mem_instance_name_id string 255 Memory Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME network_interface_instance_name string 255 Network Interface Instance Name

OUTPUTQUEUELEN output_que_length_count integer 24 Output queue length of domain controller

The number of outbound packets discarded by the domain


PACKETSOUTDISCAR packets_outbound_discard_count integer 24
controller

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

output_que_length_count integer 24 lastval 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

The Minimum number of outbound packets discarded by the domain


packets_outbound_discard_min_count integer 24 min
controller

The Maximum number of outbound packets discarded by the domain


packets_outbound_discard_max_count integer 24 max
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

The Maximum number of received packets discarded by the domain


packets_recvd_discard_max_count integer 24 max
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

network_interface_instance_name_id string 255 Network Interface Instance Name

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

output_que_length_count integer 24 lastval 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

The Minimum number of outbound packets discarded by the domain


packets_outbound_discard_min_count integer 24 min
controller

The Maximum number of outbound packets discarded by the domain


packets_outbound_discard_max_count integer 24 max
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

The Maximum number of received packets discarded by the domain


packets_recvd_discard_max_count integer 24 max
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

network_interface_instance_name_id string 255 Network Interface Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME physical_disk_instance_name string 255 Physical disk Instance name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

physical_disk_instance_name_id string 255 Physical disk Instance name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

physical_disk_instance_name_id string 255 Physical disk Instance name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME processor_info_instance_name string 255 Processor Information Instance name

The percentage of elapsed time that the processor spends to execute a


PROCESSORINFORM dc_processor_time_total_pct double 24
non-Idle thread and shows the value of total processor utilization

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. Pull:Data producer provides
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

processor_info_instance_name_id string 255 Processor Information Instance name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

processor_info_instance_name_id string 255 Processor Information Instance name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME ntds_instance_name string 255 NTDS Instance Name

Total number of bytes replicated in per second. Sum of the


DRAINBOUNDBTS dra_inbound_bytes_bps string 255 number of uncompressed bytes (never compressed) and the
number of compressed bytes (after compression).

Original size in bytes of outbound compressed replication data


OUTOBJECTS dra_outbound_bytes_compressed_bps string 255
per second (size before compression, from DSAs in other sites).

DSTHREADSINUSE ds_threads_inuse_count string 255 Number of threads in use by the directory service

Original size in bytes of inbound compressed replication data


DRAINBOUNDBCSEC dra_inbound_bytes_compressed_bps string 255
per second(size before compression, from DSAs in other sites).

Total number of bytes replicated out per second. Sum of the


DRAOUTBOUNDBTS dra_outbound_bytes_bps string 255 number of uncompressed bytes (never compressed) and the
number of compressed bytes (after compression).

Number of bytes replicated in per second that were not


DRAINBOUNDBNCWSSEC dra_inbound_noncompressed_bps string 255
compressed at the source (i.e., from DSAs in the same site).

Number of bytes replicated out per second that were not


DRAOUTBOUNDBNCWSSEC dra_outbound_noncompressed_bps string 255
compressed (i.e., from DSAs in the same site).

Total number of replication operations on the directory that are


DRAPENDREPOPR dra_pending_rep_ops_count integer 24
queued for this server but not yet performed.

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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).

The Maximum total number of bytes replicated in per second. Sum of


dra_inbound_bytes_max_bps string 255 max the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).

The Average original size in bytes of outbound compressed replication


dra_outbound_bytes_compressed_avg_bps string 255 average
data per second (size before compression, from DSAs in other sites).

The Minimum original size in bytes of outbound compressed replication


dra_outbound_bytes_compressed_min_bps string 255 min
data per second (size before compression, from DSAs in other sites).

The Maximum original size in bytes of outbound compressed replication


dra_outbound_bytes_compressed_max_bps string 255 max
data per second (size before compression, from DSAs in other sites).

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 original size in bytes of inbound compressed replication


dra_inbound_bytes_compressed_avg_bps string 255 average
data per second(size before compression, from DSAs in other sites).

The Minimum original size in bytes of inbound compressed replication


dra_inbound_bytes_compressed_min_bps string 255 min
data per second(size before compression, from DSAs in other sites).

The Maximum original size in bytes of inbound compressed replication


dra_inbound_bytes_compressed_max_bps string 255 max
data per second(size before compression, from DSAs in other sites).

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).

The Average total number of replication operations on the directory that


dra_pending_rep_ops_avg_count integer 24 average
are queued for this server but not yet performed.

The Minimum total number of replication operations on the directory


dra_pending_rep_ops_min_count integer 24 min
that are queued for this server but not yet performed.

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

The Maximum total number of replication operations on the directory


dra_pending_rep_ops_max_count integer 24 max
that are queued for this server but not yet performed.

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

ntds_instance_name_id string 255 NTDS Instance Name

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).

The Maximum total number of bytes replicated in per second. Sum of


dra_inbound_bytes_max_bps string 255 max the number of uncompressed bytes (never compressed) and the number
of compressed bytes (after compression).

The Average original size in bytes of outbound compressed replication


dra_outbound_bytes_compressed_avg_bps string 255 average
data per second (size before compression, from DSAs in other sites).

The Minimum original size in bytes of outbound compressed replication


dra_outbound_bytes_compressed_min_bps string 255 min
data per second (size before compression, from DSAs in other sites).

The Maximum original size in bytes of outbound compressed replication


dra_outbound_bytes_compressed_max_bps string 255 max
data per second (size before compression, from DSAs in other sites).

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 original size in bytes of inbound compressed replication


dra_inbound_bytes_compressed_avg_bps string 255 average
data per second(size before compression, from DSAs in other sites).

The Minimum original size in bytes of inbound compressed replication


dra_inbound_bytes_compressed_min_bps string 255 min
data per second(size before compression, from DSAs in other sites).

The Maximum original size in bytes of inbound compressed replication


dra_inbound_bytes_compressed_max_bps string 255 max
data per second(size before compression, from DSAs in other sites).

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).

The Average total number of replication operations on the directory that


dra_pending_rep_ops_avg_count integer 24 average
are queued for this server but not yet performed.

The Minimum total number of replication operations on the directory


dra_pending_rep_ops_min_count integer 24 min
that are queued for this server but not yet performed.

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

The Maximum total number of replication operations on the directory


dra_pending_rep_ops_max_count integer 24 max
that are queued for this server but not yet performed.

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

ntds_instance_name_id string 255 NTDS Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME ntds_process_instance_name string 255 NTDS Process Instance Name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

ntds_process_instance_name_id string 255 NTDS Process Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

ntds_process_instance_name_id string 255 NTDS Process Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME process_instance_name string 255 Name of the process.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

process_instance_name_id string 255 Name of the process.

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

process_instance_name_id string 255 Name of the process.

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

Minimum latency experienced in minutes during replication from all Dcs to


LATENCYMIN rep_latency_min_min double 24
which a connection object exists

Maximum latency experienced in minutes during replication from all Dcs to


LATENCYMAX rep_latency_max_min double 24
which a connection object exists

Average of latencies experienced in minutes during replication from all Dcs


LATENCYAVG rep_latency_avg_min double 24
to which a connection object exists

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 777
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

SVRNAME dc_name string 255 Domain Controller

Time required to bind to the Microsoft Active Directory on domain controller


BINDTIME bind_resp_time_s double 24
in seconds.

Time required to query the Microsoft Active Directory on domain controller


QUERYTIME qry_resp_time_s double 24
in seconds.

GCBINDTIME gc_bind_resp_time_s double 24 Time required to bind to Global Catalog in seconds.

GCQUERYTIME gc_qry_resp_time_s double 24 Time required to query Global Catalog 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dc_name_id string 255 Domain Controller

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

dc_name_id string 255 Domain Controller

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

SERVNAME svc_name string 255 Name of the service.

SRVDISPNAME svc_display_name string 255 Display name of the service.

Status of the service (Running, ContinuePending, Paused, PausePending,


SERVSTATUS svc_status string 255
StartPending, Stopped, StopPending)

State of the service (0-Running, 5-ContinuePending, 7-Paused, 6-


SERVSTATE svc_state integer 24
PausePending, 2-StartPending, 1-Stopped, 3-StopPending).

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

svc_display_name string 255 lastval Display name of the service.

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

svc_name_id string 255 Name of the service.

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

SERVNAME svc_name string 255 Name of the service.

SRVDISPNAME svc_display_name string 255 Display name of the service.

The time duration (in minutes) in an hour when the AD service is in


null uptime_min double
running state.

The percentage of time in an hour when the AD service is in running


null uptime_pct double
state.

The time duration (in minutes) in an hour when the AD service is not in
null downtime_min double
running state.

The percentage of time in an hour when the AD service is not in running


null downtime_pct double
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.

The percentage of time in an hour when the AD service state


null unknown_time_pct double
information not available due to unknown outage.

Timestamp with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

INSTANCE_NAME smb_instance_name string 255 Instance Name

SMBCONNECTIONSTATUS smb_connection_count integer 24 SMB connections

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

smb_connection_avg_count integer 24 average The Average SMB connections

smb_connection_min_count integer 24 min The Minimum SMB connections

smb_connection_max_count integer 24 max The Maximum SMB connections

smb_connection_count integer 24 lastval SMB connections

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

smb_instance_name_id string 255 Instance Name

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

smb_connection_avg_count integer 24 average The Average SMB connections

smb_connection_min_count integer 24 min The Minimum SMB connections

smb_connection_max_count integer 24 max The Maximum SMB connections

smb_connection_count integer 24 lastval SMB connections

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

smb_instance_name_id string 255 Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

SYSQLNAME sysvol_dir_path string 255 SYSVOL directory path

SYSPERCVALUE sysvol_disk_used_space_pct integer 24 The percentage of used space of the drive hosting Sysvol

SYSQLVALUE sysvol_disk_que_length_count integer 24 Queue length on the SYSVOL disk drive

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

sysvol_dir_path_id string 255 SYSVOL directory path

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

sysvol_dir_path_id string 255 SYSVOL directory path

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

Metric Name/Global Data


Column Name Size Description
Name Type

null ad_server_fqdn string 255 AD Server

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

TRUSTINGDOMAIN trusting_domain string 255 Name of the trusting domain

TRUSTEDDOMAIN trusted_domain string 255 Name of trusted domain

Trust attributes can be a combination of the following values: 1 -


TRUSTATTRIBUTES trust_attributes integer 24 Nontransitive, 2 - Uplevel clients only, 40000 - Tree parent, and 80000 -
Tree root

Trust direction can have one of the following values: 1 - inbound, 2 -


TRUSTDIRECTION trust_direction integer 24
outbound, and 3 - bi-directional trust relationship

Trust status can have one of the following values: 0 - no trust failure, else it
TRUSTSTATUS trust_status integer 24
contains the error code

TRUSTSTATUSSTRING trust_status_string string 255 Gives a description of the trust status

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 796
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

trusting_domain string 255 lastval Name of the trusting domain

trusted_domain string 255 lastval Name of trusted domain

Trust attributes can be a combination of the following values: 1 - Nontransitive, 2 - Uplevel


trust_attributes integer 24 lastval
clients only, 40000 - Tree parent, and 80000 - Tree root

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_status_string string 255 lastval Gives a description of the trust status

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

trusting_domain string 255 lastval Name of the trusting domain

trusted_domain string 255 lastval Name of trusted domain

Trust attributes can be a combination of the following values: 1 - Nontransitive, 2 - Uplevel


trust_attributes integer 24 lastval
clients only, 40000 - Tree parent, and 80000 - Tree root

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_status_string string 255 lastval Gives a description of the trust status

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ad_server_fqdn_id string 255 AD Server

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

1.4.2.4. Management Pack for Microsoft Exchange


Server
This section provides you information about the Management Pack for Microsoft Exchange Server:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_exch_active_manager opsb_exch_active_manager_1h opsb_exch_active_manager_1d

opsb_exch_activesync_connection opsb_exch_activesync_connection_1h opsb_exch_activesync_connection_1d

opsb_exch_activesync_perf opsb_exch_activesync_perf_1h opsb_exch_activesync_perf_1d

opsb_exch_asp_dotnet opsb_exch_asp_dotnet_1h opsb_exch_asp_dotnet_1d

opsb_exch_availability opsb_exch_availability_1h opsb_exch_availability_1d

opsb_exch_blocked_emails opsb_exch_blocked_emails_1h opsb_exch_blocked_emails_1d

opsb_exch_blocked_recipient opsb_exch_blocked_recipient_1h opsb_exch_blocked_recipient_1d

opsb_exch_content_filter_agent opsb_exch_content_filter_agent_1h opsb_exch_content_filter_agent_1d

opsb_exch_eac Not available

opsb_exch_hub_transport_dsn opsb_exch_hub_transport_dsn_1h opsb_exch_hub_transport_dsn_1d

opsb_exch_imap4_perf opsb_exch_imap4_perf_1h opsb_exch_imap4_perf_1d

opsb_exch_info_store_client opsb_exch_info_store_client_1h opsb_exch_info_store_client_1d

opsb_exch_mail_flow_check opsb_exch_mail_flow_check_1h opsb_exch_mail_flow_check_1d

opsb_exch_mailbox_database_perf opsb_exch_mailbox_database_perf_1h opsb_exch_mailbox_database_perf_1d

opsb_exch_mailbox_details opsb_exch_mailbox_details_1h opsb_exch_mailbox_details_1d

opsb_exch_mailbox_summary_data opsb_exch_mailbox_summary_data_1h opsb_exch_mailbox_summary_data_1d

opsb_exch_managed_service Not available

opsb_exch_mapi_connectivity opsb_exch_mapi_connectivity_1h opsb_exch_mapi_connectivity_1d

opsb_exch_memory_info opsb_exch_memory_info_1h opsb_exch_memory_info_1d

opsb_exch_network_interface opsb_exch_network_interface_1h opsb_exch_network_interface_1d

opsb_exch_owa_connection_check opsb_exch_owa_connection_check_1h opsb_exch_owa_connection_check_1d

opsb_exch_owa_perf opsb_exch_owa_perf_1h opsb_exch_owa_perf_1d

opsb_exch_owa_server Not available


Not available
opsb_exch_physical_disk opsb_exch_physical_disk_1h opsb_exch_physical_disk_1d

opsb_exch_pop3_perf opsb_exch_pop3_perf_1h opsb_exch_pop3_perf_1d

opsb_exch_processor_info opsb_exch_processor_info_1h opsb_exch_processor_info_1d

opsb_exch_processor_time opsb_exch_processor_time_1h opsb_exch_processor_time_1d

opsb_exch_public_folder_db opsb_exch_public_folder_db_1h opsb_exch_public_folder_db_1d

opsb_exch_public_folder_details opsb_exch_public_folder_details_1h opsb_exch_public_folder_details_1d

opsb_exch_rpc_client_perf opsb_exch_rpc_client_perf_1h opsb_exch_rpc_client_perf_1d

opsb_exch_service_status opsb_exch_service_status_1h opsb_exch_service_status_1d

opsb_exch_smtp_receive opsb_exch_smtp_receive_1h opsb_exch_smtp_receive_1d

opsb_exch_smtp_send_new opsb_exch_smtp_send_new_1h opsb_exch_smtp_send_new_1d

opsb_exch_smtp_send_old opsb_exch_smtp_send_old_1h opsb_exch_smtp_send_old_1d

opsb_exch_store_infomation_perf opsb_exch_store_infomation_perf_1h opsb_exch_store_infomation_perf_1d

opsb_exch_store_interface_perf opsb_exch_store_interface_perf_1h opsb_exch_store_interface_perf_1d

opsb_exch_top_destination opsb_exch_top_destination_1h opsb_exch_top_destination_1d

opsb_exch_top_recipient_details opsb_exch_top_recipient_details_1h opsb_exch_top_recipient_details_1d

opsb_exch_top_sender opsb_exch_top_sender_1h opsb_exch_top_sender_1d

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

opsb_exch_top_source opsb_exch_top_source_1h opsb_exch_top_source_1d

opsb_exch_transport_queue_info opsb_exch_transport_queue_info_1h opsb_exch_transport_queue_info_1d

opsb_exch_transport_queue_perf opsb_exch_transport_queue_perf_1h opsb_exch_transport_queue_perf_1d

opsb_exch_webserver_connection opsb_exch_webserver_connection_1h opsb_exch_webserver_connection_1d

opsb_exch_webserver_url_monitor Not available

opsb_exch_workload_management opsb_exch_workload_management_1h opsb_exch_workload_management_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

DATABASEMOUNTED db_mounted_count integer 24 Number of databases mounted

INSTANCE_NAME db_instance_name string 255 Database 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

db_mounted_count integer 24 lastval Number of databases mounted

db_mounted_avg_count integer 24 average The Average number of databases mounted

db_mounted_min_count integer 24 min The Minimum number of databases mounted

db_mounted_max_count integer 24 max The Maximum number of databases mounted

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

db_instance_name_id string 255 Database Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

db_mounted_count integer 24 lastval Number of databases mounted

db_mounted_avg_count integer 24 average The Average number of databases mounted

db_mounted_min_count integer 24 min The Minimum number of databases mounted

db_mounted_max_count integer 24 max The Maximum number of databases mounted

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

db_instance_name_id string 255 Database Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

EXSPI_ACTKEY activesync_conn_key string 255 ActiveSync Connection Key to identify each test

Name of the Exchange Client Access server where the test is


EXSPI_ACTSRV activesync_client_access_srv_name string 255
performed

Name of the Exchange Mailbox Server for which the test is


EXSPI_ACTDB activesync_mailbox_srv_name string 255
performed

EXSPI_ACTRSLT activesync_test_result integer 24 Result of the ActiveSync test

The ActiveSync latency for the Client Access Server in


EXSPI_ACTLAT activesync_latency_ms integer 24
milliseconds

EXSPI_ACTERR err_desc string 255 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
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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

activesync_conn_key_id string 255 ActiveSync Connection Key to identify each test

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

activesync_conn_key_id string 255 ActiveSync Connection Key to identify each test

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

Instance Name of Exchange Server against which ActiveSync is


ASYNINST activesync_instance_name string 255
performed

Number of availability requests that were processed by the server


ASYAVREQPSEC availability_req_count_per_s double 24
each second

The average time (in milliseconds) that elapsed waiting for Ping and
ASYAVGHGTM hang_time_avg_ms double 24
Hanging Sync requests to complete

The average time that elapsed, in milliseconds, waiting for a


ASYAVGRQTM req_time_avg_ms double 24
request to complete

The average time (in milliseconds) that it takes for a remote


ASYAVGRPCLT activesync_rpc_latency_avg_ms double 24 procedure call to return results from a Mailbox server, averaged
over RPC calls in the last minute

Number of Ping commands per second whose connection to the


ASYPCMDRPSC ping_cmd_dropped_count_per_s double 24
client was dropped before a response could be issued

ASYPCMDPD ping_cmd_pending_count double 24 Number of Ping commands that are currently pending on the server

Number of Ping commands that are processed by the server each


ASYPCMPSC ping_cmd_processed_count_per_s double 24 second,This command is used to send clients notifications about
new e-mail messages or changed items.

Number of HTTP requests that are received from the client via
ASYREQPSEC http_req_recvd_count_per_s double 24
ASP.NET per second

Number of Sync commands per second whose connection to the


ASYSCMDRPSC sync_cmd_dropped_count_per_s double 24
client was dropped before a response could be issued.

Number of Sync commands that are currently pending on the


ASYSCMPEND sync_cmd_pending_count double 24
server.

Number of Sync commands that are processed per second. Clients


ASYSCMPSC sync_cmd_processed_count_per_s double 24
use this command to synchronize items within a folder

ASYCURRREQ curr_http_req_count double 24 Number of HTTP requests received from ASP.NET

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
data through an API 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 809
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name 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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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 number of availability requests that were processed by the


availability_req_avg_count_per_s double 24 average
server each second

The Minimum number of availability requests that were processed by the


availability_req_min_count_per_s double 24 min
server each second

The Maximum number of availability requests that were processed by the


availability_req_max_count_per_s double 24 max
server each second

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 that elapsed, in milliseconds, waiting for a request to


req_time_avg_ms average
complete

The Minimum average time that elapsed, in milliseconds, waiting for a


req_time_avg_min_ms min
request to complete

The Maximum average time that elapsed, in milliseconds, waiting for a


req_time_avg_max_ms max
request 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

The Minimum number of Ping commands per second whose connection to


ping_cmd_dropped_min_count_per_s double 24 min
the client was dropped before a response could be issued

The Maximum number of Ping commands per second whose connection to


ping_cmd_dropped_max_count_per_s double 24 max
the 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

The Average number of Sync commands per second whose connection to


sync_cmd_dropped_avg_count_per_s double 24 average
the client was dropped before a response could be issued.

The Minimum number of Sync commands per second whose connection to


sync_cmd_dropped_min_count_per_s double 24 min
the client was dropped before a response could be issued.

The Maximum number of Sync commands per second whose connection to


sync_cmd_dropped_max_count_per_s double 24 max
the client was dropped before a response could be issued.

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_count double 24 lastval Number of HTTP requests received from ASP.NET

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 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 812
AI Operations Management - Containerized 24.4

Data Aggregation
Column Name Size Description
Type Type

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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 number of availability requests that were processed by the


availability_req_avg_count_per_s double 24 average
server each second

The Minimum number of availability requests that were processed by the


availability_req_min_count_per_s double 24 min
server each second

The Maximum number of availability requests that were processed by the


availability_req_max_count_per_s double 24 max
server each second

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 that elapsed, in milliseconds, waiting for a request to


req_time_avg_ms double 24 average
complete

The Minimum average time that elapsed, in milliseconds, waiting for a


req_time_avg_min_ms double 24 min
request to complete

The Maximum average time that elapsed, in milliseconds, waiting for a


req_time_avg_max_ms double 24 max
request 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

The Minimum number of Ping commands per second whose connection to


ping_cmd_dropped_min_count_per_s double 24 min
the client was dropped before a response could be issued

The Maximum number of Ping commands per second whose connection to


ping_cmd_dropped_max_count_per_s double 24 max
the 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

The Average number of Sync commands per second whose connection to


sync_cmd_dropped_avg_count_per_s double 24 average
the client was dropped before a response could be issued.

The Minimum number of Sync commands per second whose connection to


sync_cmd_dropped_min_count_per_s double 24 min
the client was dropped before a response could be issued.

The Maximum number of Sync commands per second whose connection to


sync_cmd_dropped_max_count_per_s double 24 max
the client was dropped before a response could be issued.

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_count double 24 lastval Number of HTTP requests received from ASP.NET

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 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 815
AI Operations Management - Containerized 24.4

Data Aggregation
Column Name Size Description
Type Type

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

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

INSTANCE_NAME asp_dotnet_instance_name string 255 ASP .NET 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

asp_dotnet_instance_name_id string 255 ASP .NET Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

asp_dotnet_instance_name_id string 255 ASP .NET Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Exchange Server is a member

ROLE exch_srv_role string 255 Exchange Server Role

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exch_srv_role_id string 255 Exchange Server Role

exchange_server_fqdn_id string 255 Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Exchange Server

ROLE exch_srv_role string 255 Exchange Server Role

The time duration (in minutes) in a hour when the Exchange server is in
null uptime_min double
running state.

The percentage of time in a hour when the Exchange server is in running


null uptime_pct double
state.

The time duration (in minutes) in a hour when the Exchange server is not
null downtime_min double
in running state.

The percentage of time in a hour when the Exchange server is not in


null downtime_pct double
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 with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

IPADDRESS sender_ip_address string 255 Blocked Email Sender IP Address

SENDERADDRESS sender_address string 255 Sender email address of the blocked email

ACTION_TAKEN action_taken string 255 Action Taken

AGENT transport_agent_name string 255 Name of the Sender Transport Agent

REASON sender_reason string 255 Reason for blocking the email.

REASONDATA sender_reason_data string 255 Reason data for blocking the email.

DOMAIN blocked_email_domain_name string 255 Blocked Email domain name

ISHUBTRANSPORTSERVER is_hub_transport_srv string 255 Is the server Hub Transport Server

REMOTEENDPOINT remote_endpoint string 255 Remote end point of the mail.

MESSAGEID blocked_email_msg_id string 255 Message ID of the mail.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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 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_ip_address string 255 lastval Blocked Email Sender IP Address

sender_address string 255 lastval Sender email address of the blocked email

action_taken string 255 lastval Action Taken

transport_agent_name string 255 lastval Name of the Sender Transport Agent

sender_reason string 255 lastval Reason for blocking the email.

sender_reason_data string 255 lastval Reason data for blocking the email.

blocked_email_domain_name string 255 lastval Blocked Email domain name

is_hub_transport_srv string 255 lastval Is the server Hub Transport Server

remote_endpoint string 255 lastval Remote end point of the mail.

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

blocked_email_msg_id_id string 255 Message ID of the mail.

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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_ip_address string 255 lastval Blocked Email Sender IP Address

sender_address string 255 lastval Sender email address of the blocked email

action_taken string 255 lastval Action Taken

transport_agent_name string 255 lastval Name of the Sender Transport Agent

sender_reason string 255 lastval Reason for blocking the email.

sender_reason_data string 255 lastval Reason data for blocking the email.

blocked_email_domain_name string 255 lastval Blocked Email domain name

is_hub_transport_srv string 255 lastval Is the server Hub Transport Server

remote_endpoint string 255 lastval Remote end point of the mail.

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

blocked_email_msg_id_id string 255 Message ID of the mail.

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

RECIPIENTADDRESS recipient_address string 255 Blocked recipient email address

AGENT blocked_recipient_agent_name string 255 Blocked Recipient Agent Name

REASON recipient_reason string 255 Reason for blocking the recipient

REASONDATA recipient_reason_data string 255 Reason data for blocking the recipient

ISHUBTRANSPORTSERVER is_hub_transport_srv string 255 Is the server backend

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_address string 255 lastval Blocked recipient email address

blocked_recipient_agent_name string 255 lastval Blocked Recipient Agent Name

recipient_reason string 255 lastval Reason for blocking the recipient

recipient_reason_data string 255 lastval Reason data for blocking the recipient

is_hub_transport_srv string 255 lastval Is the server backend

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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_address string 255 lastval Blocked recipient email address

blocked_recipient_agent_name string 255 lastval Blocked Recipient Agent Name

recipient_reason string 255 lastval Reason for blocking the recipient

recipient_reason_data string 255 lastval Reason data for blocking the recipient

is_hub_transport_srv string 255 lastval Is the server backend

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE content_filter_agent_instance_name string 255 Instance of the Content Filter Agent

The total number of messages that were deleted using the


DELETED del_msg_count integer 24
Content Filter Agent

The total number of messages that were quarantined using the


QUARANTINED quarantined_msg_count integer 24
Content Filter Agent

The total number of messages that were rejected by Content


REJECTED rejected_msg_count integer 24
Filter Agent

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

The total number of messages that could not be scanned by the


MSGSCLUNK scl_unknown_msg_count integer 24
filter

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80
provides data through an API 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 831
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name 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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

content_filter_agent_instance_name_id string 255 Instance of the Content Filter Agent

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

content_filter_agent_instance_name_id string 255 Instance of the Content Filter Agent

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

ACS_EACURLSERVNM access_to_eac_url_srvname string 255 Access to EAC URL Service Name

Access to EAC URL Service State. Service is running if value is 0 and


ACS_EACURLSERVSTE access_to_eac_url_srvstate 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
producer_instance_type producer_instance_type string 50
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

DSNINS dsn_instance_name string 255 Delivery status notification Instance Name

Number of failure delivery status notifications (DSNs) that have been


FAIL_DSNS_TOTAL failure_dsn_count integer 24
generated

DELAY_DSNS delay_dsn_count integer 24 Number of delay delivery status notifications that have been generated

DSNRELAY relay_dsn_count integer 24 Number of relay delivery status notifications generated

DSNDEL delivered_dsn_count integer 24 Number of delivered DSNs(delivery status notification) generated.

DSNEXPND expanded_dsn_count integer 24 Number of expanded delivery status notifications generated

Number of failure delivery status notifications (DSNs) that have been


DSNFAILHR failure_dsn_count_per_h double 24
generated within the last hour

Number of delayed delivery status notifications (DSNs) that have been


DSNDLYHR delayed_dsn_count_per_h double 24
generated within the last hour

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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 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_count integer 24 lastval Number of relay delivery status notifications 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_count integer 24 lastval Number of delivered DSNs(delivery status notification) 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_count integer 24 lastval Number of expanded delivery status notifications 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

dsn_instance_name_id string 255 Delivery status notification Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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_count integer 24 lastval Number of relay delivery status notifications 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_count integer 24 lastval Number of delivered DSNs(delivery status notification) 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_count integer 24 lastval Number of expanded delivery status notifications 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

dsn_instance_name_id string 255 Delivery status notification Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

IMAP4INSTANCE imap4_instance_name string 255 Imap4 Instance Name

POP3FAILEDCON failed_conn_count integer 24 Number of IMAP4 Connections Failed

IMAP4CON imap4_conn_count integer 24 Total Number of IMAP4 Connections

IMAP4REJECTEDCON rejected_conn_count integer 24 Total number of IMAP4 Connections that are Rejected

Connections rate is the number of IMAP4 connections that occur per


IMAP4CONRT conns_count_per_s double 24
second

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

IMAP4ATHRT auth_cmds_count_per_s double 24 The number of AUTH commands per second

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

IMAP4DELRT del_cmds_fail_count_per_s double 24 The number of DELE commands per second

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

POP3REQRT req_count_per_s double 24 The number of requests per second

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 a remote procedure


IMAP4RPCLAT imap4_rpc_latency_avg_ms double 24 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

failed_conn_count integer 24 lastval Number of IMAP4 Connections Failed

failed_conn_avg_count integer 24 average The Average number of IMAP4 Connections Failed

failed_conn_min_count integer 24 min The Minimum number of IMAP4 Connections Failed

failed_conn_max_count integer 24 max The Maximum number of IMAP4 Connections Failed

imap4_conn_count integer 24 lastval Total Number of IMAP4 Connections

imap4_conn_avg_count integer 24 average The Average total Number of IMAP4 Connections

imap4_conn_min_count integer 24 min The Minimum total Number of IMAP4 Connections

imap4_conn_max_count integer 24 max The Maximum total Number of IMAP4 Connections

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

req_avg_count_per_s double 24 average The Average number of requests per second

req_min_count_per_s double 24 min The Minimum number of requests per second

req_max_count_per_s double 24 max The Maximum number of requests per second

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

imap4_instance_name_id string 255 Imap4 Instance 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
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

failed_conn_count integer 24 lastval Number of IMAP4 Connections Failed

failed_conn_avg_count integer 24 average The Average number of IMAP4 Connections Failed

failed_conn_min_count integer 24 min The Minimum number of IMAP4 Connections Failed

failed_conn_max_count integer 24 max The Maximum number of IMAP4 Connections Failed

imap4_conn_count integer 24 lastval Total Number of IMAP4 Connections

imap4_conn_avg_count integer 24 average The Average total Number of IMAP4 Connections

imap4_conn_min_count integer 24 min The Minimum total Number of IMAP4 Connections

imap4_conn_max_count integer 24 max The Maximum total Number of IMAP4 Connections

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

req_avg_count_per_s double 24 average The Average number of requests per second

req_min_count_per_s double 24 min The Minimum number of requests per second

req_max_count_per_s double 24 max The Maximum number of requests per second

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

imap4_instance_name_id string 255 Imap4 Instance 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

RPCREQUESTS info_store_rpc_req_count integer 24 Number of RPC Requests for Information Store Client Type

Average latency (milli seconds) of RPC Requests for Information Store


RPCAVGLATENCY info_store_rpc_avg_latency_ms integer 24
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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

is_client_instance_name_id string 255 Information Store Client type Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

is_client_instance_name_id string 255 Information Store Client type Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

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

LATENCY_SECONDS mail_flow_latency_s double 24 Mail Flow Latency in seconds

STATUS test_status string 255 Status of the Mail Flow Test

RESULT test_result integer 24 Result 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

mail_flow_latency_avg_s double 24 average The Average mail Flow Latency in seconds

mail_flow_latency_min_s double 24 min The Minimum mail Flow Latency in seconds

mail_flow_latency_max_s double 24 max The Maximum mail Flow Latency in seconds

test_result integer 24 lastval Result 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

destination_srv_id string 255 Destination Server of the Mail Flow test

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

mail_flow_latency_avg_s double 24 average The Average mail Flow Latency in seconds

mail_flow_latency_min_s double 24 min The Minimum mail Flow Latency in seconds

mail_flow_latency_max_s double 24 max The Maximum mail Flow Latency in seconds

test_result integer 24 lastval Result 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

destination_srv_id string 255 Destination Server of the Mail Flow test

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

MDBNAME mailbox_db_instance_name string 255 Mailbox Database instance name

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

MDBVERBK ver_buckets_allocated_count integer 24 The total number of version buckets allocated

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 database file page requests that were fulfilled by the


MDBCHHIT db_cache_hit_pct double 24
database cache without causing a file operation in percentage.

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

The amount of system memory (in megabytes) used by the


MDBCHSZ cache_mem_size_mb integer 24 database cache manager to hold commonly used information
from the database file(s) to prevent file operations

MDBIOARD io_reads_attached_count_per_s double 24 The rate of database read operations completed

MDBIOARAL io_reads_attached_avg_latency_ms double 24 The average latency, in milliseconds, per database read operation

MDBIORRD io_reads_recovery_count_per_s double 24 The rate of database read(Recovery) operations completed.

The average latency, in milliseconds, per database


MDBIORALREC io_reads_recovery_latency_avg_ms double 24
read(Recovery) operation

MDBIORD io_reads_count_per_s double 24 The rate of database read operations completed

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

The average length of time, in milliseconds, per logfile read


MDBIOLRAL logfile_io_reads_latency_avg_ms double 24
operation

MDBIOAWR io_writes_attached_count_per_s double 24 The rate of database write operations completed

The average latency, in milliseconds, per database write


MDBIOAWAL io_writes_attached_latency_avg_ms double 24
operation

MDBIORWR io_writes_recovery_count_per_s double 24 The rate of database write operations completed

The average latency, in milliseconds, per database write


MDBIORWAL io_writes_recovery_latency_avg_ms double 24
operation

MDBIOWR io_writes_count_per_s double 24 The rate of database write operations completed

The average latency, in milliseconds, per database write


MDBIOWAL io_writes_latency_avg_ms double 24
operation

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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_count integer 24 lastval The total number of version buckets allocated

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

The Average amount of system memory (in megabytes) used by the


cache_mem_size_avg_mb integer 24 average database cache manager to hold commonly used information from the
database file(s) to prevent file operations

The Minimum amount of system memory (in megabytes) used by the


cache_mem_size_min_mb integer 24 min database cache manager to hold commonly used information from the
database file(s) to prevent file operations

The Maximum amount of system memory (in megabytes) used by the


cache_mem_size_max_mb integer 24 max database cache manager to hold commonly used information from the
database file(s) to prevent file operations

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

The Minimum average latency, in milliseconds, per database read


io_reads_attached_avg_latency_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database read


io_reads_attached_avg_latency_max_ms double 24 max
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.

The Average latency, in milliseconds, per database read(Recovery)


io_reads_recovery_latency_avg_ms double 24 average
operation

The Minimum average latency, in milliseconds, per database


io_reads_recovery_latency_avg_min_ms double 24 min
read(Recovery) operation

The Maximum average latency, in milliseconds, per database


io_reads_recovery_latency_avg_max_ms double 24 max
read(Recovery) operation

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

The Minimum average latency, in milliseconds, per database read


io_reads_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database read


io_reads_latency_avg_max_ms double 24 max
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

The Minimum average length of time, in milliseconds, per logfile read


logfile_io_reads_latency_avg_min_ms double 24 min
operation

The Maximum average length of time, in milliseconds, per logfile read


logfile_io_reads_latency_avg_max_ms double 24 max
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

The Minimum average latency, in milliseconds, per database write


io_writes_attached_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database write


io_writes_attached_latency_avg_max_ms double 24 max
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

The Minimum average latency, in milliseconds, per database write


io_writes_recovery_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database write


io_writes_recovery_latency_avg_max_ms double 24 max
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

The Minimum average latency, in milliseconds, per database write


io_writes_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database write


io_writes_latency_avg_max_ms double 24 max
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mailbox_db_instance_name_id string 255 Mailbox Database instance name

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_count integer 24 lastval The total number of version buckets allocated

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

The Average amount of system memory (in megabytes) used by the


cache_mem_size_avg_mb integer 24 average database cache manager to hold commonly used information from the
database file(s) to prevent file operations

The Minimum amount of system memory (in megabytes) used by the


cache_mem_size_min_mb integer 24 min database cache manager to hold commonly used information from the
database file(s) to prevent file operations

The Maximum amount of system memory (in megabytes) used by the


cache_mem_size_max_mb integer 24 max database cache manager to hold commonly used information from the
database file(s) to prevent file operations

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

The Minimum average latency, in milliseconds, per database read


io_reads_attached_avg_latency_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database read


io_reads_attached_avg_latency_max_ms double 24 max
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.

The Average latency, in milliseconds, per database read(Recovery)


io_reads_recovery_latency_avg_ms double 24 average
operation

The Minimum average latency, in milliseconds, per database


io_reads_recovery_latency_avg_min_ms double 24 min
read(Recovery) operation

The Maximum average latency, in milliseconds, per database


io_reads_recovery_latency_avg_max_ms double 24 max
read(Recovery) operation

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

The Minimum average latency, in milliseconds, per database read


io_reads_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database read


io_reads_latency_avg_max_ms double 24 max
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

The Minimum average length of time, in milliseconds, per logfile read


logfile_io_reads_latency_avg_min_ms double 24 min
operation

The Maximum average length of time, in milliseconds, per logfile read


logfile_io_reads_latency_avg_max_ms double 24 max
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

The Minimum average latency, in milliseconds, per database write


io_writes_attached_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database write


io_writes_attached_latency_avg_max_ms double 24 max
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

The Minimum average latency, in milliseconds, per database write


io_writes_recovery_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database write


io_writes_recovery_latency_avg_max_ms double 24 max
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

The Minimum average latency, in milliseconds, per database write


io_writes_latency_avg_min_ms double 24 min
operation

The Maximum average latency, in milliseconds, per database write


io_writes_latency_avg_max_ms double 24 max
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mailbox_db_instance_name_id string 255 Mailbox Database instance name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

MB_IDENTITY mailbox_identity string 255 Identity of the Mailbox

MBOX_NAME mailbox_name string 255 Display name of the Mailbox

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_MSGCOUNT mailbox_msgs_count integer 24 Number of items in the mailbox

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_DELCOUNT marked_del_items_count integer 24 Number of items marked for deletion in mailbox

MB_DELSIZE marked_del_items_size_mb double 24 Total size of the items marked for deletion in mailbox.It's in MB

MB_STGLIMIT storage_limit_status string 255 Storage Limit status of the mailbox

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 873
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_name string 255 lastval Display name of the Mailbox

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

mailbox_msgs_count integer 24 lastval Number of items in the mailbox

mailbox_msgs_avg_count integer 24 average The Average number of items in the mailbox

mailbox_msgs_min_count integer 24 min The Minimum number of items in the mailbox

mailbox_msgs_max_count integer 24 max The Maximum number of items in the mailbox

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_count integer 24 lastval Number of items marked for deletion in mailbox

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mailbox_identity_id string 255 Identity of the Mailbox

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_name string 255 lastval Display name of the Mailbox

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

mailbox_msgs_count integer 24 lastval Number of items in the mailbox

mailbox_msgs_avg_count integer 24 average The Average number of items in the mailbox

mailbox_msgs_min_count integer 24 min The Minimum number of items in the mailbox

mailbox_msgs_max_count integer 24 max The Maximum number of items in the mailbox

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_count integer 24 lastval Number of items marked for deletion in mailbox

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mailbox_identity_id string 255 Identity of the Mailbox

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_KEY mailbox_instance_key string 255 Identity of the Mailbox database

DATABASE_NAME mailbox_db_name string 255 Name of the Mailbox database

EDBPATH edb_file_path string 255 EDB file path of the Mailbox database

EDBSIZE edb_file_size_mb double 24 Size of the EDB file in MB

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

MAILBOX_USRCNT mailbox_user_count integer 24 Number of mailbox users in the Mailbox database

MAILBOX_MSGCNT mailbox_msg_count integer 24 Number of messages in the Mailbox database

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

mailbox_db_name string 255 lastval Name of the Mailbox database

edb_file_path string 255 lastval EDB file path of the Mailbox database

edb_file_size_avg_mb double 24 average The Average size of the EDB file in MB

edb_file_size_min_mb double 24 min The Minimum size of the EDB file in MB

edb_file_size_max_mb double 24 max The Maximum size of the EDB file in MB

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_count integer 24 lastval Number of mailbox users in the Mailbox database

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_count integer 24 lastval Number of messages 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mailbox_instance_key_id string 255 Identity of the Mailbox database

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

mailbox_db_name string 255 lastval Name of the Mailbox database

edb_file_path string 255 lastval EDB file path of the Mailbox database

edb_file_size_avg_mb double 24 average The Average size of the EDB file in MB

edb_file_size_min_mb double 24 min The Minimum size of the EDB file in MB

edb_file_size_max_mb double 24 max The Maximum size of the EDB file in MB

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_count integer 24 lastval Number of mailbox users in the Mailbox database

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_count integer 24 lastval Number of messages 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mailbox_instance_key_id string 255 Identity of the Mailbox database

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

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

STATUS hm_worker_svc_status string 255 Status of the service

State of the service. Service is running if value is 0 and Service is down if


STATE hm_worker_svc_state integer 24
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

MAPIKEY mapi_key_name string 255 MAPI Key to identify each test

MAPIDB exch_db_name string 255 Name of the MAPI Exchange Database for which the test is performed

MAPIRSLT mapi_conn_check_test_result integer 24 MAPI Connectivity check test result

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_conn_check_test_result integer 24 lastval MAPI Connectivity check test result

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mapi_key_name_id string 255 MAPI Key to identify each test

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_conn_check_test_result integer 24 lastval MAPI Connectivity check test result

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mapi_key_name_id string 255 MAPI Key to identify each test

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

MEMORY mem_avail_info_b integer 24 Bytes of physical memory available to processes running on the computer.

INSTANCE_NAME mem_info_instance_name string 255 Memory information Instance Name

PERCOMMTDBYTE bytes_in_use_pct integer 24 Bytes in use in percentage.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

The Average bytes of physical memory available to processes running on the


mem_avail_info_avg_b integer 24 average
computer.

The Minimum bytes of physical memory available to processes running on the


mem_avail_info_min_b integer 24 min
computer.

The Maximum bytes of physical memory available to processes running on the


mem_avail_info_max_b integer 24 max
computer.

bytes_in_use_avg_pct integer 24 average The Average bytes in use in percentage.

bytes_in_use_min_pct integer 24 min The Minimum bytes in use in percentage.

bytes_in_use_max_pct integer 24 max The Maximum bytes in use in percentage.

bytes_in_use_pctl_pct integer 24 90 percentile The Percentile of the bytes in use 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mem_info_instance_name_id string 255 Memory information Instance 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 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

The Average bytes of physical memory available to processes running on the


mem_avail_info_avg_b integer 24 average
computer.

The Minimum bytes of physical memory available to processes running on the


mem_avail_info_min_b integer 24 min
computer.

The Maximum bytes of physical memory available to processes running on the


mem_avail_info_max_b integer 24 max
computer.

bytes_in_use_avg_pct integer 24 average The Average bytes in use in percentage.

bytes_in_use_min_pct integer 24 min The Minimum bytes in use in percentage.

bytes_in_use_max_pct integer 24 max The Maximum bytes in use in percentage.

bytes_in_use_pctl_pct integer 24 90 percentile The Percentile of the bytes in use 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

mem_info_instance_name_id string 255 Memory information Instance 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

Output queue length network interface monitors the occupancy of


OUTPUTQUEUELEN output_que_length_count integer 24
network interface

The number of outbound packets which were chosen to be


PACKETSOUTDISCAR pckts_outbound_discarded_count integer 24
discarded

PACKETSRECDISCAR pckts_recvd_discarded_count integer 24 The number of inbound packets which were chosen to be discarded

INSTANCE_NAME network_interface_instance_name string 255 Network Interface 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
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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

The Maximum output queue length network interface monitors the


output_que_length_max_count integer 24 max
occupancy of network interface

Output queue length network interface monitors the occupancy of network


output_que_length_count integer 24 lastval
interface

The Average number of outbound packets which were chosen to be


pckts_outbound_discarded_avg_count integer 24 average
discarded

The Minimum number of outbound packets which were chosen to be


pckts_outbound_discarded_min_count integer 24 min
discarded

The Maximum number of outbound packets which were chosen to be


pckts_outbound_discarded_max_count integer 24 max
discarded

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

The Maximum number of inbound packets which were chosen to be


pckts_recvd_discarded_max_count integer 24 max
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

network_interface_instance_name_id string 255 Network Interface Instance Name

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

The Maximum output queue length network interface monitors the


output_que_length_max_count integer 24 max
occupancy of network interface

Output queue length network interface monitors the occupancy of network


output_que_length_count integer 24 lastval
interface

The Average number of outbound packets which were chosen to be


pckts_outbound_discarded_avg_count integer 24 average
discarded

The Minimum number of outbound packets which were chosen to be


pckts_outbound_discarded_min_count integer 24 min
discarded

The Maximum number of outbound packets which were chosen to be


pckts_outbound_discarded_max_count integer 24 max
discarded

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

The Maximum number of inbound packets which were chosen to be


pckts_recvd_discarded_max_count integer 24 max
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

network_interface_instance_name_id string 255 Network Interface Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

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

OWARSLT owa_test_result integer 24 OWA Connection Result of the test

OWALAT owa_conn_latency_ms integer 24 OWA Connection Latency in milliseconds

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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_test_result integer 24 lastval OWA Connection Result of the test

owa_conn_latency_avg_ms integer 24 average The Average OWA Connection Latency in milliseconds

owa_conn_latency_min_ms integer 24 min The Minimum OWA Connection Latency in milliseconds

owa_conn_latency_max_ms integer 24 max The Maximum OWA Connection Latency in milliseconds

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

owa_conn_key_id string 255 OWA Connection Key to identify each test

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_test_result integer 24 lastval OWA Connection Result of the test

owa_conn_latency_avg_ms integer 24 average The Average OWA Connection Latency in milliseconds

owa_conn_latency_min_ms integer 24 min The Minimum OWA Connection Latency in milliseconds

owa_conn_latency_max_ms integer 24 max The Maximum OWA Connection Latency in milliseconds

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

owa_conn_key_id string 255 OWA Connection Key to identify each test

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

OWAINST owa_instance_name string 255 Outlook Web Access Instance Name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

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

Metric Name/Global Data


Column Name Size Description
Name Type

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

owa_instance_name_id string 255 Outlook Web Access Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

owa_instance_name_id string 255 Outlook Web Access Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

AVGDISKSREAD disks_read_latency_avg_s double 24 Average time of disk read latency in seconds

AVGDISKSWRITE disks_write_latency_avg_s double 24 Average time of disk write latency in seconds

INSTANCE_NAME disk_instance_name string 255 Physical memory disks 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_s average The Average time of disk read latency in seconds

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_s average The Average time of disk write 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

disk_instance_name_id string 255 Physical memory disks Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

disk_instance_name_id string 255 Physical memory disks Instance Name

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_NAME pop3_conn_instance_name string 255 POP3 connection instance name

POP3FAILEDCON failed_conn_count integer 24 Number of POP3 connections that are failed

POP3CON total_conn_count integer 24 Total number of POP3 connections

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

POP3ATHRT auth_cmd_count_per_s double 24 The number of AUTH commands per second

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

POP3DELRT del_cmd_count_per_s double 24 The number of DELETE commands per second

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

POP3REQRT req_count_per_s double 24 The number of requests per second

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_count integer 24 lastval Number of POP3 connections that are failed

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_conn_count integer 24 lastval Total number of POP3 connections

total_conn_avg_count integer 24 average The Average total number of POP3 connections

total_conn_min_count integer 24 min The Minimum total number of POP3 connections

total_conn_max_count integer 24 max The Maximum total number of POP3 connections

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

req_avg_count_per_s double 24 average The Average number of requests per second

req_min_count_per_s double 24 min The Minimum number of requests per second

req_max_count_per_s double 24 max The Maximum number of requests per second

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

pop3_conn_instance_name_id string 255 POP3 connection instance name

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_count integer 24 lastval Number of POP3 connections that are failed

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_conn_count integer 24 lastval Total number of POP3 connections

total_conn_avg_count integer 24 average The Average total number of POP3 connections

total_conn_min_count integer 24 min The Minimum total number of POP3 connections

total_conn_max_count integer 24 max The Maximum total number of POP3 connections

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

req_avg_count_per_s double 24 average The Average number of requests per second

req_min_count_per_s double 24 min The Minimum number of requests per second

req_max_count_per_s double 24 max The Maximum number of requests per second

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

pop3_conn_instance_name_id string 255 POP3 connection instance name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

PROCESSORINFORM cpu_utilization_pct double 24 CPU Utilization in Percentage

INSTANCE_NAME processor_instance_name string 255 Processor 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

cpu_utilization_avg_pct double 24 average The Average CPU Utilization in Percentage

cpu_utilization_min_pct double 24 min The Minimum CPU Utilization in Percentage

cpu_utilization_max_pct double 24 max The Maximum CPU Utilization in Percentage

cpu_utilization_pctl_pct double 24 90 percentile The Percentile of the CPU Utilization 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

processor_instance_name_id string 255 Processor Instance Name

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

cpu_utilization_avg_pct double 24 average The Average CPU Utilization in Percentage

cpu_utilization_min_pct double 24 min The Minimum CPU Utilization in Percentage

cpu_utilization_max_pct double 24 max The Maximum CPU Utilization in Percentage

cpu_utilization_pctl_pct double 24 90 percentile The Percentile of the CPU Utilization 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

processor_instance_name_id string 255 Processor Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

PERPROCTIME processor_time_pct integer 24 Processor Time in Percentage.

PERUSERTIME processor_user_time_pct integer 24 Processor User Time in Percentage

PERPRIVGTIME processor_privileged_time_pct integer 24 Processor Privileged Time in Percentage.

INSTANCE_NAME processor_instance_name string 255 Processor 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_time_avg_pct integer 24 average The Average processor Time in Percentage.

processor_time_min_pct integer 24 min The Minimum processor Time in Percentage.

processor_time_max_pct integer 24 max The Maximum processor Time in Percentage.

processor_time_pctl_pct integer 24 90 percentile The Percentile of the processor Time in Percentage.

processor_user_time_avg_pct integer 24 average The Average processor User Time in Percentage

processor_user_time_min_pct integer 24 min The Minimum processor User Time in Percentage

processor_user_time_max_pct integer 24 max The Maximum processor User Time in Percentage

processor_user_time_pctl_pct integer 24 90 percentile The Percentile of the processor User Time in Percentage

processor_privileged_time_avg_pct integer 24 average The Average processor Privileged Time in Percentage.

processor_privileged_time_min_pct integer 24 min The Minimum processor Privileged Time in Percentage.

processor_privileged_time_max_pct integer 24 max The Maximum processor Privileged 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

processor_instance_name_id string 255 Processor Instance Name

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_time_avg_pct integer 24 average The Average processor Time in Percentage.

processor_time_min_pct integer 24 min The Minimum processor Time in Percentage.

processor_time_max_pct integer 24 max The Maximum processor Time in Percentage.

processor_time_pctl_pct integer 24 90 percentile The Percentile of the processor Time in Percentage.

processor_user_time_avg_pct integer 24 average The Average processor User Time in Percentage

processor_user_time_min_pct integer 24 min The Minimum processor User Time in Percentage

processor_user_time_max_pct integer 24 max The Maximum processor User Time in Percentage

processor_user_time_pctl_pct integer 24 90 percentile The Percentile of the processor User Time in Percentage

processor_privileged_time_avg_pct integer 24 average The Average processor Privileged Time in Percentage.

processor_privileged_time_min_pct integer 24 min The Minimum processor Privileged Time in Percentage.

processor_privileged_time_max_pct integer 24 max The Maximum processor Privileged 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to
node_fqdn_id string 255
which the data belongs

processor_instance_name_id string 255 Processor Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_KEY db_instance_key string 255 Identity of the Public Folder database

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

EDBSIZE edb_file_size_mb double 24 Size of the Public Folder EDB file

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

FOLDER_MSGCNT total_msg_count integer 24 Number of messages 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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_count integer 24 lastval Number of messages 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

db_instance_key_id string 255 Identity of the Public Folder database

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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_count integer 24 lastval Number of messages 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

db_instance_key_id string 255 Identity of the Public Folder database

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

PF_NAME public_folder_name string 255 Name of the Public Folder

PF_SIZE total_items_size_mb double 24 Total size of the items in the public folder. It is in MB

PF_DELSIZE total_del_items_size_mb double 24 Total size of the deleted items in MB

PF_ASITSIZE total_associated_items_size_mb double 24 Total size of the associated items in MB

PF_POSTCOUNT total_item_count integer 24 Number of items in the public folder

PF_ASITCOUNT associated_item_count integer 24 Number of associated items in the public folder

PF_DELITCOUNT del_item_count integer 24 Number of deleted items in the public folder

PF_OWNCOUNT owner_count integer 24 Number of Owners

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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_count integer 24 lastval Number of items in the public folder

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_count integer 24 lastval Number of associated 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_count integer 24 lastval Number of deleted 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

owner_count integer 24 lastval Number of Owners

owner_avg_count integer 24 average The Average number of Owners

owner_min_count integer 24 min The Minimum number of Owners

owner_max_count integer 24 max The Maximum number of Owners

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs

public_folder_name_id string 255 Name of the Public Folder

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_count integer 24 lastval Number of items in the public folder

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_count integer 24 lastval Number of associated 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_count integer 24 lastval Number of deleted 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

owner_count integer 24 lastval Number of Owners

owner_avg_count integer 24 average The Average number of Owners

owner_min_count integer 24 min The Minimum number of Owners

owner_max_count integer 24 max The Maximum number of Owners

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs

public_folder_name_id string 255 Name of the Public Folder

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

RPCCLIENTINST rpc_client_instance_name string 255 RPC client Instance Name

Number of unique users that have shown some activity in the last
RPCACTUSERCNT active_user_count integer 24
two minutes

RPCCNNCNT client_conn_count integer 24 Total number of client connections maintained

RPCCLRPCATM attempted_rpc_count integer 24 The client-reported total number of RPCs attempted by the users

RPCCLSUCC successful_rpc_count integer 24 The client-reported total number of successful RPCs

RPCCLFAILED failed_rpc_count integer 24 The client-reported number of failed RPCs

The client-reported number of successful RPCs with latencies


RPCCLLTGT2 latency_greaterthan_2_sec_count integer 24
greater than 2 seconds

The client-reported number of successful RPCs with latencies


RPCCLLTGT5 latency_greaterthan_5_sec_count integer 24
greater than 5 seconds

The client-reported number of successful RPCs with latencies


RPCCLLTGT10 latency_greaterthan_10_sec_count integer 24
greater than 10 seconds

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

Number of client requests that are currently being processed by


RPCCLREQ client_reqs_processed_count double 24
the RPC Client Access service

Average RPC Client Latency is the latency (in milliseconds)


RPCCLAVGLAT rpc_client_latency_avg_ms double 24
averaged for the past 1024 packets

RPCDISOPRSEC dispatch_ops_count_per_s double 24 The number of RPC dispatch task operations, per second

The number of RPC dispatch tasks waiting to be processed in the


RPCDISQLEN dispatch_task_que_count double 24
queue

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80
provides data through an API 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 939
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name 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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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_count integer 24 lastval Total number of client connections maintained

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

The Maximum client-reported total number of RPCs attempted by the


attempted_rpc_max_count integer 24 max
users

successful_rpc_count integer 24 lastval The client-reported total number of successful RPCs

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

failed_rpc_count integer 24 lastval The client-reported number of failed RPCs

failed_rpc_avg_count integer 24 average The Average client-reported number of failed RPCs

failed_rpc_min_count integer 24 min The Minimum client-reported number of failed RPCs

failed_rpc_max_count integer 24 max The Maximum client-reported number of failed RPCs

The client-reported number of successful RPCs with latencies greater than


latency_greaterthan_2_sec_count integer 24 lastval
2 seconds

The Average client-reported number of successful RPCs with latencies


latency_greaterthan_2_sec_avg_count integer 24 average
greater than 2 seconds

The Minimum client-reported number of successful RPCs with latencies


latency_greaterthan_2_sec_min_count integer 24 min
greater than 2 seconds

The Maximum client-reported number of successful RPCs with latencies


latency_greaterthan_2_sec_max_count integer 24 max
greater than 2 seconds

The client-reported number of successful RPCs with latencies greater than


latency_greaterthan_5_sec_count integer 24 lastval
5 seconds

The Average client-reported number of successful RPCs with latencies


latency_greaterthan_5_sec_avg_count integer 24 average
greater than 5 seconds

The Minimum client-reported number of successful RPCs with latencies


latency_greaterthan_5_sec_min_count integer 24 min
greater than 5 seconds

The Maximum client-reported number of successful RPCs with latencies


latency_greaterthan_5_sec_max_count integer 24 max
greater than 5 seconds

The client-reported number of successful RPCs with latencies greater than


latency_greaterthan_10_sec_count integer 24 lastval
10 seconds

The Average client-reported number of successful RPCs with latencies


latency_greaterthan_10_sec_avg_count integer 24 average
greater than 10 seconds

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

The Minimum client-reported number of successful RPCs with latencies


latency_greaterthan_10_sec_min_count integer 24 min
greater than 10 seconds

The Maximum client-reported number of successful RPCs with latencies


latency_greaterthan_10_sec_max_count integer 24 max
greater than 10 seconds

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 Minimum number of client requests that are currently being


client_reqs_processed_min_count double 24 min
processed by the RPC Client Access service

The Maximum number of client requests that are currently being


client_reqs_processed_max_count double 24 max
processed 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

The Average number of RPC dispatch tasks waiting to be processed in the


dispatch_task_que_avg_count double 24 average
queue

The Minimum number of RPC dispatch tasks waiting to be processed in the


dispatch_task_que_min_count double 24 min
queue

The Maximum number of RPC dispatch tasks waiting to be processed in


dispatch_task_que_max_count double 24 max
the queue

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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 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

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

rpc_client_instance_name_id string 255 RPC client Instance Name

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_count integer 24 lastval Total number of client connections maintained

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

The Maximum client-reported total number of RPCs attempted by the


attempted_rpc_max_count integer 24 max
users

successful_rpc_count integer 24 lastval The client-reported total number of successful RPCs

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

failed_rpc_count integer 24 lastval The client-reported number of failed RPCs

failed_rpc_avg_count integer 24 average The Average client-reported number of failed RPCs

failed_rpc_min_count integer 24 min The Minimum client-reported number of failed RPCs

failed_rpc_max_count integer 24 max The Maximum client-reported number of failed RPCs

The client-reported number of successful RPCs with latencies greater than


latency_greaterthan_2_sec_count integer 24 lastval
2 seconds

The Average client-reported number of successful RPCs with latencies


latency_greaterthan_2_sec_avg_count integer 24 average
greater than 2 seconds

The Minimum client-reported number of successful RPCs with latencies


latency_greaterthan_2_sec_min_count integer 24 min
greater than 2 seconds

The Maximum client-reported number of successful RPCs with latencies


latency_greaterthan_2_sec_max_count integer 24 max
greater than 2 seconds

The client-reported number of successful RPCs with latencies greater than


latency_greaterthan_5_sec_count integer 24 lastval
5 seconds

The Average client-reported number of successful RPCs with latencies


latency_greaterthan_5_sec_avg_count integer 24 average
greater than 5 seconds

The Minimum client-reported number of successful RPCs with latencies


latency_greaterthan_5_sec_min_count integer 24 min
greater than 5 seconds

The Maximum client-reported number of successful RPCs with latencies


latency_greaterthan_5_sec_max_count integer 24 max
greater than 5 seconds

The client-reported number of successful RPCs with latencies greater than


latency_greaterthan_10_sec_count integer 24 lastval
10 seconds

The Average client-reported number of successful RPCs with latencies


latency_greaterthan_10_sec_avg_count integer 24 average
greater than 10 seconds

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

The Minimum client-reported number of successful RPCs with latencies


latency_greaterthan_10_sec_min_count integer 24 min
greater than 10 seconds

The Maximum client-reported number of successful RPCs with latencies


latency_greaterthan_10_sec_max_count integer 24 max
greater than 10 seconds

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 Minimum number of client requests that are currently being


client_reqs_processed_min_count double 24 min
processed by the RPC Client Access service

The Maximum number of client requests that are currently being


client_reqs_processed_max_count double 24 max
processed 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

The Average number of RPC dispatch tasks waiting to be processed in the


dispatch_task_que_avg_count double 24 average
queue

The Minimum number of RPC dispatch tasks waiting to be processed in the


dispatch_task_que_min_count double 24 min
queue

The Maximum number of RPC dispatch tasks waiting to be processed in


dispatch_task_que_max_count double 24 max
the queue

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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 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

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

rpc_client_instance_name_id string 255 RPC client Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

SERVNAME svc_name string 255 Name of the service

SRVDISPNAME svc_display_name string 255 Display name of the service

SERVSTATUS svc_status string 255 Status of the service

SERVSTATE svc_state integer 24 State of the 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

svc_display_name string 255 lastval Display name of the service

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs

svc_name_id string 255 Name of the service

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

svc_display_name string 255 lastval Display name of the service

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs

svc_name_id string 255 Name of the service

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_NAME smtp_recvd_connector_instance_name string 255 Name of the SMTP Receive Connector

SMTPCONNCURR smtp_recvd_inbound_conn_count integer 24 Number of inbound connections to the SMTP receive server

The number of new connections to the SMTP receive server


SMTPCNNCRSEC smtp_recvd_conn_created_count_per_s double 24
that are established per second

Total number of connections ever made to the SMTP receive


SMTPCONNTOT smtp_recvd_conn_total_count integer 24
server

The number of messages received by the SMTP receive server


SMTPRECSEC smtp_recvd_msg_count_per_s double 24
each second

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

The total number of bytes in messages received and


SMTPMSGBYTERECV smtp_total_recvd_msgs_b integer 24
committed to the database

SMTPAVBYMSG smtp_recvd_msg_b double 24 Average bytes per inbound SMTP message received

Average number of recipients per inbound SMTP message


SMTPAVRCMSG smtp_recvd_recipient_per_msg_count double 24
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

SMTPBYTERVSEC smtp_recvd_bps double 24 Number of SMTP bytes received per second

SMTPBYTERECV smtp_total_recvd_bytes_count integer 24 Total number of SMTP bytes received

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 provides data through an API 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 950
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

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"

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

The Average number of inbound connections to the SMTP receive


smtp_recvd_inbound_conn_avg_count integer 24 average
server

The Minimum number of inbound connections to the SMTP receive


smtp_recvd_inbound_conn_min_count integer 24 min
server

The Maximum number of inbound connections to the SMTP receive


smtp_recvd_inbound_conn_max_count integer 24 max
server

The Average number of new connections to the SMTP receive server


smtp_recvd_conn_created_avg_count_per_s double 24 average
that are established per second

The Minimum number of new connections to the SMTP receive server


smtp_recvd_conn_created_min_count_per_s double 24 min
that are established per second

The Maximum number of new connections to the SMTP receive server


smtp_recvd_conn_created_max_count_per_s double 24 max
that are established per second

smtp_recvd_conn_total_count integer 24 lastval Total number of connections ever made to the SMTP receive server

The Average total number of connections ever made to the SMTP


smtp_recvd_conn_total_avg_count integer 24 average
receive server

The Minimum total number of connections ever made to the SMTP


smtp_recvd_conn_total_min_count integer 24 min
receive server

The Maximum total number of connections ever made to the SMTP


smtp_recvd_conn_total_max_count integer 24 max
receive server

The Average number of messages received by the SMTP receive server


smtp_recvd_msg_avg_count_per_s double 24 average
each second

The Minimum number of messages received by the SMTP receive


smtp_recvd_msg_min_count_per_s double 24 min
server each second

The Maximum number of messages received by the SMTP receive


smtp_recvd_msg_max_count_per_s double 24 max
server each second

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

The Minimum number of messages received by the SMTP receive


smtp_recvd_total_recvd_msg_min_count integer 24 min
server

The Maximum number of messages received by the SMTP receive


smtp_recvd_total_recvd_msg_max_count integer 24 max
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

The Average total number of bytes in messages received and


smtp_total_recvd_msgs_avg_b integer 24 average
committed to the database

The Minimum total number of bytes in messages received and


smtp_total_recvd_msgs_min_b integer 24 min
committed to the database

The Maximum total number of bytes in messages received and


smtp_total_recvd_msgs_max_b integer 24 max
committed to the database

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

The Minimum average number of recipients per inbound SMTP message


smtp_recvd_recipient_per_msg_min_count double 24 min
received

The Maximum average number of recipients per inbound SMTP


smtp_recvd_recipient_per_msg_max_count double 24 max
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

The Minimum average number of SMTP messages received per


smtp_msgs_recvd_per_conn_min_count double 24 min
connection

The Maximum average number of SMTP messages received per


smtp_msgs_recvd_per_conn_max_count double 24 max
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_count integer 24 lastval Total number of SMTP bytes received

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

smtp_recvd_connector_instance_name_id string 255 Name of the SMTP Receive Connector

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

The Average number of inbound connections to the SMTP receive


smtp_recvd_inbound_conn_avg_count integer 24 average
server

The Minimum number of inbound connections to the SMTP receive


smtp_recvd_inbound_conn_min_count integer 24 min
server

The Maximum number of inbound connections to the SMTP receive


smtp_recvd_inbound_conn_max_count integer 24 max
server

The Average number of new connections to the SMTP receive server


smtp_recvd_conn_created_avg_count_per_s double 24 average
that are established per second

The Minimum number of new connections to the SMTP receive server


smtp_recvd_conn_created_min_count_per_s double 24 min
that are established per second

The Maximum number of new connections to the SMTP receive server


smtp_recvd_conn_created_max_count_per_s double 24 max
that are established per second

smtp_recvd_conn_total_count integer 24 lastval Total number of connections ever made to the SMTP receive server

The Average total number of connections ever made to the SMTP


smtp_recvd_conn_total_avg_count integer 24 average
receive server

The Minimum total number of connections ever made to the SMTP


smtp_recvd_conn_total_min_count integer 24 min
receive server

The Maximum total number of connections ever made to the SMTP


smtp_recvd_conn_total_max_count integer 24 max
receive server

The Average number of messages received by the SMTP receive server


smtp_recvd_msg_avg_count_per_s double 24 average
each second

The Minimum number of messages received by the SMTP receive


smtp_recvd_msg_min_count_per_s double 24 min
server each second

The Maximum number of messages received by the SMTP receive


smtp_recvd_msg_max_count_per_s double 24 max
server each second

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

The Minimum number of messages received by the SMTP receive


smtp_recvd_total_recvd_msg_min_count integer 24 min
server

The Maximum number of messages received by the SMTP receive


smtp_recvd_total_recvd_msg_max_count integer 24 max
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

The Average total number of bytes in messages received and


smtp_total_recvd_msgs_avg_b integer 24 average
committed to the database

The Minimum total number of bytes in messages received and


smtp_total_recvd_msgs_min_b integer 24 min
committed to the database

The Maximum total number of bytes in messages received and


smtp_total_recvd_msgs_max_b integer 24 max
committed to the database

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

The Minimum average number of recipients per inbound SMTP message


smtp_recvd_recipient_per_msg_min_count double 24 min
received

The Maximum average number of recipients per inbound SMTP


smtp_recvd_recipient_per_msg_max_count double 24 max
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

The Minimum average number of SMTP messages received per


smtp_msgs_recvd_per_conn_min_count double 24 min
connection

The Maximum average number of SMTP messages received per


smtp_msgs_recvd_per_conn_max_count double 24 max
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_count integer 24 lastval Total number of SMTP bytes received

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

smtp_recvd_connector_instance_name_id string 255 Name of the SMTP Receive Connector

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_NAME send_connector_instance_name string 255 Name of the SMTP Send Connector

The number of outbound connections from the SMTP Send


SMTPCONNCURR outbound_conn_count integer 24
connector

Number of outbound connections established per second from


SMTPCNCRSEC outbound_conn_created_count_per_s double 24
the SMTP Send connector

Number of connections ever made from the SMTP Send


POP3CON total_conn_count integer 24
connector

Number of messages sent by the SMTP Send connector per


SMTPMSGSNSEC msg_send_count_per_s double 24
second

SMTPMSGSEND total_msgs_send_count integer 24 Total number of messages sent by the SMTP Send connector

Total number of bytes sent, this number only includes


SMTPMSGBYTESEND total_send_msg_b integer 24
messages that are successfully sent

SMTPMBYSNSEC smtp_send_msg_bps double 24 Number of bytes sent per second

NUM_BYTES_SRC total_bytes_send_count integer 24 Total number of bytes sent

SMTPBYSNTSEC smtp_send_bps double 24 Number of bytes sent per second

SMTPRCPSENT recipient_send_count integer 24 Number of recipients sent by the SMTP Send Connector

Average recipients per message handled by the SMTP Send


SMTPAVRCPMSG msg_recipients_count double 24
Connector

Average number of bytes per message sent by this SMTP Send


SMTPAMBYTMSG bytes_per_msg_count double 24
Connector

Average number of messages per connection sent by this


SMTPAVMSGCNN msgs_per_conn_count double 24
SMTP Send Connector

Average number of bytes sent per connection by this SMTP


SMTPAVBYCNN bytes_per_conn_count double 24
Send Connector

Number of DNS Errors encountered by the send connector in


SMTPDNSERRLH dns_err_last_hour_count integer 24
the last hour

Number of connection falures with IPv4 SMTP host


SMTPCNNFAILLHIPV4 conn_failures_last_hour_ipv4_count integer 24
encountered by the send connector in the last hour.

Number of connection falures with IPv6 SMTP host


SMTPCNNFAILLHIPV6 conn_failures_last_hour_ipv6_count integer 24
encountered by the send connector in the last hour.

Number of socket errors with IPv4 SMTP host encountered by


SMTPSCKERRLHIPV4 socket_err_last_hour_ipv4_count integer 24
the send connector in the last hour.

Number of socket errors with IPv6 SMTP host encountered by


SMTPSCKERRLHIPV6 socket_err_last_hour_ipv6_count integer 24
the send connector in the last hour

Number of inbound proxy out transient SMTP (4xx) errors in


SMTPPROCERRLH4XX send_protocol_err_last_hour_4xx_count integer 24
the last hour

Number of inbound proxy out permanent SMTP (5xx) errors in


SMTPPROCERRLH5XX send_protocol_err_last_hour_5xx_count integer 24
the last hour

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can be the 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 958
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

This field holds the tenant id to which the row in dataset


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

The Average number of outbound connections from the SMTP Send


outbound_conn_avg_count integer 24 average
connector

The Minimum number of outbound connections from the SMTP Send


outbound_conn_min_count integer 24 min
connector

The Maximum number of outbound connections from the SMTP Send


outbound_conn_max_count integer 24 max
connector

The Average number of outbound connections established per second


outbound_conn_created_avg_count_per_s double 24 average
from the SMTP Send connector

The Minimum number of outbound connections established per second


outbound_conn_created_min_count_per_s double 24 min
from the SMTP Send connector

The Maximum number of outbound connections established per second


outbound_conn_created_max_count_per_s double 24 max
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

The Average number of messages sent by the SMTP Send connector


msg_send_avg_count_per_s double 24 average
per second

The Minimum number of messages sent by the SMTP Send connector


msg_send_min_count_per_s double 24 min
per second

The Maximum number of messages sent by the SMTP Send connector


msg_send_max_count_per_s double 24 max
per second

total_msgs_send_count integer 24 lastval Total number of messages sent by the SMTP Send connector

The Average total number of messages sent by the SMTP Send


total_msgs_send_avg_count integer 24 average
connector

The Minimum total number of messages sent by the SMTP Send


total_msgs_send_min_count integer 24 min
connector

The Maximum total number of messages sent by the SMTP Send


total_msgs_send_max_count integer 24 max
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

total_bytes_send_count integer 24 lastval Total number of bytes sent

total_bytes_send_avg_count integer 24 average The Average total number of bytes sent

total_bytes_send_min_count integer 24 min The Minimum total number of bytes sent

total_bytes_send_max_count integer 24 max The Maximum total number of bytes sent

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 recipients per message handled by the SMTP Send


msg_recipients_avg_count double 24 average
Connector

The Minimum average recipients per message handled by the SMTP


msg_recipients_min_count double 24 min
Send Connector

The Maximum average recipients per message handled by the SMTP


msg_recipients_max_count double 24 max
Send Connector

Average number of bytes per message sent by this SMTP Send


bytes_per_msg_count double 24 lastval
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

Average number of messages per connection sent by this SMTP Send


msgs_per_conn_count double 24 lastval
Connector

The Average number of messages per connection sent by this SMTP


msgs_per_conn_avg_count double 24 average
Send Connector

The Minimum average number of messages per connection sent by this


msgs_per_conn_min_count double 24 min
SMTP Send Connector

The Maximum average number of messages per connection sent by


msgs_per_conn_max_count double 24 max
this SMTP Send Connector

Average number of bytes sent per connection by this SMTP Send


bytes_per_conn_count double 24 lastval
Connector

The Average number of bytes sent per connection by this SMTP Send
bytes_per_conn_avg_count double 24 average
Connector

The Minimum average number of bytes sent per connection by this


bytes_per_conn_min_count double 24 min
SMTP Send Connector

The Maximum average number of bytes sent per connection by this


bytes_per_conn_max_count double 24 max
SMTP Send Connector

Number of DNS Errors encountered by the send connector in the last


dns_err_last_hour_count integer 24 lastval
hour

The Average number of DNS Errors encountered by the send connector


dns_err_last_hour_avg_count integer 24 average
in the last hour

The Minimum number of DNS Errors encountered by the send


dns_err_last_hour_min_count integer 24 min
connector in the last hour

The Maximum number of DNS Errors encountered by the send


dns_err_last_hour_max_count integer 24 max
connector in the last hour

Number of connection falures with IPv4 SMTP host encountered by the


conn_failures_last_hour_ipv4_count integer 24 lastval
send connector in the last hour.

The Average number of connection falures with IPv4 SMTP host


conn_failures_last_hour_ipv4_avg_count integer 24 average
encountered by the send connector in the last hour.

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

The Minimum number of connection falures with IPv4 SMTP host


conn_failures_last_hour_ipv4_min_count integer 24 min
encountered by the send connector in the last hour.

The Maximum number of connection falures with IPv4 SMTP host


conn_failures_last_hour_ipv4_max_count integer 24 max
encountered by the send connector in the last hour.

Number of connection falures with IPv6 SMTP host encountered by the


conn_failures_last_hour_ipv6_count integer 24 lastval
send connector in the last hour.

The Average number of connection falures with IPv6 SMTP host


conn_failures_last_hour_ipv6_avg_count integer 24 average
encountered by the send connector in the last hour.

The Minimum number of connection falures with IPv6 SMTP host


conn_failures_last_hour_ipv6_min_count integer 24 min
encountered by the send connector in the last hour.

The Maximum number of connection falures with IPv6 SMTP host


conn_failures_last_hour_ipv6_max_count integer 24 max
encountered by the send connector in the last hour.

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.

The Minimum number of socket errors with IPv4 SMTP host


socket_err_last_hour_ipv4_min_count integer 24 min
encountered by the send connector in the last hour.

The Maximum number of socket errors with IPv4 SMTP host


socket_err_last_hour_ipv4_max_count integer 24 max
encountered 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

The Minimum number of socket errors with IPv6 SMTP host


socket_err_last_hour_ipv6_min_count integer 24 min
encountered by the send connector in the last hour

The Maximum number of socket errors with IPv6 SMTP host


socket_err_last_hour_ipv6_max_count integer 24 max
encountered 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

The Maximum number of inbound proxy out transient SMTP (4xx)


send_protocol_err_last_hour_4xx_max_count integer 24 max
errors 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

The Average number of inbound proxy out permanent SMTP (5xx)


send_protocol_err_last_hour_5xx_avg_count integer 24 average
errors in the last hour

The Minimum number of inbound proxy out permanent SMTP (5xx)


send_protocol_err_last_hour_5xx_min_count integer 24 min
errors in the last hour

The Maximum number of inbound proxy out permanent SMTP (5xx)


send_protocol_err_last_hour_5xx_max_count integer 24 max
errors in the last hour

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

send_connector_instance_name_id string 255 Name of the SMTP Send Connector

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

The Average number of outbound connections from the SMTP Send


outbound_conn_avg_count integer 24 average
connector

The Minimum number of outbound connections from the SMTP Send


outbound_conn_min_count integer 24 min
connector

The Maximum number of outbound connections from the SMTP Send


outbound_conn_max_count integer 24 max
connector

The Average number of outbound connections established per second


outbound_conn_created_avg_count_per_s double 24 average
from the SMTP Send connector

The Minimum number of outbound connections established per second


outbound_conn_created_min_count_per_s double 24 min
from the SMTP Send connector

The Maximum number of outbound connections established per second


outbound_conn_created_max_count_per_s double 24 max
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

The Average number of messages sent by the SMTP Send connector


msg_send_avg_count_per_s double 24 average
per second

The Minimum number of messages sent by the SMTP Send connector


msg_send_min_count_per_s double 24 min
per second

The Maximum number of messages sent by the SMTP Send connector


msg_send_max_count_per_s double 24 max
per second

total_msgs_send_count integer 24 lastval Total number of messages sent by the SMTP Send connector

The Average total number of messages sent by the SMTP Send


total_msgs_send_avg_count integer 24 average
connector

The Minimum total number of messages sent by the SMTP Send


total_msgs_send_min_count integer 24 min
connector

The Maximum total number of messages sent by the SMTP Send


total_msgs_send_max_count integer 24 max
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

total_bytes_send_count integer 24 lastval Total number of bytes sent

total_bytes_send_avg_count integer 24 average The Average total number of bytes sent

total_bytes_send_min_count integer 24 min The Minimum total number of bytes sent

total_bytes_send_max_count integer 24 max The Maximum total number of bytes sent

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 recipients per message handled by the SMTP Send


msg_recipients_avg_count double 24 average
Connector

The Minimum average recipients per message handled by the SMTP


msg_recipients_min_count double 24 min
Send Connector

The Maximum average recipients per message handled by the SMTP


msg_recipients_max_count double 24 max
Send Connector

Average number of bytes per message sent by this SMTP Send


bytes_per_msg_count double 24 lastval
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

Average number of messages per connection sent by this SMTP Send


msgs_per_conn_count double 24 lastval
Connector

The Average number of messages per connection sent by this SMTP


msgs_per_conn_avg_count double 24 average
Send Connector

The Minimum average number of messages per connection sent by this


msgs_per_conn_min_count double 24 min
SMTP Send Connector

The Maximum average number of messages per connection sent by


msgs_per_conn_max_count double 24 max
this SMTP Send Connector

Average number of bytes sent per connection by this SMTP Send


bytes_per_conn_count double 24 lastval
Connector

The Average number of bytes sent per connection by this SMTP Send
bytes_per_conn_avg_count double 24 average
Connector

The Minimum average number of bytes sent per connection by this


bytes_per_conn_min_count double 24 min
SMTP Send Connector

The Maximum average number of bytes sent per connection by this


bytes_per_conn_max_count double 24 max
SMTP Send Connector

Number of DNS Errors encountered by the send connector in the last


dns_err_last_hour_count integer 24 lastval
hour

The Average number of DNS Errors encountered by the send connector


dns_err_last_hour_avg_count integer 24 average
in the last hour

The Minimum number of DNS Errors encountered by the send


dns_err_last_hour_min_count integer 24 min
connector in the last hour

The Maximum number of DNS Errors encountered by the send


dns_err_last_hour_max_count integer 24 max
connector in the last hour

Number of connection falures with IPv4 SMTP host encountered by the


conn_failures_last_hour_ipv4_count integer 24 lastval
send connector in the last hour.

The Average number of connection falures with IPv4 SMTP host


conn_failures_last_hour_ipv4_avg_count integer 24 average
encountered by the send connector in the last hour.

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

The Minimum number of connection falures with IPv4 SMTP host


conn_failures_last_hour_ipv4_min_count integer 24 min
encountered by the send connector in the last hour.

The Maximum number of connection falures with IPv4 SMTP host


conn_failures_last_hour_ipv4_max_count integer 24 max
encountered by the send connector in the last hour.

Number of connection falures with IPv6 SMTP host encountered by the


conn_failures_last_hour_ipv6_count integer 24 lastval
send connector in the last hour.

The Average number of connection falures with IPv6 SMTP host


conn_failures_last_hour_ipv6_avg_count integer 24 average
encountered by the send connector in the last hour.

The Minimum number of connection falures with IPv6 SMTP host


conn_failures_last_hour_ipv6_min_count integer 24 min
encountered by the send connector in the last hour.

The Maximum number of connection falures with IPv6 SMTP host


conn_failures_last_hour_ipv6_max_count integer 24 max
encountered by the send connector in the last hour.

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.

The Minimum number of socket errors with IPv4 SMTP host


socket_err_last_hour_ipv4_min_count integer 24 min
encountered by the send connector in the last hour.

The Maximum number of socket errors with IPv4 SMTP host


socket_err_last_hour_ipv4_max_count integer 24 max
encountered 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

The Minimum number of socket errors with IPv6 SMTP host


socket_err_last_hour_ipv6_min_count integer 24 min
encountered by the send connector in the last hour

The Maximum number of socket errors with IPv6 SMTP host


socket_err_last_hour_ipv6_max_count integer 24 max
encountered 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

The Maximum number of inbound proxy out transient SMTP (4xx)


send_protocol_err_last_hour_4xx_max_count integer 24 max
errors 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

The Average number of inbound proxy out permanent SMTP (5xx)


send_protocol_err_last_hour_5xx_avg_count integer 24 average
errors in the last hour

The Minimum number of inbound proxy out permanent SMTP (5xx)


send_protocol_err_last_hour_5xx_min_count integer 24 min
errors in the last hour

The Maximum number of inbound proxy out permanent SMTP (5xx)


send_protocol_err_last_hour_5xx_max_count integer 24 max
errors in the last hour

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

send_connector_instance_name_id string 255 Name of the SMTP Send Connector

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_NAME smtp_send_connector_instance_name string 255 Name of the SMTP Send old Connector

The number of outbound connections from the SMTP


SMTPCONNCURR smtp_send_outbound_conn_count integer 24
Send old connector

Number of outbound connections established per


SMTPCNCRSEC smtp_send_outbound_conn_created_count_per_s double 24
second from the SMTP Send old connector

Number of connections ever made from the SMTP


SMTPCONNTOT smtp_send_total_conn_count integer 24
Send old connector

Number of messages sent by the SMTP Send old


SMTPMSGSNSEC smtp_msg_send_count_per_s double 24
connector per second

Total number of messages sent by the SMTP Send


SMTPMSGSEND smtp_total_send_msgs_count integer 24
old connector

Total number of SMTP old bytes sent, this number


SMTPMSGBYTESEND smtp_total_send_msg_b integer 24
only includes messages that are successfully sent

SMTPMBYSNSEC smtp_send_msg_bps double 24 Number of SMTP old bytes sent per second

SMTPBYTESEND smtp_total_bytes_send_count integer 24 Total number of SMTP Old bytes sent

SMTPBYSNTSEC smtp_send_bps double 24 Number of SMTP Send Old bytes per second

Number of recipients sent by the SMTP Send old


SMTPRCPSENT smtp_recipient_send_count integer 24
Connector

Average recipients per message handled by the


SMTPAVRCPMSG smtp_send_msg_recipients_count double 24
SMTP Send old Connector

Average number of bytes per message sent by this


SMTPAMBYTMSG smtp_send_bytes_per_msg_count double 24
SMTP Send old Connector

Average number of messages per connection sent by


SMTPAVMSGCNN smtp_send_msg_per_conn_count double 24
this SMTP Send old Connector

Average number of bytes sent per connection by this


SMTPAVBYCNN smtp_send_bytes_per_conn_count double 24
SMTP Send old Connector

Number of DNS Errors encountered by the SMTP


SMTPDNSERR smtp_send_dns_err_count integer 24
Send Old connector

Number of connection falures with smtp host


SMTPCNNFAIL smtp_send_conn_fail_count integer 24
encountered by the SMTP Send Old connector

Number of socket errors with smtp host encountered


SMTPSCKERR smtp_send_socket_err_count integer 24
by the SMTP Send Old connector

SMTPPROCERR smtp_send_protocol_err_count integer 24 Number of SMTP Send Old Protocol Errors

The sample time field which holds value in unix


timestamp_utc timestamp_utc_s integer 24
epoch

The sample collection time field which holds value in


timestamp_utc_collector timestamp_utc_collector_s integer 24
unix epoch

Source of the Metric Collection that produced this


data row. It can be the name of hostname if the
collection_source collection_source string 255
source is AMC else if its empty it will be Agent
Streaming

This field holds the tenant id to which the row in


tenant_id tenant_id string 255 dataset belongs to. Needed to apply row level access
policies to control access to data.

Indicates the type of the data producer that ingested


producer_instance_type producer_instance_type string 50
the data. 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 968
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

ID that uniquely identifies the data producer instance


producer_instance_id producer_instance_id string 255
within a producer type

Holds the local ID of the entity in UCMDB. [entity


cmdb_id cmdb_id uuid type] should be used 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 in the field name if
cmdb_global_id cmdb_global_id uuid
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 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
CollectionConfigName collection_policy_name string 255 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: "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


MonitoredSystem node_fqdn string 255 monitored. That is the server to which the data
belongs

IPV4 address of the server being monitored if using


node_ipv4_address node_ipv4_address string 50
IPV4.

The IP address of the monitored server. Encoded as


node_ipv6_address node_ipv6_address string 50 IPv6 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name


MonitoredSystemID node_short_name string 255
must not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For example: +1, +4.5, -8

Is the data received during downtime of related


null received_in_downtime boolean
entity

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

The number of outbound connections from the SMTP Send old


smtp_send_outbound_conn_count integer 24 lastval
connector

The Average number of outbound connections from the SMTP


smtp_send_outbound_conn_avg_count integer 24 average
Send old connector

The Minimum number of outbound connections from the


smtp_send_outbound_conn_min_count integer 24 min
SMTP Send old connector

The Maximum number of outbound connections from the


smtp_send_outbound_conn_max_count integer 24 max
SMTP Send old connector

The Average number of outbound connections established


smtp_send_outbound_conn_created_avg_count_per_s double 24 average
per second from the SMTP Send old connector

The Minimum number of outbound connections established


smtp_send_outbound_conn_created_min_count_per_s double 24 min
per second from the SMTP Send old connector

The Maximum number of outbound connections established


smtp_send_outbound_conn_created_max_count_per_s double 24 max
per second from the SMTP Send old connector

Number of connections ever made from the SMTP Send old


smtp_send_total_conn_count integer 24 lastval
connector

The Average number of connections ever made from the


smtp_send_total_conn_avg_count integer 24 average
SMTP Send old connector

The Minimum number of connections ever made from the


smtp_send_total_conn_min_count integer 24 min
SMTP Send old connector

The Maximum number of connections ever made from the


smtp_send_total_conn_max_count integer 24 max
SMTP Send old connector

The Average number of messages sent by the SMTP Send old


smtp_msg_send_avg_count_per_s double 24 average
connector per second

The Minimum number of messages sent by the SMTP Send old


smtp_msg_send_min_count_per_s double 24 min
connector per second

The Maximum number of messages sent by the SMTP Send


smtp_msg_send_max_count_per_s double 24 max
old connector per second

Total number of messages sent by the SMTP Send old


smtp_total_send_msgs_count integer 24 lastval
connector

The Average total number of messages sent by the SMTP


smtp_total_send_msgs_avg_count integer 24 average
Send old connector

The Minimum total number of messages sent by the SMTP


smtp_total_send_msgs_min_count integer 24 min
Send old connector

The Maximum total number of messages sent by the SMTP


smtp_total_send_msgs_max_count integer 24 max
Send old connector

The Average total number of SMTP old bytes sent, this


smtp_total_send_msg_avg_b integer 24 average
number only includes messages that are successfully sent

The Minimum total number of SMTP old bytes sent, this


smtp_total_send_msg_min_b integer 24 min
number only includes messages that are successfully sent

The Maximum total number of SMTP old bytes sent, this


smtp_total_send_msg_max_b integer 24 max
number only includes messages that are successfully sent

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_count integer 24 lastval Total number of SMTP Old bytes sent

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

The Average number of recipients sent by the SMTP Send old


smtp_recipient_send_avg_count integer 24 average
Connector

The Minimum number of recipients sent by the SMTP Send old


smtp_recipient_send_min_count integer 24 min
Connector

The Maximum number of recipients sent by the SMTP Send


smtp_recipient_send_max_count integer 24 max
old Connector

Average recipients per message handled by the SMTP Send


smtp_send_msg_recipients_count double 24 lastval
old Connector

The Average recipients per message handled by the SMTP


smtp_send_msg_recipients_avg_count double 24 average
Send old Connector

The Minimum average recipients per message handled by the


smtp_send_msg_recipients_min_count double 24 min
SMTP Send old Connector

The Maximum average recipients per message handled by


smtp_send_msg_recipients_max_count double 24 max
the SMTP Send old Connector

Average number of bytes per message sent by this SMTP


smtp_send_bytes_per_msg_count double 24 lastval
Send old Connector

The Average number of bytes per message sent by this SMTP


smtp_send_bytes_per_msg_avg_count double 24 average
Send old Connector

The Minimum average number of bytes per message sent by


smtp_send_bytes_per_msg_min_count double 24 min
this SMTP Send old Connector

The Maximum average number of bytes per message sent by


smtp_send_bytes_per_msg_max_count double 24 max
this SMTP Send old Connector

Average number of messages per connection sent by this


smtp_send_msg_per_conn_count double 24 lastval
SMTP Send old Connector

The Average number of messages per connection sent by this


smtp_send_msg_per_conn_avg_count double 24 average
SMTP Send old Connector

The Minimum average number of messages per connection


smtp_send_msg_per_conn_min_count double 24 min
sent by this SMTP Send old Connector

The Maximum average number of messages per connection


smtp_send_msg_per_conn_max_count double 24 max
sent by this SMTP Send old Connector

Average number of bytes sent per connection by this SMTP


smtp_send_bytes_per_conn_count double 24 lastval
Send old Connector

The Average number of bytes sent per connection by this


smtp_send_bytes_per_conn_avg_count double 24 average
SMTP Send old Connector

The Minimum average number of bytes sent per connection


smtp_send_bytes_per_conn_min_count double 24 min
by this SMTP Send old Connector

The Maximum average number of bytes sent per connection


smtp_send_bytes_per_conn_max_count double 24 max
by this SMTP Send old Connector

Number of DNS Errors encountered by the SMTP Send Old


smtp_send_dns_err_count integer 24 lastval
connector

The Average number of DNS Errors encountered by the SMTP


smtp_send_dns_err_avg_count integer 24 average
Send Old connector

The Minimum number of DNS Errors encountered by the SMTP


smtp_send_dns_err_min_count integer 24 min
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

The Maximum number of DNS Errors encountered by the


smtp_send_dns_err_max_count integer 24 max
SMTP Send Old connector

Number of connection falures with smtp host encountered by


smtp_send_conn_fail_count integer 24 lastval
the SMTP Send Old connector

The Average number of connection falures with smtp host


smtp_send_conn_fail_avg_count integer 24 average
encountered by the SMTP Send Old connector

The Minimum number of connection falures with smtp host


smtp_send_conn_fail_min_count integer 24 min
encountered by the SMTP Send Old connector

The Maximum number of connection falures with smtp host


smtp_send_conn_fail_max_count integer 24 max
encountered by the SMTP Send Old connector

Number of socket errors with smtp host encountered by the


smtp_send_socket_err_count integer 24 lastval
SMTP Send Old connector

The Average number of socket errors with smtp host


smtp_send_socket_err_avg_count integer 24 average
encountered by the SMTP Send Old connector

The Minimum number of socket errors with smtp host


smtp_send_socket_err_min_count integer 24 min
encountered by the SMTP Send Old connector

The Maximum number of socket errors with smtp host


smtp_send_socket_err_max_count integer 24 max
encountered by the SMTP Send Old connector

smtp_send_protocol_err_count integer 24 lastval Number of SMTP Send Old Protocol Errors

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

Indicates the type of the data producer that ingested the


producer_instance_type string 50 lastval
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id uuid lastval be used 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]


cmdb_global_id uuid lastval should be used in 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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "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


node_ipv6_address string 50 lastval format. Fully specified ipv6 format without any simplification
rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain 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 972
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


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored.


node_fqdn_id string 255
That is the server to which the data belongs

smtp_send_connector_instance_name_id string 255 Name of the SMTP Send old Connector

This field holds the tenant id to which the row in dataset


tenant_id_id string 255 belongs 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 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

The number of outbound connections from the SMTP Send old


smtp_send_outbound_conn_count integer 24 lastval
connector

The Average number of outbound connections from the SMTP


smtp_send_outbound_conn_avg_count integer 24 average
Send old connector

The Minimum number of outbound connections from the


smtp_send_outbound_conn_min_count integer 24 min
SMTP Send old connector

The Maximum number of outbound connections from the


smtp_send_outbound_conn_max_count integer 24 max
SMTP Send old connector

The Average number of outbound connections established


smtp_send_outbound_conn_created_avg_count_per_s double 24 average
per second from the SMTP Send old connector

The Minimum number of outbound connections established


smtp_send_outbound_conn_created_min_count_per_s double 24 min
per second from the SMTP Send old connector

The Maximum number of outbound connections established


smtp_send_outbound_conn_created_max_count_per_s double 24 max
per second from the SMTP Send old connector

Number of connections ever made from the SMTP Send old


smtp_send_total_conn_count integer 24 lastval
connector

The Average number of connections ever made from the


smtp_send_total_conn_avg_count integer 24 average
SMTP Send old connector

The Minimum number of connections ever made from the


smtp_send_total_conn_min_count integer 24 min
SMTP Send old connector

The Maximum number of connections ever made from the


smtp_send_total_conn_max_count integer 24 max
SMTP Send old connector

The Average number of messages sent by the SMTP Send old


smtp_msg_send_avg_count_per_s double 24 average
connector per second

The Minimum number of messages sent by the SMTP Send old


smtp_msg_send_min_count_per_s double 24 min
connector per second

The Maximum number of messages sent by the SMTP Send


smtp_msg_send_max_count_per_s double 24 max
old connector per second

Total number of messages sent by the SMTP Send old


smtp_total_send_msgs_count integer 24 lastval
connector

The Average total number of messages sent by the SMTP


smtp_total_send_msgs_avg_count integer 24 average
Send old connector

The Minimum total number of messages sent by the SMTP


smtp_total_send_msgs_min_count integer 24 min
Send old connector

The Maximum total number of messages sent by the SMTP


smtp_total_send_msgs_max_count integer 24 max
Send old connector

The Average total number of SMTP old bytes sent, this


smtp_total_send_msg_avg_b integer 24 average
number only includes messages that are successfully sent

The Minimum total number of SMTP old bytes sent, this


smtp_total_send_msg_min_b integer 24 min
number only includes messages that are successfully sent

The Maximum total number of SMTP old bytes sent, this


smtp_total_send_msg_max_b integer 24 max
number only includes messages that are successfully sent

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_count integer 24 lastval Total number of SMTP Old bytes sent

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

The Average number of recipients sent by the SMTP Send old


smtp_recipient_send_avg_count integer 24 average
Connector

The Minimum number of recipients sent by the SMTP Send old


smtp_recipient_send_min_count integer 24 min
Connector

The Maximum number of recipients sent by the SMTP Send


smtp_recipient_send_max_count integer 24 max
old Connector

Average recipients per message handled by the SMTP Send


smtp_send_msg_recipients_count double 24 lastval
old Connector

The Average recipients per message handled by the SMTP


smtp_send_msg_recipients_avg_count double 24 average
Send old Connector

The Minimum average recipients per message handled by the


smtp_send_msg_recipients_min_count double 24 min
SMTP Send old Connector

The Maximum average recipients per message handled by


smtp_send_msg_recipients_max_count double 24 max
the SMTP Send old Connector

Average number of bytes per message sent by this SMTP


smtp_send_bytes_per_msg_count double 24 lastval
Send old Connector

The Average number of bytes per message sent by this SMTP


smtp_send_bytes_per_msg_avg_count double 24 average
Send old Connector

The Minimum average number of bytes per message sent by


smtp_send_bytes_per_msg_min_count double 24 min
this SMTP Send old Connector

The Maximum average number of bytes per message sent by


smtp_send_bytes_per_msg_max_count double 24 max
this SMTP Send old Connector

Average number of messages per connection sent by this


smtp_send_msg_per_conn_count double 24 lastval
SMTP Send old Connector

The Average number of messages per connection sent by this


smtp_send_msg_per_conn_avg_count double 24 average
SMTP Send old Connector

The Minimum average number of messages per connection


smtp_send_msg_per_conn_min_count double 24 min
sent by this SMTP Send old Connector

The Maximum average number of messages per connection


smtp_send_msg_per_conn_max_count double 24 max
sent by this SMTP Send old Connector

Average number of bytes sent per connection by this SMTP


smtp_send_bytes_per_conn_count double 24 lastval
Send old Connector

The Average number of bytes sent per connection by this


smtp_send_bytes_per_conn_avg_count double 24 average
SMTP Send old Connector

The Minimum average number of bytes sent per connection


smtp_send_bytes_per_conn_min_count double 24 min
by this SMTP Send old Connector

The Maximum average number of bytes sent per connection


smtp_send_bytes_per_conn_max_count double 24 max
by this SMTP Send old Connector

Number of DNS Errors encountered by the SMTP Send Old


smtp_send_dns_err_count integer 24 lastval
connector

The Average number of DNS Errors encountered by the SMTP


smtp_send_dns_err_avg_count integer 24 average
Send Old connector

The Minimum number of DNS Errors encountered by the SMTP


smtp_send_dns_err_min_count integer 24 min
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

The Maximum number of DNS Errors encountered by the


smtp_send_dns_err_max_count integer 24 max
SMTP Send Old connector

Number of connection falures with smtp host encountered by


smtp_send_conn_fail_count integer 24 lastval
the SMTP Send Old connector

The Average number of connection falures with smtp host


smtp_send_conn_fail_avg_count integer 24 average
encountered by the SMTP Send Old connector

The Minimum number of connection falures with smtp host


smtp_send_conn_fail_min_count integer 24 min
encountered by the SMTP Send Old connector

The Maximum number of connection falures with smtp host


smtp_send_conn_fail_max_count integer 24 max
encountered by the SMTP Send Old connector

Number of socket errors with smtp host encountered by the


smtp_send_socket_err_count integer 24 lastval
SMTP Send Old connector

The Average number of socket errors with smtp host


smtp_send_socket_err_avg_count integer 24 average
encountered by the SMTP Send Old connector

The Minimum number of socket errors with smtp host


smtp_send_socket_err_min_count integer 24 min
encountered by the SMTP Send Old connector

The Maximum number of socket errors with smtp host


smtp_send_socket_err_max_count integer 24 max
encountered by the SMTP Send Old connector

smtp_send_protocol_err_count integer 24 lastval Number of SMTP Send Old Protocol Errors

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

Indicates the type of the data producer that ingested the


producer_instance_type string 50 lastval
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id uuid lastval be used 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]


cmdb_global_id uuid lastval should be used in 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
collection_data_flow string 80 lastval 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
collection_policy_name string 255 lastval 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: "SiteScope Streaming",
collection_type string 255 lastval "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


node_ipv6_address string 50 lastval format. Fully specified ipv6 format without any simplification
rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain 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 976
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


node_timezone_offset_h string 80 lastval
monitored. For example: +1, +4.5, -8

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored.


node_fqdn_id string 255
That is the server to which the data belongs

smtp_send_connector_instance_name_id string 255 Name of the SMTP Send old Connector

This field holds the tenant id to which the row in dataset


tenant_id_id string 255 belongs 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

STORENAME store_instance_name string 255 Instance Name of the Information Store

RPCREQ rpc_req_count integer 24 The number of MAPI RPC requests that are currently in progress

RPCOPRSEC rpc_ops_count_per_s double 24 Number of RPC operations per second

RPCAVGLAT info_rpc_latency_avg_ms double 24 Average Information latency of RPC process in milliseconds

ACTMBS active_mailbox_count integer 24 Number of active mailboxes

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

The number of MAPI message objects created on the database per


MAPIMSGCRT mapi_msgs_created_count_per_s double 24
second

The number of MAPI message objects opened on the database per


MAPIMSGOP mapi_msgs_opened_count_per_s double 24
second

The number of MAPI message objects modified on the database per


MAPIMSGMOD mapi_msgs_modified_count_per_s double 24
second

The MAPI RPC Requests that are currently in progress as compared


PERRPCREQ mapi_inprogress_rpc_req_pct double 24
to the maximum allowed in percentage

QRMBCNT quarantined_mailbox_count integer 24 Indicates the number of quarantined mailboxes per database

Indicates the total number of active background tasks currently


NACTBGTSK active_background_task_count integer 24
executing

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
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

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively collects


data. For example: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

active_mailbox_count integer 24 lastval Number of active mailboxes

active_mailbox_avg_count integer 24 average The Average number of active mailboxes

active_mailbox_min_count integer 24 min The Minimum number of active mailboxes

active_mailbox_max_count integer 24 max The Maximum number of active mailboxes

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 Maximum number of messages submitted from the database per


submitted_msg_max_count_per_s double 24 max
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 Maximum number of MAPI message objects created on the database


mapi_msgs_created_max_count_per_s double 24 max
per 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 Minimum number of MAPI message objects modified on the database


mapi_msgs_modified_min_count_per_s double 24 min
per second

The Maximum number of MAPI message objects modified on the database


mapi_msgs_modified_max_count_per_s double 24 max
per 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 Maximum MAPI RPC Requests that are currently in progress as


mapi_inprogress_rpc_req_max_pct double 24 max
compared to the maximum allowed in percentage

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

The Minimum indicates the total number of active background tasks


active_background_task_min_count integer 24 min
currently executing

The Maximum indicates the total number of active background tasks


active_background_task_max_count integer 24 max
currently 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

store_instance_name_id string 255 Instance Name of the Information Store

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

active_mailbox_count integer 24 lastval Number of active mailboxes

active_mailbox_avg_count integer 24 average The Average number of active mailboxes

active_mailbox_min_count integer 24 min The Minimum number of active mailboxes

active_mailbox_max_count integer 24 max The Maximum number of active mailboxes

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 Maximum number of messages submitted from the database per


submitted_msg_max_count_per_s double 24 max
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 Maximum number of MAPI message objects created on the database


mapi_msgs_created_max_count_per_s double 24 max
per 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 Minimum number of MAPI message objects modified on the database


mapi_msgs_modified_min_count_per_s double 24 min
per second

The Maximum number of MAPI message objects modified on the database


mapi_msgs_modified_max_count_per_s double 24 max
per 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 Maximum MAPI RPC Requests that are currently in progress as


mapi_inprogress_rpc_req_max_pct double 24 max
compared to the maximum allowed in percentage

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

The Minimum indicates the total number of active background tasks


active_background_task_min_count integer 24 min
currently executing

The Maximum indicates the total number of active background tasks


active_background_task_max_count integer 24 max
currently 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the
node_fqdn_id string 255
server to which the data belongs

store_instance_name_id string 255 Instance Name of the Information Store

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

STINAME store_interface_name string 255 Store Interface Name

STIRPCRQST rpc_req_send_count integer 24 Total number of initiated RPC requests

STIRPCRQSC rpc_req_succeed_count integer 24 The total number of succeeded RPC requests

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

The failed requests in total number of RPC requests. Here,failed


STIRPCRQFP rpc_req_failed_pct double 24 means the sum of failed with error code plus failed with exception in
percentage

STIRPCRQOS rpc_req_outstanding_count integer 24 The current number of outstanding RPC requests

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)

STIRPCSLRQ rpc_slow_req_count integer 24 Total number of slow RPC requests

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

The average number of bytes, received from the server in one


STIRPCBYRA rpc_avg_recvd_b double 24
succeeded RPC call

STIROPRQST rop_req_sent_count integer 24 The total number of ROP requests, buffered for delivery

STIROPRQCP rop_req_completed_count integer 24 The total number of completed ROP requests

STIROPRQOS rop_req_outstanding_count integer 24 The total number of outstanding ROP 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
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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

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

Metric Name/Global Data


Column Name Size Description
Name Type

Holds the global ID of the entity in UCMDB. [entity type] should be


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_count integer 24 lastval Total number of initiated RPC requests

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_count integer 24 lastval The total number of succeeded 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

The Average failed requests in total number of RPC requests. Here,failed


rpc_req_failed_avg_pct double 24 average means the sum of failed with error code plus failed with exception in
percentage

The Minimum failed requests in total number of RPC requests. Here,failed


rpc_req_failed_min_pct double 24 min means the sum of failed with error code plus failed with exception in
percentage

The Maximum failed requests in total number of RPC requests. Here,failed


rpc_req_failed_max_pct double 24 max means the sum of failed with error code plus failed with exception in
percentage

The Percentile of the failed requests in total number of RPC requests.


rpc_req_failed_pctl_pct double 24 90 percentile Here,failed means the sum of failed with error code plus failed with exception
in percentage

rpc_req_outstanding_count integer 24 lastval The current number of outstanding RPC requests

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_count integer 24 lastval Total number of slow RPC requests

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_count integer 24 lastval The total number of completed ROP requests

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_count integer 24 lastval The total number of outstanding 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs

store_interface_name_id string 255 Store Interface Name

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_count integer 24 lastval Total number of initiated RPC requests

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_count integer 24 lastval The total number of succeeded 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

The Average failed requests in total number of RPC requests. Here,failed


rpc_req_failed_avg_pct double 24 average means the sum of failed with error code plus failed with exception in
percentage

The Minimum failed requests in total number of RPC requests. Here,failed


rpc_req_failed_min_pct double 24 min means the sum of failed with error code plus failed with exception in
percentage

The Maximum failed requests in total number of RPC requests. Here,failed


rpc_req_failed_max_pct double 24 max means the sum of failed with error code plus failed with exception in
percentage

The Percentile of the failed requests in total number of RPC requests.


rpc_req_failed_pctl_pct double 24 90 percentile Here,failed means the sum of failed with error code plus failed with exception
in percentage

rpc_req_outstanding_count integer 24 lastval The current number of outstanding RPC requests

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_count integer 24 lastval Total number of slow RPC requests

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_count integer 24 lastval The total number of completed ROP requests

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_count integer 24 lastval The total number of outstanding 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server
node_fqdn_id string 255
to which the data belongs

store_interface_name_id string 255 Store Interface Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

DEST_ADDR incoming_email_source_address string 255 Address of the incoming emails source

DOMAIN_NAME domain_name string 255 Domain name of the incoming mails source

SOURCE_KEY email_source_key string 255 Key to uniquely identify each 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

NUM_BYTES_DR total_bytes_sent_count double 48 Total bytes sent by the source

NUM_MSGS_SRC recvd_msg_count integer 24 Number of messages received by the source

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

incoming_email_source_address string 255 lastval Address of the incoming emails source

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_count double 48 lastval Total bytes sent by the source

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_count integer 24 lastval Number of messages received 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

email_source_key_id string 255 Key to uniquely identify each source

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

incoming_email_source_address string 255 lastval Address of the incoming emails source

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_count double 48 lastval Total bytes sent by the source

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_count integer 24 lastval Number of messages received 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

email_source_key_id string 255 Key to uniquely identify each source

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Recipient Exchange Server is a member

MBOX_NAME mailbox_srv_name string 255 Name of the Recipient Mailbox Server

RECIP_EMAIL recipient_email_address string 255 Recipient email address

NUM_BYTES_SRC total_bytes_send_count double 24 Total bytes send by the recipient

NUM_MSGS_SRC recvd_msg_count integer 24 Number of messages received by the recipient

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

mailbox_srv_name string 255 lastval Name of the Recipient Mailbox Server

total_bytes_send_count double 24 lastval Total bytes send by the recipient

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_count integer 24 lastval Number of messages received 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

recipient_email_address_id string 255 Recipient email address

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

mailbox_srv_name string 255 lastval Name of the Recipient Mailbox Server

total_bytes_send_count double 24 lastval Total bytes send by the recipient

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_count integer 24 lastval Number of messages received 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

recipient_email_address_id string 255 Recipient email address

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

ADSITE_NAME ad_site_name string 255 Name of the AD Site of which the Sender Exchange Server is a member

MBOX_NAME mailbox_name string 255 Sender Mailbox Name

SENDER_EMAIL sender_email_address string 255 Sender email address

NUM_BYTES_SRC total_bytes_send_count double 24 Total bytes sent by the sender

NUM_MSGS_SR msg_count integer 24 Number of messages sent by the sender

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

mailbox_name string 255 lastval Sender Mailbox Name

total_bytes_send_count double 24 lastval Total bytes sent by the sender

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_count integer 24 lastval Number of messages 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

sender_email_address_id string 255 Sender email address

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

mailbox_name string 255 lastval Sender Mailbox Name

total_bytes_send_count double 24 lastval Total bytes sent by the sender

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_count integer 24 lastval Number of messages 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which
node_fqdn_id string 255
the data belongs

sender_email_address_id string 255 Sender email address

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

SOURCE_ADDR source_address string 255 Address of the source of incoming emails

DOMAIN_NAME domain_name string 255 Domain name of the source of the incoming mails

SOURCE_KEY email_source_key string 255 Key to uniquely identify each source

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

NUM_BYTES_SRC total_bytes_send_count double 24 Total bytes sent by the source

NUM_MSGS_SRC recvd_msg_count integer 24 Number of messages received by the source

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

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

source_address string 255 lastval Address of the source of incoming emails

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_count double 24 lastval Total bytes sent by the source

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_count integer 24 lastval Number of messages received 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

email_source_key_id string 255 Key to uniquely identify each source

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

source_address string 255 lastval Address of the source of incoming emails

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_count double 24 lastval Total bytes sent by the source

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_count integer 24 lastval Number of messages received 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

email_source_key_id string 255 Key to uniquely identify each source

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

QINFO_ID que_identity string 255 Identity of the queue

QINFO_DLVTYPE que_delivery_type string 255 Delivery type of the queue

QINFO_NHCNNT next_hop_connector string 255 Next hop connector of the queue

QINFO_NHDOMAIN next_hop_domain string 255 Next hop domain of the queue

FOLDER_MSGCNT total_msg_count integer 24 Total messages in the queue

QINFO_LSTERR last_err_info string 255 Last error in the queue

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

que_delivery_type string 255 lastval Delivery type of the queue

next_hop_connector string 255 lastval Next hop connector of the queue

next_hop_domain string 255 lastval Next hop domain of the queue

total_msg_count integer 24 lastval Total messages in the queue

total_msg_avg_count integer 24 average The Average total messages in the queue

total_msg_min_count integer 24 min The Minimum total messages in the queue

total_msg_max_count integer 24 max The Maximum total messages in the queue

last_err_info string 255 lastval Last error in the queue

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs

que_identity_id string 255 Identity of the queue

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

que_delivery_type string 255 lastval Delivery type of the queue

next_hop_connector string 255 lastval Next hop connector of the queue

next_hop_domain string 255 lastval Next hop domain of the queue

total_msg_count integer 24 lastval Total messages in the queue

total_msg_avg_count integer 24 average The Average total messages in the queue

total_msg_min_count integer 24 min The Minimum total messages in the queue

total_msg_max_count integer 24 max The Maximum total messages in the queue

last_err_info string 255 lastval Last error in the queue

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is the server to which the
node_fqdn_id string 255
data belongs

que_identity_id string 255 Identity of the queue

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

INSTANCE_NAME transport_que_instance_name string 255 Name of the transport queue instance

ACT_MDQ_LENGTH active_mailbox_que_length_count integer 24 Length of the Active Mailbox Delivery Queue

ACT_NONSMTP_DQLENG active_non_smtp_que_length_count integer 24 Length of the Active Non-Smtp Delivery Queue

POISON_Q_LENGTH poison_que_length_count integer 24 Length of the Poison Queue

RET_MD_Q_LEN retry_mailbox_que_length_count integer 24 Length of the Retry Mailbox Delivery Queue

RETRY_NONSMTP_QLEN retry_non_smtp_que_length_count integer 24 Length of the Retry Non-Smtp Delivery Queue

SUB_Q_LENGTH submission_que_length_count integer 24 Length of the Submission Queue

UNREACH_Q_LENGTH unreachable_que_length_count integer 24 Length of the Unreachable Queue

The number of items in the active remote delivery queue


ACT_XREM_DQLENGTH active_external_delivery_que_items_count integer 24
to external destinations

The number of items in the active remote delivery queues


ACT_IREM_DQLENGTH active_internal_delivery_que_items_count integer 24
to internal destinations

The number of external items set for "retry" in the remote


RET_XREM_DQLENGTH retry_external_delivery_que_items_count integer 24
delivery queues

The number of internal items in retry in the remote


RET_IREM_DQLENGTH retry_internal_delivery_que_items_count integer 24
delivery queues

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

AGSHDQLEN agg_shadow_que_items_count integer 24 Current count of messages in all shadow queues

The number of internal items queued for delivery in all


AGGDEL_IALLQ_LEN internal_agg_delivery_que_items_count integer 24
queues

The number of external items queued for delivery in all


AGGDEL_XALLQ_LEN external_agg_delivery_que_items_count integer 24
queues

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data


collection_source collection_source string 255 row. It can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id producer_instance_id string 255
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id cmdb_id uuid should be used 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]


cmdb_global_id cmdb_global_id uuid should be used 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 1011
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

Values are Push or Pull. Push:Data producer (producer


instance id) actively pushes data directly to COSO.
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service -
Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being


MonitoredSystem node_fqdn string 255
monitored. That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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_count integer 24 lastval Length of the Active Mailbox Delivery Queue

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_count integer 24 lastval Length of the Active Non-Smtp 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

poison_que_length_count integer 24 lastval Length of the Poison Queue

poison_que_length_avg_count integer 24 average The Average length of the Poison Queue

poison_que_length_min_count integer 24 min The Minimum length of the Poison Queue

poison_que_length_max_count integer 24 max The Maximum length of the Poison Queue

retry_mailbox_que_length_count integer 24 lastval Length of the Retry Mailbox 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_count integer 24 lastval Length of the Retry Non-Smtp 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

submission_que_length_count integer 24 lastval Length of the Submission Queue

submission_que_length_avg_count integer 24 average The Average length of the Submission Queue

submission_que_length_min_count integer 24 min The Minimum length of the Submission Queue

submission_que_length_max_count integer 24 max The Maximum length of the Submission Queue

unreachable_que_length_count integer 24 lastval Length of the Unreachable Queue

unreachable_que_length_avg_count integer 24 average The Average length of the Unreachable Queue

unreachable_que_length_min_count integer 24 min The Minimum length of the Unreachable Queue

unreachable_que_length_max_count integer 24 max The Maximum length of the Unreachable Queue

The number of items in the active remote delivery queue to


active_external_delivery_que_items_count integer 24 lastval
external destinations

The Average number of items in the active remote delivery queue


active_external_delivery_que_items_avg_count integer 24 average
to external destinations

The Minimum number of items in the active remote delivery queue


active_external_delivery_que_items_min_count integer 24 min
to external destinations

The Maximum number of items in the active remote delivery queue


active_external_delivery_que_items_max_count integer 24 max
to external destinations

The number of items in the active remote delivery queues to


active_internal_delivery_que_items_count integer 24 lastval
internal destinations

The Average number of items in the active remote delivery queues


active_internal_delivery_que_items_avg_count integer 24 average
to internal destinations

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 Minimum number of items in the active remote delivery


active_internal_delivery_que_items_min_count integer 24 min
queues to internal destinations

The Maximum number of items in the active remote delivery


active_internal_delivery_que_items_max_count integer 24 max
queues to internal destinations

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

The Minimum number of external items set for "retry" in the


retry_external_delivery_que_items_min_count integer 24 min
remote delivery queues

The Maximum number of external items set for "retry" in the


retry_external_delivery_que_items_max_count integer 24 max
remote delivery queues

retry_internal_delivery_que_items_count integer 24 lastval The number of internal items in retry in the remote delivery queues

The Average number of internal items in retry in the remote


retry_internal_delivery_que_items_avg_count integer 24 average
delivery queues

The Minimum number of internal items in retry in the remote


retry_internal_delivery_que_items_min_count integer 24 min
delivery queues

The Maximum number of internal items in retry in the remote


retry_internal_delivery_que_items_max_count integer 24 max
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

The Minimum number of internal items in the largest delivery


internal_largest_delivery_que_items_min_count integer 24 min
queue

The Maximum number of internal items in the largest delivery


internal_largest_delivery_que_items_max_count integer 24 max
queue

external_largest_delivery_que_items_count integer 24 lastval The number of external items in the largest delivery queue

The Average number of external items in the largest delivery


external_largest_delivery_que_items_avg_count integer 24 average
queue

The Minimum number of external items in the largest delivery


external_largest_delivery_que_items_min_count integer 24 min
queue

The Maximum number of external items in the largest delivery


external_largest_delivery_que_items_max_count integer 24 max
queue

agg_shadow_que_items_count integer 24 lastval Current count of messages in all shadow queues

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

The Average number of internal items queued for delivery in all


internal_agg_delivery_que_items_avg_count integer 24 average
queues

The Minimum number of internal items queued for delivery in all


internal_agg_delivery_que_items_min_count integer 24 min
queues

The Maximum number of internal items queued for delivery in all


internal_agg_delivery_que_items_max_count integer 24 max
queues

external_agg_delivery_que_items_count integer 24 lastval The number of external items queued for delivery in all queues

The Average number of external items queued for delivery in all


external_agg_delivery_que_items_avg_count integer 24 average
queues

The Minimum number of external items queued for delivery in all


external_agg_delivery_que_items_min_count integer 24 min
queues

The Maximum number of external items queued for delivery in all


external_agg_delivery_que_items_max_count integer 24 max
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

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id uuid lastval used 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


cmdb_global_id uuid lastval used in 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
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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: "SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
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.


node_ipv6_address string 50 lastval
Fully specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is


node_fqdn_id string 255
the server to which the data belongs

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

transport_que_instance_name_id string 255 Name of the transport queue instance

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_count integer 24 lastval Length of the Active Mailbox Delivery Queue

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_count integer 24 lastval Length of the Active Non-Smtp 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

poison_que_length_count integer 24 lastval Length of the Poison Queue

poison_que_length_avg_count integer 24 average The Average length of the Poison Queue

poison_que_length_min_count integer 24 min The Minimum length of the Poison Queue

poison_que_length_max_count integer 24 max The Maximum length of the Poison Queue

retry_mailbox_que_length_count integer 24 lastval Length of the Retry Mailbox 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_count integer 24 lastval Length of the Retry Non-Smtp 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

submission_que_length_count integer 24 lastval Length of the Submission Queue

submission_que_length_avg_count integer 24 average The Average length of the Submission Queue

submission_que_length_min_count integer 24 min The Minimum length of the Submission Queue

submission_que_length_max_count integer 24 max The Maximum length of the Submission Queue

unreachable_que_length_count integer 24 lastval Length of the Unreachable Queue

unreachable_que_length_avg_count integer 24 average The Average length of the Unreachable Queue

unreachable_que_length_min_count integer 24 min The Minimum length of the Unreachable Queue

unreachable_que_length_max_count integer 24 max The Maximum length of the Unreachable Queue

The number of items in the active remote delivery queue to


active_external_delivery_que_items_count integer 24 lastval
external destinations

The Average number of items in the active remote delivery queue


active_external_delivery_que_items_avg_count integer 24 average
to external destinations

The Minimum number of items in the active remote delivery queue


active_external_delivery_que_items_min_count integer 24 min
to external destinations

The Maximum number of items in the active remote delivery queue


active_external_delivery_que_items_max_count integer 24 max
to external destinations

The number of items in the active remote delivery queues to


active_internal_delivery_que_items_count integer 24 lastval
internal destinations

The Average number of items in the active remote delivery queues


active_internal_delivery_que_items_avg_count integer 24 average
to internal destinations

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 Minimum number of items in the active remote delivery


active_internal_delivery_que_items_min_count integer 24 min
queues to internal destinations

The Maximum number of items in the active remote delivery


active_internal_delivery_que_items_max_count integer 24 max
queues to internal destinations

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

The Minimum number of external items set for "retry" in the


retry_external_delivery_que_items_min_count integer 24 min
remote delivery queues

The Maximum number of external items set for "retry" in the


retry_external_delivery_que_items_max_count integer 24 max
remote delivery queues

retry_internal_delivery_que_items_count integer 24 lastval The number of internal items in retry in the remote delivery queues

The Average number of internal items in retry in the remote


retry_internal_delivery_que_items_avg_count integer 24 average
delivery queues

The Minimum number of internal items in retry in the remote


retry_internal_delivery_que_items_min_count integer 24 min
delivery queues

The Maximum number of internal items in retry in the remote


retry_internal_delivery_que_items_max_count integer 24 max
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

The Minimum number of internal items in the largest delivery


internal_largest_delivery_que_items_min_count integer 24 min
queue

The Maximum number of internal items in the largest delivery


internal_largest_delivery_que_items_max_count integer 24 max
queue

external_largest_delivery_que_items_count integer 24 lastval The number of external items in the largest delivery queue

The Average number of external items in the largest delivery


external_largest_delivery_que_items_avg_count integer 24 average
queue

The Minimum number of external items in the largest delivery


external_largest_delivery_que_items_min_count integer 24 min
queue

The Maximum number of external items in the largest delivery


external_largest_delivery_que_items_max_count integer 24 max
queue

agg_shadow_que_items_count integer 24 lastval Current count of messages in all shadow queues

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

The Average number of internal items queued for delivery in all


internal_agg_delivery_que_items_avg_count integer 24 average
queues

The Minimum number of internal items queued for delivery in all


internal_agg_delivery_que_items_min_count integer 24 min
queues

The Maximum number of internal items queued for delivery in all


internal_agg_delivery_que_items_max_count integer 24 max
queues

external_agg_delivery_que_items_count integer 24 lastval The number of external items queued for delivery in all queues

The Average number of external items queued for delivery in all


external_agg_delivery_que_items_avg_count integer 24 average
queues

The Minimum number of external items queued for delivery in all


external_agg_delivery_que_items_min_count integer 24 min
queues

The Maximum number of external items queued for delivery in all


external_agg_delivery_que_items_max_count integer 24 max
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

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id uuid lastval used 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


cmdb_global_id uuid lastval used in 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
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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: "SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
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.


node_ipv6_address string 50 lastval
Fully specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

The fully qualified hostname of the server being monitored. That is


node_fqdn_id string 255
the server to which the data belongs

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

transport_que_instance_name_id string 255 Name of the transport queue instance

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

CURRENTCONNECTIONS webserver_curr_conn_count integer 24 Number of connections established with the web service.

INSTANCE_NAME webserver_instance_name string 255 Webserver Instance Name

Number of connections that are being attempted to the web


CONNATTEMPTSPERSEC conn_attempts_count_per_s integer 24
service.

Rate of internet server API extension requests which are


ISAPIEXTNREQPERSEC internet_srv_api_extn_req_count_per_s integer 24
received by the web service.

HTTP requests that do not use the enlisted methods: OPTIONS,


OTHERREQMETHPERSEC other_req_methods_count_per_s integer 24 GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL,
PROPFIND, PROPPATCH, SEARCH, LOCK or UNLOCK.

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming", "Operations
collection_type collection_type string 255
Agent Streaming", "Collection Service - Agent", "BPM Probe",
RUM Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 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 1019
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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 number of connections that are being attempted to the


conn_attempts_avg_count_per_s integer 24 average
web service.

The Minimum number of connections that are being attempted to the


conn_attempts_min_count_per_s integer 24 min
web service.

The Maximum number of connections that are being attempted to the


conn_attempts_max_count_per_s integer 24 max
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 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 1021
AI Operations Management - Containerized 24.4

Data Aggregation
Column Name Size Description
Type Type

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

webserver_instance_name_id string 255 Webserver Instance Name

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 number of connections that are being attempted to the


conn_attempts_avg_count_per_s integer 24 average
web service.

The Minimum number of connections that are being attempted to the


conn_attempts_min_count_per_s integer 24 min
web service.

The Maximum number of connections that are being attempted to the


conn_attempts_max_count_per_s integer 24 max
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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 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 1023
AI Operations Management - Containerized 24.4

Data Aggregation
Column Name Size Description
Type Type

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

webserver_instance_name_id string 255 Webserver Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

The value is 1 when Exchange Webserver URL is not accessible and 0 if it


EWSURL exchange_webserver_url_err integer 24
is accessible

SERVERNAME exchange_webserver_name string 255 Exchange Server 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

null exchange_server_fqdn string 255 Fqdn of the Exchange Server

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

INSTANCE_NAME workload_instance_name string 255 Workload 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 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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

workload_instance_name_id string 255 Workload Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

exchange_server_fqdn_id string 255 Fqdn of the Exchange Server

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

workload_instance_name_id string 255 Workload Instance Name

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

1.4.2.5. Management Pack for Microsoft SQL Server


This section provides you information about the Management Pack for Microsoft SQL Server:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_mssql_virtual_device_size opsb_mssql_virtual_device_size_1h opsb_mssql_virtual_device_size_1d

opsb_mssql_table_size opsb_mssql_table_size_1h opsb_mssql_table_size_1d

opsb_mssql_server_workload opsb_mssql_server_workload_1h opsb_mssql_server_workload_1d

opsb_mssql_server_status opsb_mssql_server_status_1h opsb_mssql_server_status_1d

opsb_mssql_server_perf opsb_mssql_server_perf_1h opsb_mssql_server_perf_1d

opsb_mssql_server_fault opsb_mssql_server_fault_1h opsb_mssql_server_fault_1d Not available

opsb_mssql_server_conf opsb_mssql_server_conf_1h opsb_mssql_server_conf_1d

opsb_mssql_server_admin opsb_mssql_server_admin_1h opsb_mssql_server_admin_1d

opsb_mssql_filegroup_size opsb_mssql_filegroup_size_1h opsb_mssql_filegroup_size_1d

opsb_mssql_db_status opsb_mssql_db_status_1h opsb_mssql_db_status_1d

opsb_mssql_db_size opsb_mssql_db_size_1h opsb_mssql_db_size_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

null mssql_virtual_device_name string 255 MSSQL Virtual Device Name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

mssql_virtual_device_name_id string 255 MSSQL Virtual Device 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

mssql_virtual_device_name_id string 255 MSSQL Virtual Device 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

null mssql_table_name string 255 MSSQL Table Name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

mssql_table_name_id string 255 MSSQL Table 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

mssql_table_name_id string 255 MSSQL Table 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 Mssql Instance Name

null mssql_srv_name string 255 MSSQL Server name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 Mssql Instance Name

mssql_srv_name_id string 255 MSSQL Server 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 Mssql Instance Name

mssql_srv_name_id string 255 MSSQL Server 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
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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

The time duration (in minutes) in an hour when the MSSQL server is in
null uptime_min double
running state.

The percentage of time in an hour when the MSSQL server is in running


null uptime_pct double
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 with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 1040
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

Percentage of times a data page was found in the


M001_CACHEHITPCT cache_hit_pct integer 24
cache

The number of read requests issued to OS that are


M007_READSOUTSTDRATE read_requests_count integer 24
not completed

The number of write requests issued to the OS not


M008_WRITSOUTSTDRATE write_requests_count integer 24
completed

M009_TRANSACTIONRATE txn_count_per_s integer 24 The server transaction count per second

M014_BLCKDPROCESSCNT blocked_process_count integer 24 The number of blocked processes

M017_CMDQUEUELENPCT cmd_queue_length_pct integer 24 The percentage of command queue length used

M025_CPUUSEDPCT cpu_used_pct integer 24 The percentage of CPU time used by SQL Server

The percentage of total connections that are active vs


M026_ACTIVECONNTNPCT active_connection_pct integer 24
sleeping

M032_RUNABLECONTNPCT runnable_connection_pct integer 24 The percentage of total connections that are runnable

M051_FULLSCANSRATE full_scan_count_per_s integer 24 The Full scans count per second

M052_INDXSEARCHSRATE index_search_count_per_s integer 24 The Index searches Count per second

M053_PGESALLOCTDRATE pages_allocated_count_per_s integer 24 The count of pages allocated per second

M054_EXTNTSALLOCRATE extents_allocated_count_per_s integer 24 The Extents allocated Count per second

M055_PAGESPLITSRATES page_split_count_per_s integer 24 The page splits count per second

M056_TBLLCKESCALRATE table_lock_escalation_count_per_s integer 24 The table lock escalation count per second

The number of active transactions for the entire


M064_DBACTIVTRANSCNT active_txn_count integer 24
server

M068_LATCHWAITSRATE latch_wait_count_per_s integer 24 The Latch waits count per second

M069_AVGLATCHWAITTIM latch_wait_time_avg integer 24 The Average latch wait time

M070_LOCKTIMEOUTRATE lock_timeout_count_per_s integer 24 The lock timeout count per second

M071_DEADLOCKSRATE deadlock_count_per_s integer 24 The Deadlocks count per second

M072_LOCKSWAITRATE lock_wait_count_per_s integer 24 The locks wait rate per object type

M073_LOCKAVGWAITTIME lock_wait_time_avg integer 24 The average lock wait time

M074_BATCHREQSTSRATE batch_request_count_per_s integer 24 The Batch requests count per second

M075_LOCKMEMORYPCT lock_memory_pct integer 24 The percentage of lock memory in use

M076_CURAVGWAITLATCH current_latch_time_avg_ms integer 24 The current average latch wait time

M089_LNGRNGJOBS long_running_jobs_count integer 24 The number of long running jobs

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

The number of commands delivered to the Subscriber


DIST_DELIVERY_CMDS distributor_delivery_command_count_per_s double 24
per second

The number of transactions per second delivered to


DIST_DELIVERY_TRANS distributor_delivery_txn_count_per_s double 24
the Subscriber

Time (in milliseconds) elapsed from when transactions


DIST_DELIVERY_LATNCY distributor_delivery_latency_ms double 24 are delivered to the Distributor to when they are
applied at the Subscriber

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

Metric Name/Global Data


Column Name Size Description
Name Type

The number of conflicts per second during Publisher


CONFLICTS_COUNT_PER_SEC conflicts_count_per_s double 24
or Subscriber upload and download.

The number of rows per second replicated from the


DOWNLOAD_CHANGE_SEC downloaded_changes_count_per_s double 24
Publisher to the Subscriber.

The number of rows per second replicated from the


UPLOADED_CHANGES_SEC uploaded_changes_count_per_s double 24
Subscriber to the Publisher

The number of Snapshot commands per second


SNAPSHOT_DLVRY_CMDS snapshot_delivered_command_count_per_s double 24
delivered to the Distributor

The number of Snapshot transactions per second


SNAPSHOT_DLVRY_TRANS snapshot_delivered_txn_count_per_s double 24
delivered to the Distributor

The number of LogReader commands per second


LOGRDR_DELIVERY_CMDS log_reader_delivered_commands_count_per_s double 24
delivered to the Distributor

The number of LogReader transactions per second


LOGRDR_TRANS_SEC log_reader_delivered_txn_count_per_s double 24
delivered to the Distributor.

The time (in milliseconds) elapsed from when


LOGRDR_DLVRY_LATENCY log_reader_delivered_latency_ms double 24 transactions are applied at the Publisher to when they
are delivered to the Distributor

The number of seconds a page will stay in the buffer


BFRMGR_PAGELIFEXPCT page_life_expectancy_s double 24
pool without references.

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

The number of pages flushed by checkpoint or other


BFRMGR_CHKPNTPGP_SEC check_point_pages_count_per_s double 24
operations that require all dirty pages to be flushed.

The number of buffers written by buffer managers


BFRMGR_LZYWRTP_SEC lazy_writes_count_per_s double 24
lazy writer

The number of processes waiting for a workspace


MEMMGR_GRANTSPENDN memory_manager_grants_pending_count double 24
memory grant

The amount of physical memory, in MB immediately


MEM_AVLBL_MBYTES memory_available_mb double 24
available for allocation to a process or for system use

The number of database pages(buffer manager)


MEMMGR_TTLSVRMMRY memory_manager_total_server_memory_kb double 24
which are currently being occupied in the data cache

The total memory the server has committed to the


BFRMGR_DB_PAGES buffer_manager_db_pages_b double 24
SQL objects

The amount of memory the server is currently using


MEMMGR_STLNSRVRMEM memory_manager_stolen_server_memory_kb double 24
for the purposes other than the database pages

The number of pages are read from or written to disk


MEM_PGSPRSEC memory_written_page_count_per_s double 24
is collected

The ideal amount of memory the server is willing to


MEMMGR_TRGTSRVRMEM memory_manager_target_server_memory_kb double 24
consume

SRVSTAT_RECMPLN sql_server_recompilation_count double 24 The number of SQL Recompilation

Tracks the number of compilations per second.


Indicates the number of times the compile code path
SRVSTAT_CMPLN sql_server_compilation_count double 24
is entered. Includes compiles caused by statement-
level recompilations in SQL Server

SQL Servers Batch Requests represents the number of


SRVSTAT_BATCHRQST sql_server_batch_request_count_per_s double 24
SQL Statements that are being executed per second.

The total number of messages sent over the network


AVLBREP_SNTRN_SEC available_replica_msg_sent_per_s double 24
to the replica

The total number of messages enqueued to be send


AVLBREP_SNREP_SEC available_replica_msg_enq_sent_per_s double 24
over the network to the replica

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

Metric Name/Global Data


Column Name Size Description
Name Type

The total number of database message bytes


AVLBREP_BTSNREP_SEC available_replica_msg_byte_sent_per_s double 24
enqueued to be send over the network to the replica

The total number of bytes send over the network to


AVLBREP_BTSNTRN_SEC available_replica_byte_sent_per_s double 24
the replica

The total number of bytes received from the replica


AVLBREP_BTRCVRP_SEC available_replica_byte_receive_per_s double 24
over the network

The amount of filestream data received by the


DBREP_FLBYTRCV_SEC db_replica_file_stream_byte_receive_per_s double 24
availability replica for the database

The amount of log bytes remaining to be redone to


DBREP_REDOBYTREM db_replica_remaining_redon_byte_per_s double 24
finish the reverting phase received by the availability

The amount of log records redone in the last second


DBREP_REDONEBYT_SEC db_replica_record_redon_byte_per_s double 24
to catch up the database replica

The number of milliseconds transaction termination


DBREP_TRNDELY db_replica_txn_term_count_per_s double 24
waited for acknowledgment per second

The number of times redo gets blocked in the last


DBREP_REDOBLKD_SEC db_replica_blocked_redo_count_per_s double 24
second

The number of hardened log in kilobytes that is


DBREP_RECQUEUE db_replica_receive_queue_count_kb double 24
waiting to be redone on the secondary

The amount of logs in kilobytes that is waiting to be


DBREP_LOGSNDQUEUE db_replica_log_send_queue_kb double 24
send to the database replica

The amount of logs received by the availability replica


DBREP_LOGBYTREC db_replica_log_byte_receive double 24
for the database.

The number of availability replica(s) are having


M510_REPLCROLE availability_replica_role_count integer 24
invalid(Resolving) role

M511_SYNCSTOFDB db_replica_syncstate_count integer 24 The number of database replica(s) not synchronized

M512_JOINSTOFDB db_replica_join_state_count integer 24 The number of database replica(s) not joined

The number of availability replica(s) having unhealthy


M513_DATAMOVMNT db_replica_data_movement_count integer 24
data movement

The number of availability group having at least one


M514_FAILOVERREADY secondary_replica_failover_ready_count integer 24
secondary replica which is failover ready

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in


timestamp_utc_collector timestamp_utc_collector_s integer 24
unix epoch

Source of the Metric Collection that produced this


data row. It can be the name of hostname if the
collection_source collection_source string 255
source is AMC else if its empty it will be Agent
Streaming

This field holds the tenant id to which the row in


tenant_id tenant_id string 255 dataset belongs to. Needed to apply row level access
policies to control access to data.

Indicates the type of the data producer that ingested


producer_instance_type producer_instance_type string 50
the data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id producer_instance_id string 255
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id cmdb_id uuid should be used 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 in the field name if
cmdb_global_id cmdb_global_id uuid
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 1045
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

Values are Push or Pull. Push:Data producer (producer


instance id) actively pushes data directly to COSO.
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "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


MonitoredSystem node_fqdn string 255 monitored. That is the server to which the data
belongs

IPV4 address of the server being monitored if using


node_ipv4_address node_ipv4_address string 50
IPV4.

The IP address of the monitored server. Encoded as


node_ipv6_address node_ipv6_address string 50 IPv6 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name


MonitoredSystemID node_short_name string 255
must not contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

The Average percentage of times a data page was found in the


cache_hit_avg_pct integer 24 average
cache

The Minimum of percentage of times a data page was found in


cache_hit_min_pct integer 24 min
the cache

The Maximum of percentage of times a data page was found in


cache_hit_max_pct integer 24 max
the cache

The Percentile of number of times a data page was found in the


cache_hit_pctl_pct integer 24 90 percentile
cache

The Average number of read requests issued to OS that are not


read_requests_avg_count integer 24 average
completed

The Minimum of number of read requests issued to OS that are


read_requests_min_count integer 24 min
not completed

The Maximum of number of read requests issued to OS that are


read_requests_max_count integer 24 max
not completed

The Average number of write requests issued to the OS not


write_requests_avg_count integer 24 average
completed

The Minimum of number of write requests issued to the OS not


write_requests_min_count integer 24 min
completed

The Maximum of number of write requests issued to the OS not


write_requests_max_count integer 24 max
completed

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

blocked_process_avg_count integer 24 average The Average number of blocked processes

blocked_process_min_count integer 24 min The Minimum of number of blocked processes

blocked_process_max_count integer 24 max The Maximum of number of blocked processes

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

cmd_queue_length_pctl_pct integer 24 90 percentile The Percentile 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

The Average percentage of total connections that are active vs


active_connection_avg_pct integer 24 average
sleeping

The Minimum of percentage of total connections that are active


active_connection_min_pct integer 24 min
vs sleeping

The Maximum of percentage of total connections that are active


active_connection_max_pct integer 24 max
vs sleeping

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

The Minimum of percentage of total connections that are


runnable_connection_min_pct integer 24 min
runnable

The Maximum of percentage of total connections that are


runnable_connection_max_pct integer 24 max
runnable

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

The Minimum of number of active transactions for the entire


active_txn_min_count integer 24 min
server

The Maximum of number of active transactions for the entire


active_txn_max_count integer 24 max
server

latch_wait_avg_count_per_s integer 24 average The Average Latch waits count per second

latch_wait_min_count_per_s integer 24 min The Minimum of waits count per second

latch_wait_max_count_per_s integer 24 max The Maximum of Latch waits count per second

latch_wait_time_avg integer 24 average The average latch wait time

latch_wait_time_avg_min integer 24 min The Minimum of latch wait time

latch_wait_time_avg_max integer 24 max The Maximum of latch wait time

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

deadlock_avg_count_per_s integer 24 average The Average Deadlocks count per second

deadlock_min_count_per_s integer 24 min The Minimum of Deadlocks count per second

deadlock_max_count_per_s integer 24 max The Maximum of Deadlocks 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

lock_wait_time_avg integer 24 average The average lock wait time

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

lock_wait_time_avg_min integer 24 min The Minimum of average lock wait time

lock_wait_time_avg_max integer 24 max The Maximum of average lock wait time

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

lock_memory_avg_pct integer 24 average The average percentage of lock memory in use

lock_memory_min_pct integer 24 min The Minimum of percentage of lock memory in use

lock_memory_max_pct integer 24 max The Maximum of percentage of lock memory in use

lock_memory_pctl_pct integer 24 90 percentile The Percentile of lock memory in use

current_latch_time_avg_ms integer 24 average The current average latch wait time

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

long_running_jobs_avg_count integer 24 average The Average number of long running jobs

long_running_jobs_min_count integer 24 min The Minimum of number of long running jobs

long_running_jobs_max_count integer 24 max The Maximum of number of long running jobs

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

The Average number of commands delivered to the Subscriber


distributor_delivery_command_avg_count_per_s double 24 average
per second

The Minimum of number of commands delivered to the


distributor_delivery_command_min_count_per_s double 24 min
Subscriber per second

The Maximum of number of commands delivered to the


distributor_delivery_command_max_count_per_s double 24 max
Subscriber per second

The Average number of transactions per second delivered to the


distributor_delivery_txn_avg_count_per_s double 24 average
Subscriber

The Minimum of number of transactions per second delivered to


distributor_delivery_txn_min_count_per_s double 24 min
the Subscriber

The Maximum of number of transactions per second delivered to


distributor_delivery_txn_max_count_per_s double 24 max
the Subscriber

The Average Time (in milliseconds) elapsed from when


distributor_delivery_latency_avg_ms double 24 average transactions are delivered to the Distributor to when they are
applied at the Subscriber

The Minimum of time (in milliseconds) elapsed from when


distributor_delivery_latency_min_ms double 24 min transactions are delivered to the Distributor to when they are
applied at the Subscriber

The Maximum of time (in milliseconds) elapsed from when


distributor_delivery_latency_max_ms double 24 max transactions are delivered to the Distributor to when they are
applied at the Subscriber

The Average number of conflicts per second during Publisher or


conflicts_avg_count_per_s double 24 average
Subscriber upload and download.

The Minimum of number of conflicts per second during Publisher


conflicts_min_count_per_s double 24 min
or Subscriber upload and download.

The Maximum of number of conflicts per second during Publisher


conflicts_max_count_per_s double 24 max
or Subscriber upload and download.

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

The Average number of rows per second replicated from the


downloaded_changes_avg_count_per_s double 24 average
Publisher to the Subscriber.

The Minimum of number of rows per second replicated from the


downloaded_changes_min_count_per_s double 24 min
Publisher to the Subscriber.

The Maximum of number of rows per second replicated from the


downloaded_changes_max_count_per_s double 24 max
Publisher to the Subscriber.

The Average number of rows per second replicated from the


uploaded_changes_avg_count_per_s double 24 average
Subscriber to the Publisher

The Minimum of number of rows per second replicated from the


uploaded_changes_min_count_per_s double 24 min
Subscriber to the Publisher

The Maximum of number of rows per second replicated from the


uploaded_changes_max_count_per_s double 24 max
Subscriber to the Publisher

The Average number of Snapshot commands per second


snapshot_delivered_command_avg_count_per_s double 24 average
delivered to the Distributor

The Minimum of number of Snapshot commands per second


snapshot_delivered_command_min_count_per_s double 24 min
delivered to the Distributor

The Maximum of number of Snapshot commands per second


snapshot_delivered_command_max_count_per_s double 24 max
delivered to the Distributor

The Average number of Snapshot transactions per second


snapshot_delivered_txn_avg_count_per_s double 24 average
delivered to the Distributor

The Minimum of number of Snapshot transactions per second


snapshot_delivered_txn_min_count_per_s double 24 min
delivered to the Distributor

The Maximum of number of Snapshot transactions per second


snapshot_delivered_txn_max_count_per_s double 24 max
delivered to the Distributor

The Average number of LogReader commands per second


log_reader_delivered_commands_avg_count_per_s double 24 average
delivered to the Distributor

The Minimum of number of LogReader commands per second


log_reader_delivered_commands_min_count_per_s double 24 min
delivered to the Distributor

The Maximum of number of LogReader commands per second


log_reader_delivered_commands_max_count_per_s double 24 max
delivered to the Distributor

The Average number of LogReader transactions per second


log_reader_delivered_txn_avg_count_per_s double 24 average
delivered to the Distributor.

The Minimum of number of LogReader transactions per second


log_reader_delivered_txn_min_count_per_s double 24 min
delivered to the Distributor.

The Maximum of number of LogReader transactions per second


log_reader_delivered_txn_max_count_per_s double 24 max
delivered to the Distributor.

The Average time (in milliseconds) elapsed from when


log_reader_delivered_latency_avg_ms double 24 average transactions are applied at the Publisher to when they are
delivered to the Distributor

The Minimum of time (in milliseconds) elapsed from when


log_reader_delivered_latency_min_ms double 24 min transactions are applied at the Publisher to when they are
delivered to the Distributor

The Maximum of time (in milliseconds) elapsed from when


log_reader_delivered_latency_max_ms double 24 max transactions are applied at the Publisher to when they are
delivered to the Distributor

The Average number of seconds a page will stay in the buffer


page_life_expectancy_avg_s double 24 average
pool without references.

The Minimum of number of seconds a page will stay in the buffer


page_life_expectancy_min_s double 24 min
pool without references.

The Maximum of number of seconds a page will stay in the


page_life_expectancy_max_s double 24 max
buffer pool without references.

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 Maximum of number of physical database page writes


page_write_max_count_per_s double 24 max
issued

The Average number of pages flushed by checkpoint or other


check_point_pages_avg_count_per_s double 24 average
operations that require all dirty pages to be flushed.

The Minimum of number of pages flushed by checkpoint or other


check_point_pages_min_count_per_s double 24 min
operations that require all dirty pages to be flushed.

The Maximum of number of pages flushed by checkpoint or


check_point_pages_max_count_per_s double 24 max
other operations that require all dirty pages to be flushed.

The Average number of buffers written by buffer managers lazy


lazy_writes_avg_count_per_s double 24 average
writer

The Minimum of number of buffers written by buffer managers


lazy_writes_min_count_per_s double 24 min
lazy writer

The Maximum of number of buffers written by buffer managers


lazy_writes_max_count_per_s double 24 max
lazy writer

The Average number of processes waiting for a workspace


memory_manager_grants_pending_avg_count double 24 average
memory grant

The Minimum of number of processes waiting for a workspace


memory_manager_grants_pending_min_count double 24 min
memory grant

The Maximum of number of processes waiting for a workspace


memory_manager_grants_pending_max_count double 24 max
memory grant

The Average amount of physical memory, in MB immediately


memory_available_avg_mb double 24 average
available for allocation to a process or for system use

The Minimum amount of physical memory, in MB immediately


memory_available_min_mb double 24 min
available for allocation to a process or for system use

The Maximum amount of physical memory, in MB immediately


memory_available_max_mb double 24 max
available for allocation to a process or for system use

The Average number of database pages(buffer manager) which


memory_manager_total_server_memory_avg_kb double 24 average
are currently being occupied in the data cache

The Minimum of number of database pages(buffer manager)


memory_manager_total_server_memory_min_kb double 24 min
which are currently being occupied in the data cache

The Maximum of number of database pages(buffer manager)


memory_manager_total_server_memory_max_kb double 24 max
which are currently being occupied in the data cache

The Average total memory the server has committed to the SQL
buffer_manager_db_pages_avg_b double 24 average
objects

The Minimum of total memory the server has committed to the


buffer_manager_db_pages_min_b double 24 min
SQL objects

The Maximum of total memory the server has committed to the


buffer_manager_db_pages_max_b double 24 max
SQL objects

The Average amount of memory the server is currently using for


memory_manager_stolen_server_memory_avg_kb double 24 average
the purposes other than the database pages

The Minimum of amount of memory the server is currently using


memory_manager_stolen_server_memory_min_kb double 24 min
for the purposes other than the database pages

The Maximum of amount of memory the server is currently using


memory_manager_stolen_server_memory_max_kb double 24 max
for the purposes other than the database pages

The Average number of pages are read from or written to disk is


memory_written_page_avg_count_per_s double 24 average
collected

The Minimum of number of pages are read from or written to


memory_written_page_min_count_per_s double 24 min
disk is collected

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

The Maximum of number of pages are read from or written to


memory_written_page_max_count_per_s double 24 max
disk is collected

The Average ideal amount of memory the server is willing to


memory_manager_target_server_memory_avg_kb double 24 average
consume

The Minimum of ideal amount of memory the server is willing to


memory_manager_target_server_memory_min_kb double 24 min
consume

The Maximum of ideal amount of memory the server is willing to


memory_manager_target_server_memory_max_kb double 24 max
consume

sql_server_recompilation_avg_count double 24 average The Average number of SQL Recompilation

sql_server_recompilation_min_count double 24 min The Minimum of number of SQL Recompilation

sql_server_recompilation_max_count double 24 max The Maximum of number of SQL Recompilation

Average number of compilations per second. Indicates the


number of times the compile code path is entered. Includes
sql_server_compilation_avg_count double 24 average
compiles caused by statement-level recompilations in SQL
Server

The Minimum of number of compilations per second. Indicates


the number of times the compile code path is entered. Includes
sql_server_compilation_min_count double 24 min
compiles caused by statement-level recompilations in SQL
Server

The Maximum of number of compilations per second. Indicates


the number of times the compile code path is entered. Includes
sql_server_compilation_max_count double 24 max
compiles caused by statement-level recompilations in SQL
Server

The Average number of SQL Statements that are being executed


sql_server_batch_request_avg_count_per_s double 24 average
per second.

The Minimum of number of SQL Statements that are being


sql_server_batch_request_min_count_per_s double 24 min
executed per second.

The Maximum of number of SQL Statements that are being


sql_server_batch_request_max_count_per_s double 24 max
executed per second.

The Average of total number of messages sent over the network


available_replica_msg_sent_per_avg_s double 24 average
to the replica

The Minimum of total number of messages sent over the


available_replica_msg_sent_per_min_s double 24 min
network to the replica

The Maximum of total number of messages sent over the


available_replica_msg_sent_per_max_s double 24 max
network to the replica

The Average of total number of messages enqueued to be send


available_replica_msg_enq_sent_per_avg_s double 24 average
over the network to the replica

The Minimum of total number of messages enqueued to be send


available_replica_msg_enq_sent_per_min_s double 24 min
over the network to the replica

The Maximum of total number of messages enqueued to be


available_replica_msg_enq_sent_per_max_s double 24 max
send over the network to the replica

The Average of Total number of messages received from the


available_replica_msg_receive_per_avg_s double 24 average
replica

The Minimum of Total number of messages received from the


available_replica_msg_receive_per_min_s double 24 min
replica

The Maximum of Total number of messages received from the


available_replica_msg_receive_per_max_s double 24 max
replica

The Average of total number of database message bytes


available_replica_msg_byte_sent_per_avg_s double 24 average
enqueued to be send over the network to the replica

The Minimum of total number of database message bytes


available_replica_msg_byte_sent_per_min_s double 24 min
enqueued to be send over the network to the replica

The Maximum of total number of database message bytes


available_replica_msg_byte_sent_per_max_s double 24 max
enqueued to be send over the network to the replica

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

The Average of total number of bytes send over the network to


available_replica_byte_sent_per_avg_s double 24 average
the replica

The Minimum of total number of bytes send over the network to


available_replica_byte_sent_per_min_s double 24 min
the replica

The Maximum of total number of bytes send over the network to


available_replica_byte_sent_per_max_s double 24 max
the replica

The Average of total number of bytes received from the replica


available_replica_byte_receive_per_avg_s double 24 average
over the network

The Minimum of total number of bytes received from the replica


available_replica_byte_receive_per_min_s double 24 min
over the network

The Maximum of total number of bytes received from the replica


available_replica_byte_receive_per_max_s double 24 max
over the network

The Average amount of filestream data received by the


db_replica_file_stream_byte_receive_per_avg_s double 24 average
availability replica for the database

The Minimum amount of filestream data received by the


db_replica_file_stream_byte_receive_per_min_s double 24 min
availability replica for the database

The Maximum amount of filestream data received by the


db_replica_file_stream_byte_receive_per_max_s double 24 max
availability replica for the database

The Average amount of log bytes remaining to be redone to


db_replica_remaining_redon_byte_per_s_avg double 24 average
finish the reverting phase received by the availability

The Minimum amount of log bytes remaining to be redone to


db_replica_remaining_redon_byte_per_s_min double 24 min
finish the reverting phase received by the availability

The Minimum amount of log bytes remaining to be redone to


db_replica_remaining_redon_byte_per_s_max double 24 max
finish the reverting phase received by the availability

The Average amount of log records redone in the last second to


db_replica_record_redon_byte_per_s_avg double 24 average
catch up the database replica

The Minimum amount of log records redone in the last second to


db_replica_record_redon_byte_per_s_min double 24 min
catch up the database replica

The Maximum amount of log records redone in the last second to


db_replica_record_redon_byte_per_s_max double 24 max
catch up the database replica

The Average number of milliseconds transaction termination


db_replica_txn_term_avg_count_per_s double 24 average
waited for acknowledgment per second

The Minimum of number of milliseconds transaction termination


db_replica_txn_term_min_count_per_s double 24 min
waited for acknowledgment per second

The Maximum of number of milliseconds transaction termination


db_replica_txn_term_max_count_per_s double 24 max
waited for acknowledgment per second

The Average number of times redo gets blocked in the last


db_replica_blocked_redo_avg_count_per_s double 24 average
second

The Minimum of number of times redo gets blocked in the last


db_replica_blocked_redo_min_count_per_s double 24 min
second

The Maximum of number of times redo gets blocked in the last


db_replica_blocked_redo_max_count_per_s double 24 max
second

The Average number of hardened log in kilobytes that is waiting


db_replica_receive_queue_count_avg_kb double 24 average
to be redone on the secondary

The Minimum of number of hardened log in kilobytes that is


db_replica_receive_queue_count_min_kb double 24 min
waiting to be redone on the secondary

The Maximum of number of hardened log in kilobytes that is


db_replica_receive_queue_count_max_kb double 24 max
waiting to be redone on the secondary

The Average amount of logs in kilobytes that is waiting to be


db_replica_log_send_queue_avg_kb double 24 average
send to the database replica

The Minimum of amount of logs in kilobytes that is waiting to be


db_replica_log_send_queue_min_kb double 24 min
send to the database replica

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

The Maximum of amount of logs in kilobytes that is waiting to be


db_replica_log_send_queue_max_kb double 24 max
send to the database replica

The Average amount of logs received by the availability replica


db_replica_log_byte_receive_avg double 24 average
for the database.

The Minimum amount of logs received by the availability replica


db_replica_log_byte_receive_min double 24 min
for the database.

The Maximum amount of logs received by the availability replica


db_replica_log_byte_receive_max double 24 max
for the database.

The Average number of availability replica(s) are having


availability_replica_role_avg_count integer 24 average
invalid(Resolving) role

The Minimum of number of availability replica(s) are having


availability_replica_role_min_count integer 24 min
invalid(Resolving) role

The Maximum of number of availability replica(s) are having


availability_replica_role_max_count integer 24 max
invalid(Resolving) role

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

The average number of availability replica(s) having unhealthy


db_replica_data_movement_avg_count integer 24 average
data movement

The Minimum of number of availability replica(s) having


db_replica_data_movement_min_count integer 24 min
unhealthy data movement

The Maximum of number of availability replica(s) having


db_replica_data_movement_max_count integer 24 max
unhealthy data movement

The Average number of availability group having at least one


secondary_replica_failover_ready_avg_count integer 24 average
secondary replica which is failover ready

The Minimum of number of availability group having at least one


secondary_replica_failover_ready_min_count integer 24 min
secondary replica which is failover ready

The Maximum of number of availability group having at least


secondary_replica_failover_ready_max_count integer 24 max
one secondary replica which is failover ready

Indicates the type of the data producer that ingested the data.
producer_instance_type string 50 lastval
E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id uuid lastval used 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


cmdb_global_id uuid lastval be used in 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 Data Lake. Pull:Data
collection_data_flow string 80 lastval 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.
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

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming", "Operations
collection_type string 255 lastval
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.


node_ipv6_address string 50 lastval
Fully specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


node_timezone_offset_h string 80 lastval
For example: +1, +4.5, -8

mssql_instance_name_id string 255 MSSQL Instance Name

The fully qualified hostname of the server being monitored. That


node_fqdn_id string 255
is the server to which the data belongs

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

The Average percentage of times a data page was found in the


cache_hit_avg_pct integer 24 average
cache

The Minimum of percentage of times a data page was found in


cache_hit_min_pct integer 24 min
the cache

The Maximum of percentage of times a data page was found in


cache_hit_max_pct integer 24 max
the cache

The Percentile of number of times a data page was found in the


cache_hit_pctl_pct integer 24 90 percentile
cache

The Average number of read requests issued to OS that are not


read_requests_avg_count integer 24 average
completed

The Minimum of number of read requests issued to OS that are


read_requests_min_count integer 24 min
not completed

The Maximum of number of read requests issued to OS that are


read_requests_max_count integer 24 max
not completed

The Average number of write requests issued to the OS not


write_requests_avg_count integer 24 average
completed

The Minimum of number of write requests issued to the OS not


write_requests_min_count integer 24 min
completed

The Maximum of number of write requests issued to the OS not


write_requests_max_count integer 24 max
completed

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

blocked_process_avg_count integer 24 average The Average number of blocked processes

blocked_process_min_count integer 24 min The Minimum of number of blocked processes

blocked_process_max_count integer 24 max The Maximum of number of blocked processes

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

cmd_queue_length_pctl_pct integer 24 90 percentile The Percentile 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

The Average percentage of total connections that are active vs


active_connection_avg_pct integer 24 average
sleeping

The Minimum of percentage of total connections that are active


active_connection_min_pct integer 24 min
vs sleeping

The Maximum of percentage of total connections that are active


active_connection_max_pct integer 24 max
vs sleeping

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

The Minimum of percentage of total connections that are


runnable_connection_min_pct integer 24 min
runnable

The Maximum of percentage of total connections that are


runnable_connection_max_pct integer 24 max
runnable

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

The Minimum of number of active transactions for the entire


active_txn_min_count integer 24 min
server

The Maximum of number of active transactions for the entire


active_txn_max_count integer 24 max
server

latch_wait_avg_count_per_s integer 24 average The Average Latch waits count per second

latch_wait_min_count_per_s integer 24 min The Minimum of waits count per second

latch_wait_max_count_per_s integer 24 max The Maximum of Latch waits count per second

latch_wait_time_avg integer 24 average The average latch wait time

latch_wait_time_avg_min integer 24 min The Minimum of latch wait time

latch_wait_time_avg_max integer 24 max The Maximum of latch wait time

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

deadlock_avg_count_per_s integer 24 average The Average Deadlocks count per second

deadlock_min_count_per_s integer 24 min The Minimum of Deadlocks count per second

deadlock_max_count_per_s integer 24 max The Maximum of Deadlocks 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

lock_wait_time_avg integer 24 average The average lock wait time

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

lock_wait_time_avg_min integer 24 min The Minimum of average lock wait time

lock_wait_time_avg_max integer 24 max The Maximum of average lock wait time

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

lock_memory_avg_pct integer 24 average The average percentage of lock memory in use

lock_memory_min_pct integer 24 min The Minimum of percentage of lock memory in use

lock_memory_max_pct integer 24 max The Maximum of percentage of lock memory in use

lock_memory_pctl_pct integer 24 90 percentile The Percentile of lock memory in use

current_latch_time_avg_ms integer 24 average The current average latch wait time

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

long_running_jobs_avg_count integer 24 average The Average number of long running jobs

long_running_jobs_min_count integer 24 min The Minimum of number of long running jobs

long_running_jobs_max_count integer 24 max The Maximum of number of long running jobs

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

The Average number of commands delivered to the Subscriber


distributor_delivery_command_avg_count_per_s double 24 average
per second

The Minimum of number of commands delivered to the


distributor_delivery_command_min_count_per_s double 24 min
Subscriber per second

The Maximum of number of commands delivered to the


distributor_delivery_command_max_count_per_s double 24 max
Subscriber per second

The Average number of transactions per second delivered to the


distributor_delivery_txn_avg_count_per_s double 24 average
Subscriber

The Minimum of number of transactions per second delivered to


distributor_delivery_txn_min_count_per_s double 24 min
the Subscriber

The Maximum of number of transactions per second delivered to


distributor_delivery_txn_max_count_per_s double 24 max
the Subscriber

The Average Time (in milliseconds) elapsed from when


distributor_delivery_latency_avg_ms double 24 average transactions are delivered to the Distributor to when they are
applied at the Subscriber

The Minimum of time (in milliseconds) elapsed from when


distributor_delivery_latency_min_ms double 24 min transactions are delivered to the Distributor to when they are
applied at the Subscriber

The Maximum of time (in milliseconds) elapsed from when


distributor_delivery_latency_max_ms double 24 max transactions are delivered to the Distributor to when they are
applied at the Subscriber

The Average number of conflicts per second during Publisher or


conflicts_avg_count_per_s double 24 average
Subscriber upload and download.

The Minimum of number of conflicts per second during Publisher


conflicts_min_count_per_s double 24 min
or Subscriber upload and download.

The Maximum of number of conflicts per second during Publisher


conflicts_max_count_per_s double 24 max
or Subscriber upload and download.

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

The Average number of rows per second replicated from the


downloaded_changes_avg_count_per_s double 24 average
Publisher to the Subscriber.

The Minimum of number of rows per second replicated from the


downloaded_changes_min_count_per_s double 24 min
Publisher to the Subscriber.

The Maximum of number of rows per second replicated from the


downloaded_changes_max_count_per_s double 24 max
Publisher to the Subscriber.

The Average number of rows per second replicated from the


uploaded_changes_avg_count_per_s double 24 average
Subscriber to the Publisher

The Minimum of number of rows per second replicated from the


uploaded_changes_min_count_per_s double 24 min
Subscriber to the Publisher

The Maximum of number of rows per second replicated from the


uploaded_changes_max_count_per_s double 24 max
Subscriber to the Publisher

The Average number of Snapshot commands per second


snapshot_delivered_command_avg_count_per_s double 24 average
delivered to the Distributor

The Minimum of number of Snapshot commands per second


snapshot_delivered_command_min_count_per_s double 24 min
delivered to the Distributor

The Maximum of number of Snapshot commands per second


snapshot_delivered_command_max_count_per_s double 24 max
delivered to the Distributor

The Average number of Snapshot transactions per second


snapshot_delivered_txn_avg_count_per_s double 24 average
delivered to the Distributor

The Minimum of number of Snapshot transactions per second


snapshot_delivered_txn_min_count_per_s double 24 min
delivered to the Distributor

The Maximum of number of Snapshot transactions per second


snapshot_delivered_txn_max_count_per_s double 24 max
delivered to the Distributor

The Average number of LogReader commands per second


log_reader_delivered_commands_avg_count_per_s double 24 average
delivered to the Distributor

The Minimum of number of LogReader commands per second


log_reader_delivered_commands_min_count_per_s double 24 min
delivered to the Distributor

The Maximum of number of LogReader commands per second


log_reader_delivered_commands_max_count_per_s double 24 max
delivered to the Distributor

The Average number of LogReader transactions per second


log_reader_delivered_txn_avg_count_per_s double 24 average
delivered to the Distributor.

The Minimum of number of LogReader transactions per second


log_reader_delivered_txn_min_count_per_s double 24 min
delivered to the Distributor.

The Maximum of number of LogReader transactions per second


log_reader_delivered_txn_max_count_per_s double 24 max
delivered to the Distributor.

The Average time (in milliseconds) elapsed from when


log_reader_delivered_latency_avg_ms double 24 average transactions are applied at the Publisher to when they are
delivered to the Distributor

The Minimum of time (in milliseconds) elapsed from when


log_reader_delivered_latency_min_ms double 24 min transactions are applied at the Publisher to when they are
delivered to the Distributor

The Maximum of time (in milliseconds) elapsed from when


log_reader_delivered_latency_max_ms double 24 max transactions are applied at the Publisher to when they are
delivered to the Distributor

The Average number of seconds a page will stay in the buffer


page_life_expectancy_avg_s double 24 average
pool without references.

The Minimum of number of seconds a page will stay in the buffer


page_life_expectancy_min_s double 24 min
pool without references.

The Maximum of number of seconds a page will stay in the


page_life_expectancy_max_s double 24 max
buffer pool without references.

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 Maximum of number of physical database page writes


page_write_max_count_per_s double 24 max
issued

The Average number of pages flushed by checkpoint or other


check_point_pages_avg_count_per_s double 24 average
operations that require all dirty pages to be flushed.

The Minimum of number of pages flushed by checkpoint or other


check_point_pages_min_count_per_s double 24 min
operations that require all dirty pages to be flushed.

The Maximum of number of pages flushed by checkpoint or


check_point_pages_max_count_per_s double 24 max
other operations that require all dirty pages to be flushed.

The Average number of buffers written by buffer managers lazy


lazy_writes_avg_count_per_s double 24 average
writer

The Minimum of number of buffers written by buffer managers


lazy_writes_min_count_per_s double 24 min
lazy writer

The Maximum of number of buffers written by buffer managers


lazy_writes_max_count_per_s double 24 max
lazy writer

The Average number of processes waiting for a workspace


memory_manager_grants_pending_avg_count double 24 average
memory grant

The Minimum of number of processes waiting for a workspace


memory_manager_grants_pending_min_count double 24 min
memory grant

The Maximum of number of processes waiting for a workspace


memory_manager_grants_pending_max_count double 24 max
memory grant

The Average amount of physical memory, in MB immediately


memory_available_avg_mb double 24 average
available for allocation to a process or for system use

The Minimum amount of physical memory, in MB immediately


memory_available_min_mb double 24 min
available for allocation to a process or for system use

The Maximum amount of physical memory, in MB immediately


memory_available_max_mb double 24 max
available for allocation to a process or for system use

The Average number of database pages(buffer manager) which


memory_manager_total_server_memory_avg_kb double 24 average
are currently being occupied in the data cache

The Minimum of number of database pages(buffer manager)


memory_manager_total_server_memory_min_kb double 24 min
which are currently being occupied in the data cache

The Maximum of number of database pages(buffer manager)


memory_manager_total_server_memory_max_kb double 24 max
which are currently being occupied in the data cache

The Average total memory the server has committed to the SQL
buffer_manager_db_pages_avg_b double 24 average
objects

The Minimum of total memory the server has committed to the


buffer_manager_db_pages_min_b double 24 min
SQL objects

The Maximum of total memory the server has committed to the


buffer_manager_db_pages_max_b double 24 max
SQL objects

The Average amount of memory the server is currently using for


memory_manager_stolen_server_memory_avg_kb double 24 average
the purposes other than the database pages

The Minimum of amount of memory the server is currently using


memory_manager_stolen_server_memory_min_kb double 24 min
for the purposes other than the database pages

The Maximum of amount of memory the server is currently using


memory_manager_stolen_server_memory_max_kb double 24 max
for the purposes other than the database pages

The Average number of pages are read from or written to disk is


memory_written_page_avg_count_per_s double 24 average
collected

The Minimum of number of pages are read from or written to


memory_written_page_min_count_per_s double 24 min
disk is collected

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

The Maximum of number of pages are read from or written to


memory_written_page_max_count_per_s double 24 max
disk is collected

The Average ideal amount of memory the server is willing to


memory_manager_target_server_memory_avg_kb double 24 average
consume

The Minimum of ideal amount of memory the server is willing to


memory_manager_target_server_memory_min_kb double 24 min
consume

The Maximum of ideal amount of memory the server is willing to


memory_manager_target_server_memory_max_kb double 24 max
consume

sql_server_recompilation_avg_count double 24 average The Average number of SQL Recompilation

sql_server_recompilation_min_count double 24 min The Minimum of number of SQL Recompilation

sql_server_recompilation_max_count double 24 max The Maximum of number of SQL Recompilation

Average number of compilations per second. Indicates the


number of times the compile code path is entered. Includes
sql_server_compilation_avg_count double 24 average
compiles caused by statement-level recompilations in SQL
Server

The Minimum of number of compilations per second. Indicates


the number of times the compile code path is entered. Includes
sql_server_compilation_min_count double 24 min
compiles caused by statement-level recompilations in SQL
Server

The Maximum of number of compilations per second. Indicates


the number of times the compile code path is entered. Includes
sql_server_compilation_max_count double 24 max
compiles caused by statement-level recompilations in SQL
Server

The Average number of SQL Statements that are being executed


sql_server_batch_request_avg_count_per_s double 24 average
per second.

The Minimum of number of SQL Statements that are being


sql_server_batch_request_min_count_per_s double 24 min
executed per second.

The Maximum of number of SQL Statements that are being


sql_server_batch_request_max_count_per_s double 24 max
executed per second.

The Average of total number of messages sent over the network


available_replica_msg_sent_per_avg_s double 24 average
to the replica

The Minimum of total number of messages sent over the


available_replica_msg_sent_per_min_s double 24 min
network to the replica

The Maximum of total number of messages sent over the


available_replica_msg_sent_per_max_s double 24 max
network to the replica

The Average of total number of messages enqueued to be send


available_replica_msg_enq_sent_per_avg_s double 24 average
over the network to the replica

The Minimum of total number of messages enqueued to be send


available_replica_msg_enq_sent_per_min_s double 24 min
over the network to the replica

The Maximum of total number of messages enqueued to be


available_replica_msg_enq_sent_per_max_s double 24 max
send over the network to the replica

The Average of Total number of messages received from the


available_replica_msg_receive_per_avg_s double 24 average
replica

The Minimum of Total number of messages received from the


available_replica_msg_receive_per_min_s double 24 min
replica

The Maximum of Total number of messages received from the


available_replica_msg_receive_per_max_s double 24 max
replica

The Average of total number of database message bytes


available_replica_msg_byte_sent_per_avg_s double 24 average
enqueued to be send over the network to the replica

The Minimum of total number of database message bytes


available_replica_msg_byte_sent_per_min_s double 24 min
enqueued to be send over the network to the replica

The Maximum of total number of database message bytes


available_replica_msg_byte_sent_per_max_s double 24 max
enqueued to be send over the network to the replica

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

The Average of total number of bytes send over the network to


available_replica_byte_sent_per_avg_s double 24 average
the replica

The Minimum of total number of bytes send over the network to


available_replica_byte_sent_per_min_s double 24 min
the replica

The Maximum of total number of bytes send over the network to


available_replica_byte_sent_per_max_s double 24 max
the replica

The Average of total number of bytes received from the replica


available_replica_byte_receive_per_avg_s double 24 average
over the network

The Minimum of total number of bytes received from the replica


available_replica_byte_receive_per_min_s double 24 min
over the network

The Maximum of total number of bytes received from the replica


available_replica_byte_receive_per_max_s double 24 max
over the network

The Average amount of filestream data received by the


db_replica_file_stream_byte_receive_per_avg_s double 24 average
availability replica for the database

The Minimum amount of filestream data received by the


db_replica_file_stream_byte_receive_per_min_s double 24 min
availability replica for the database

The Maximum amount of filestream data received by the


db_replica_file_stream_byte_receive_per_max_s double 24 max
availability replica for the database

The Average amount of log bytes remaining to be redone to


db_replica_remaining_redon_byte_per_s_avg double 24 average
finish the reverting phase received by the availability

The Minimum amount of log bytes remaining to be redone to


db_replica_remaining_redon_byte_per_s_min double 24 min
finish the reverting phase received by the availability

The Minimum amount of log bytes remaining to be redone to


db_replica_remaining_redon_byte_per_s_max double 24 max
finish the reverting phase received by the availability

The Average amount of log records redone in the last second to


db_replica_record_redon_byte_per_s_avg double 24 average
catch up the database replica

The Minimum amount of log records redone in the last second to


db_replica_record_redon_byte_per_s_min double 24 min
catch up the database replica

The Maximum amount of log records redone in the last second to


db_replica_record_redon_byte_per_s_max double 24 max
catch up the database replica

The Average number of milliseconds transaction termination


db_replica_txn_term_avg_count_per_s double 24 average
waited for acknowledgment per second

The Minimum of number of milliseconds transaction termination


db_replica_txn_term_min_count_per_s double 24 min
waited for acknowledgment per second

The Maximum of number of milliseconds transaction termination


db_replica_txn_term_max_count_per_s double 24 max
waited for acknowledgment per second

The Average number of times redo gets blocked in the last


db_replica_blocked_redo_avg_count_per_s double 24 average
second

The Minimum of number of times redo gets blocked in the last


db_replica_blocked_redo_min_count_per_s double 24 min
second

The Maximum of number of times redo gets blocked in the last


db_replica_blocked_redo_max_count_per_s double 24 max
second

The Average number of hardened log in kilobytes that is waiting


db_replica_receive_queue_count_avg_kb double 24 average
to be redone on the secondary

The Minimum of number of hardened log in kilobytes that is


db_replica_receive_queue_count_min_kb double 24 min
waiting to be redone on the secondary

The Maximum of number of hardened log in kilobytes that is


db_replica_receive_queue_count_max_kb double 24 max
waiting to be redone on the secondary

The Average amount of logs in kilobytes that is waiting to be


db_replica_log_send_queue_avg_kb double 24 average
send to the database replica

The Minimum of amount of logs in kilobytes that is waiting to be


db_replica_log_send_queue_min_kb double 24 min
send to the database replica

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

The Maximum of amount of logs in kilobytes that is waiting to be


db_replica_log_send_queue_max_kb double 24 max
send to the database replica

The Average amount of logs received by the availability replica


db_replica_log_byte_receive_avg double 24 average
for the database.

The Minimum amount of logs received by the availability replica


db_replica_log_byte_receive_min double 24 min
for the database.

The Maximum amount of logs received by the availability replica


db_replica_log_byte_receive_max double 24 max
for the database.

The Average number of availability replica(s) are having


availability_replica_role_avg_count integer 24 average
invalid(Resolving) role

The Minimum of number of availability replica(s) are having


availability_replica_role_min_count integer 24 min
invalid(Resolving) role

The Maximum of number of availability replica(s) are having


availability_replica_role_max_count integer 24 max
invalid(Resolving) role

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

The average number of availability replica(s) having unhealthy


db_replica_data_movement_avg_count integer 24 average
data movement

The Minimum of number of availability replica(s) having


db_replica_data_movement_min_count integer 24 min
unhealthy data movement

The Maximum of number of availability replica(s) having


db_replica_data_movement_max_count integer 24 max
unhealthy data movement

The Average number of availability group having at least one


secondary_replica_failover_ready_avg_count integer 24 average
secondary replica which is failover ready

The Minimum of number of availability group having at least one


secondary_replica_failover_ready_min_count integer 24 min
secondary replica which is failover ready

The Maximum of number of availability group having at least


secondary_replica_failover_ready_max_count integer 24 max
one secondary replica which is failover ready

Indicates the type of the data producer that ingested the data.
producer_instance_type string 50 lastval
E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id uuid lastval used 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


cmdb_global_id uuid lastval be used in 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 Data Lake. Pull:Data
collection_data_flow string 80 lastval 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.
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

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming", "Operations
collection_type string 255 lastval
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.


node_ipv6_address string 50 lastval
Fully specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


node_short_name string 255 lastval
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


node_timezone_offset_h string 80 lastval
For example: +1, +4.5, -8

mssql_instance_name_id string 255 MSSQL Instance Name

The fully qualified hostname of the server being monitored. That


node_fqdn_id string 255
is the server to which the data belongs

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

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

M028_SUSPECTDBCNT suspect_db_count integer 24 The number of databases marked as suspect

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

suspect_db_count integer 24 lastval The number of databases marked as suspect

suspect_db_avg_count integer 24 average The Average number of databases marked as suspect

suspect_db_min_count integer 24 min The Minimum number of databases marked as suspect

suspect_db_max_count integer 24 max The Maximum number of databases marked as suspect

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance 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 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

suspect_db_count integer 24 lastval The number of databases marked as suspect

suspect_db_avg_count integer 24 average The Average number of databases marked as suspect

suspect_db_min_count integer 24 min The Minimum number of databases marked as suspect

suspect_db_max_count integer 24 max The Maximum number of databases marked as suspect

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

The number of databases with is_db_chaining_on setting


M506_DBCHAINING db_chaining_setting_count integer 24
disabled

The number of databases with setting as page_verify_option


M507_PAGEVERIFY db_page_verify_setting_count integer 24
is not equal to CHECKSUM

The number of databases with recovery_model setting is


M508_RRYMODEL db_page_recovery_model_setting_count integer 24
disabled.

The number of databases with is_trustworthy_on setting is


M509_TRUSTWORTH db_trust_worthy_setting_count integer 24
enabled.

M013_LOCKSINUSEPCT locks_in_use_pct integer 24 The percentage of locks in use

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service - Agent",
"BPM Probe", RUM Engine", "OBM Server Event Forwarding",
"SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 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 1068
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

The Average number of databases with is_db_chaining_on setting


db_chaining_setting_avg_count integer 24 average
disabled

The Minimum of number of databases with is_db_chaining_on setting


db_chaining_setting_min_count integer 24 min
disabled

The Maximum of number of databases with is_db_chaining_on setting


db_chaining_setting_max_count integer 24 max
disabled

The Average number of databases with setting as page_verify_option


db_page_verify_setting_avg_count integer 24 average
is not equal to CHECKSUM

The Minimum of number of databases with setting as


db_page_verify_setting_min_count integer 24 min
page_verify_option is not equal to CHECKSUM

The Maximum of number of databases with setting as


db_page_verify_setting_max_count integer 24 max
page_verify_option is not equal to CHECKSUM

The Average number of databases with recovery_model setting is


db_page_recovery_model_setting_avg_count integer 24 average
disabled.

The Minimum of number of databases with recovery_model setting is


db_page_recovery_model_setting_min_count integer 24 min
disabled.

The Maximum of number of databases with recovery_model setting is


db_page_recovery_model_setting_max_count integer 24 max
disabled.

The Average number of databases with is_trustworthy_on setting is


db_trust_worthy_setting_avg_count integer 24 average
enabled.

The Minimum of number of databases with is_trustworthy_on setting is


db_trust_worthy_setting_min_count integer 24 min
enabled.

The Maximum of number of databases with is_trustworthy_on setting


db_trust_worthy_setting_max_count integer 24 max
is enabled.

locks_in_use_avg_pct integer 24 average The Average percentage of locks in use

locks_in_use_min_pct integer 24 min The Minimum of percentage of locks in use

locks_in_use_max_pct integer 24 max The Maximum of percentage of locks in use

locks_in_use_pctl_pct integer 24 90 percentile The Percentile of locks in use

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

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


cmdb_global_id uuid lastval used in 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 Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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

A detailed description of the actual collector that actively collects


data. For example: "SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
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


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

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

The Average number of databases with is_db_chaining_on setting


db_chaining_setting_avg_count integer 24 average
disabled

The Minimum of number of databases with is_db_chaining_on setting


db_chaining_setting_min_count integer 24 min
disabled

The Maximum of number of databases with is_db_chaining_on setting


db_chaining_setting_max_count integer 24 max
disabled

The Average number of databases with setting as page_verify_option


db_page_verify_setting_avg_count integer 24 average
is not equal to CHECKSUM

The Minimum of number of databases with setting as


db_page_verify_setting_min_count integer 24 min
page_verify_option is not equal to CHECKSUM

The Maximum of number of databases with setting as


db_page_verify_setting_max_count integer 24 max
page_verify_option is not equal to CHECKSUM

The Average number of databases with recovery_model setting is


db_page_recovery_model_setting_avg_count integer 24 average
disabled.

The Minimum of number of databases with recovery_model setting is


db_page_recovery_model_setting_min_count integer 24 min
disabled.

The Maximum of number of databases with recovery_model setting is


db_page_recovery_model_setting_max_count integer 24 max
disabled.

The Average number of databases with is_trustworthy_on setting is


db_trust_worthy_setting_avg_count integer 24 average
enabled.

The Minimum of number of databases with is_trustworthy_on setting is


db_trust_worthy_setting_min_count integer 24 min
enabled.

The Maximum of number of databases with is_trustworthy_on setting


db_trust_worthy_setting_max_count integer 24 max
is enabled.

locks_in_use_avg_pct integer 24 average The Average percentage of locks in use

locks_in_use_min_pct integer 24 min The Minimum of percentage of locks in use

locks_in_use_max_pct integer 24 max The Maximum of percentage of locks in use

locks_in_use_pctl_pct integer 24 90 percentile The Percentile of locks in use

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

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


cmdb_global_id uuid lastval used in 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 Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
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

A detailed description of the actual collector that actively collects


data. For example: "SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
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


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

M011_USERCONNECTPCT user_connected_pct integer 24 The percentage of current users connected

M031_NUMUSERSCNT user_connection_count integer 24 The user connections count

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

M082_REPNLATENCY replication_latency_s integer 24 The Replication Latency

M083_DELLATENCY delivery_latency_s integer 24 The Delivery Latency

The count of principals who are members of the sysadmin


M090_SQLADTSYSLOG sysadmin_principal_count integer 24
fixed 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

The number of databases have modified schema since


M093_SQLADTSCHMOD db_schema_modified_count integer 24
yesterday

The count of outstanding population batches for the Full


M518_FULLTEXTBATCH fulltext_search_population_batches_count integer 24
Text Search Service

This monitor checks the connection state between


M515_REPLCCONNST availability_replica_connection_state integer 24
availability replicas

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


timestamp_utc_collector timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row.


collection_source collection_source string 255 It can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance


producer_instance_id producer_instance_id string 255
within a producer type

Holds the local ID of the entity in UCMDB. [entity type]


cmdb_id cmdb_id uuid should be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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.
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 collection 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 1074
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

A detailed description of the actual collector that actively


collects data. For example: "SiteScope Streaming",
collection_type collection_type string 255 "Operations Agent Streaming", "Collection Service -
Agent", "BPM Probe", RUM Engine", "OBM Server Event
Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any
simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

user_connected_avg_pct integer 24 average The Average percentage of current users connected

user_connected_min_pct integer 24 min The Minimum of percentage of current users connected

user_connected_max_pct integer 24 max The maximum of percentage of current users connected

user_connected_pctl_pct integer 24 90 percentile The percentile of the current users connected

user_connection_avg_count integer 24 average The Average user connections count

user_connection_min_count integer 24 min The Minimum of user connections count

user_connection_max_count integer 24 max The Maximum of user connections count

txn_log_expansion_avg_count integer 24 average The Average number of transaction log expansions for the server

The Minimum of the number of transaction log expansions for the


txn_log_expansion_min_count integer 24 min
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

replication_latency_avg_s integer 24 average The Average of Replication Latency

replication_latency_min_s integer 24 min The Minimum of Replication Latency

replication_latency_max_s integer 24 max The Maximum of Replication Latency

delivery_latency_avg_s integer 24 average The Average of Delivery Latency

delivery_latency_min_s integer 24 min The Minimum of Delivery Latency

delivery_latency_max_s integer 24 max The Maximum of Delivery Latency

The Average count of principals who are members of the sysadmin


sysadmin_principal_avg_count integer 24 average
fixed server

The Minimum of count of principals who are members of the


sysadmin_principal_min_count integer 24 min
sysadmin fixed server

The Maximum of count of principals who are members of the


sysadmin_principal_max_count integer 24 max
sysadmin fixed 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

The Average number of databases have modified schema since


db_schema_modified_avg_count integer 24 average
yesterday

The Minimum of number of databases have modified schema since


db_schema_modified_min_count integer 24 min
yesterday

The Maximum of number of databases have modified schema since


db_schema_modified_max_count integer 24 max
yesterday

The Average count of outstanding population batches for the Full


fulltext_search_population_batches_avg_count integer 24 average
Text Search Service

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

The Minimum of count of outstanding population batches for the Full


fulltext_search_population_batches_min_count integer 24 min
Text Search Service

The Maximum of count of outstanding population batches for the Full


fulltext_search_population_batches_max_count integer 24 max
Text Search Service

This monitor checks the connection state between availability


availability_replica_connection_state integer 24 lastval
replicas

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id uuid lastval used 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


cmdb_global_id uuid lastval used in 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 Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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: "SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
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.


node_ipv6_address string 50 lastval
Fully specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

The fully qualified hostname of the server being monitored. That is


node_fqdn_id string 255
the 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 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

user_connected_avg_pct integer 24 average The Average percentage of current users connected

user_connected_min_pct integer 24 min The Minimum of percentage of current users connected

user_connected_max_pct integer 24 max The maximum of percentage of current users connected

user_connected_pctl_pct integer 24 90 percentile The percentile of the current users connected

user_connection_avg_count integer 24 average The Average user connections count

user_connection_min_count integer 24 min The Minimum of user connections count

user_connection_max_count integer 24 max The Maximum of user connections count

txn_log_expansion_avg_count integer 24 average The Average number of transaction log expansions for the server

The Minimum of the number of transaction log expansions for the


txn_log_expansion_min_count integer 24 min
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

replication_latency_avg_s integer 24 average The Average of Replication Latency

replication_latency_min_s integer 24 min The Minimum of Replication Latency

replication_latency_max_s integer 24 max The Maximum of Replication Latency

delivery_latency_avg_s integer 24 average The Average of Delivery Latency

delivery_latency_min_s integer 24 min The Minimum of Delivery Latency

delivery_latency_max_s integer 24 max The Maximum of Delivery Latency

The Average count of principals who are members of the sysadmin


sysadmin_principal_avg_count integer 24 average
fixed server

The Minimum of count of principals who are members of the


sysadmin_principal_min_count integer 24 min
sysadmin fixed server

The Maximum of count of principals who are members of the


sysadmin_principal_max_count integer 24 max
sysadmin fixed 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

The Average number of databases have modified schema since


db_schema_modified_avg_count integer 24 average
yesterday

The Minimum of number of databases have modified schema since


db_schema_modified_min_count integer 24 min
yesterday

The Maximum of number of databases have modified schema since


db_schema_modified_max_count integer 24 max
yesterday

The Average count of outstanding population batches for the Full


fulltext_search_population_batches_avg_count integer 24 average
Text Search Service

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

The Minimum of count of outstanding population batches for the Full


fulltext_search_population_batches_min_count integer 24 min
Text Search Service

The Maximum of count of outstanding population batches for the Full


fulltext_search_population_batches_max_count integer 24 max
Text Search Service

This monitor checks the connection state between availability


availability_replica_connection_state integer 24 lastval
replicas

Indicates the type of the data producer that ingested the data. E.g
producer_instance_type string 50 lastval
UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id uuid lastval used 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


cmdb_global_id uuid lastval used in 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 Data Lake. Pull:Data producer
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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: "SiteScope Streaming", "Operations Agent
collection_type string 255 lastval
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.


node_ipv6_address string 50 lastval
Fully specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_instance_name_id string 255 MSSQL Instance Name

The fully qualified hostname of the server being monitored. That is


node_fqdn_id string 255
the 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

null mssql_filegroup_name string 255 Entity under the instance

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_filegroup_name_id string 255 Entity under the instance

mssql_instance_name_id string 255 MSSQL Instance 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

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_filegroup_name_id string 255 Entity under the instance

mssql_instance_name_id string 255 MSSQL Instance 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

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_db_name string 255 MSSQL Database Name

Connection status of the Database, the possible values are 0(connected),


927(Server offline(suspect mode)), 926(Server
M3230_DBCONNECT db_connection_status double 24
offline(restoring)),945(Server offline(Error 945)), 916(Server offline(Error
916))

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_db_name string 255 MSSQL Instance Name

The time duration (in minutes) in an hour when the MSSQL database is in
null uptime_min double
connected state.

The percentage of time in an hour when the MSSQL database is in


null uptime_pct 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 percentage of time in an hour when the MSSQL database is not in


null downtime_pct double
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 percentage of time in an hour when the MSSQL database is not


null planned_downtime_pct 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.

The percentage of time in an hour when the MSSQL database is not


null unknown_time_pct double
connected due to unknown outage.

Timestamp with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 1084
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_db_name_id string 255 MSSQL Instance 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 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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME mssql_instance_name string 255 MSSQL Instance Name

INSTANCENAME mssql_db_name string 255 MSSQL Database name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_db_name_id string 255 MSSQL Database name

mssql_instance_name_id string 255 MSSQL Instance Name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

mssql_db_name_id string 255 MSSQL Database name

mssql_instance_name_id string 255 MSSQL Instance Name

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

1.4.2.6. Management Pack for PostgreSQL


This section provides you information about the Management Pack for PostgreSQL:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_postgres_db_conn_status opsb_postgres_db_conn_status_1h opsb_postgres_db_conn_status_1d


Not available
opsb_postgres_db_stat opsb_postgres_db_stat_1h opsb_postgres_db_stat_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

POSTGRESDBMETRIC_ID postgres_db_name string 255 PostgreSQL Database Name

Monitors the Connection Status metric of PostgreSQL where


CONNECTIONSTATUS conn_status double 24
ConnectionStatus= 0 Down and ConnectionStatus= 1 UP

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

postgres_db_name_id string 255 PostgreSQL Database Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

POSTGRESDBMETRIC_ID postgres_db_name string 255 PostgreSQL Database Name

The time duration (in minutes) in an hour when the SAP connection is in
null uptime_min double
running state.

The percentage of time in an hour when the SAP connection is in running


null uptime_pct double
state.

The time duration (in minutes) in an hour when the SAP connection is not
null downtime_min double
in running state.

The percentage of time in an hour when the SAP connection is not in


null downtime_pct double
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.

The percentage of time in an hour when the SAP connection state


null unknown_time_pct double
information not available due to unknown outage.

Timestamp with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 1093
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

POSTGRESDBMETRIC_ID postgres_db_name string 255 PostgreSQL Database Name

COMMITRATIO commit_ratio_pct double 24 Commit Ratio metric of PostgreSQL database in percentage

HITRATIO hit_ratio_pct double 24 Hit Ratio of PostgreSQL database in percentage

DATABASESIZE db_size_mb double 24 Database Size of PostgreSQL database in MB

LOCKSCOUNT locks_count double 24 Locks Count of PostgreSQL database

BACKENDCONNECTIONSPERCENT backend_conn_pct double 24 Backend Connections Percentage of PostgreSQL database

DEADLOCKSCOUNT deadlocks_count double 24 DeadLocks Count of PostgreSQL database

BLOCKHITSCOUNT block_hits_count double 24 BlockHits Count of PostgreSQL database

BLOCKREADSCOUNT block_reads_count double 24 BlockReads Count of PostgreSQL database

ROLLBACKSCOUNT rollbacks_count double 24 RollBacks Count of PostgreSQL database

INDEXESCOUNT indexes_count double 24 Indexes Count of PostgreSQL database

TRIGGERSCOUNT triggers_count double 24 Triggers Count of PostgreSQL database

TABLESCOUNT tables_count double 24 Tables Count of PostgreSQL database

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. Pull:Data producer provides
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

db_size_avg_mb double 24 average The Average database Size of PostgreSQL database in MB

db_size_min_mb double 24 min The Minimum database Size of PostgreSQL database in MB

db_size_max_mb double 24 max The Maximum database Size of PostgreSQL database in MB

locks_count double 24 lastval Locks Count of PostgreSQL database

locks_avg_count double 24 average The Average locks Count of PostgreSQL database

locks_min_count double 24 min The Minimum locks Count of PostgreSQL database

locks_max_count double 24 max The Maximum locks Count of PostgreSQL database

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

deadlocks_count double 24 lastval DeadLocks Count of PostgreSQL database

deadlocks_avg_count double 24 average The Average deadLocks Count of PostgreSQL database

deadlocks_min_count double 24 min The Minimum deadLocks Count of PostgreSQL database

deadlocks_max_count double 24 max The Maximum deadLocks Count of PostgreSQL database

block_hits_count double 24 lastval BlockHits Count of PostgreSQL database

block_hits_avg_count double 24 average The Average blockHits Count of PostgreSQL database

block_hits_min_count double 24 min The Minimum blockHits Count of PostgreSQL database

block_hits_max_count double 24 max The Maximum blockHits Count of PostgreSQL database

block_reads_count double 24 lastval BlockReads Count of PostgreSQL database

block_reads_avg_count double 24 average The Average blockReads Count of PostgreSQL database

block_reads_min_count double 24 min The Minimum blockReads Count of PostgreSQL database

block_reads_max_count double 24 max The Maximum blockReads Count of PostgreSQL database

rollbacks_count double 24 lastval RollBacks Count of PostgreSQL database

rollbacks_avg_count double 24 average The Average rollBacks Count of PostgreSQL database

rollbacks_min_count double 24 min The Minimum rollBacks Count of PostgreSQL database

rollbacks_max_count double 24 max The Maximum rollBacks Count of PostgreSQL database

indexes_count double 24 lastval Indexes Count of PostgreSQL database

indexes_avg_count double 24 average The Average indexes Count of PostgreSQL database

indexes_min_count double 24 min The Minimum indexes Count of PostgreSQL database

indexes_max_count double 24 max The Maximum indexes Count 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

triggers_count double 24 lastval Triggers Count of PostgreSQL database

triggers_avg_count double 24 average The Average triggers Count of PostgreSQL database

triggers_min_count double 24 min The Minimum triggers Count of PostgreSQL database

triggers_max_count double 24 max The Maximum triggers Count of PostgreSQL database

tables_count double 24 lastval Tables Count of PostgreSQL database

tables_avg_count double 24 average The Average tables Count of PostgreSQL database

tables_min_count double 24 min The Minimum tables Count of PostgreSQL database

tables_max_count double 24 max The Maximum tables Count of PostgreSQL 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

postgres_db_name_id string 255 PostgreSQL Database Name

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

db_size_avg_mb double 24 average The Average database Size of PostgreSQL database in MB

db_size_min_mb double 24 min The Minimum database Size of PostgreSQL database in MB

db_size_max_mb double 24 max The Maximum database Size of PostgreSQL database in MB

locks_count double 24 lastval Locks Count of PostgreSQL database

locks_avg_count double 24 average The Average locks Count of PostgreSQL database

locks_min_count double 24 min The Minimum locks Count of PostgreSQL database

locks_max_count double 24 max The Maximum locks Count of PostgreSQL database

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

deadlocks_count double 24 lastval DeadLocks Count of PostgreSQL database

deadlocks_avg_count double 24 average The Average deadLocks Count of PostgreSQL database

deadlocks_min_count double 24 min The Minimum deadLocks Count of PostgreSQL database

deadlocks_max_count double 24 max The Maximum deadLocks Count of PostgreSQL database

block_hits_count double 24 lastval BlockHits Count of PostgreSQL database

block_hits_avg_count double 24 average The Average blockHits Count of PostgreSQL database

block_hits_min_count double 24 min The Minimum blockHits Count of PostgreSQL database

block_hits_max_count double 24 max The Maximum blockHits Count of PostgreSQL database

block_reads_count double 24 lastval BlockReads Count of PostgreSQL database

block_reads_avg_count double 24 average The Average blockReads Count of PostgreSQL database

block_reads_min_count double 24 min The Minimum blockReads Count of PostgreSQL database

block_reads_max_count double 24 max The Maximum blockReads Count of PostgreSQL database

rollbacks_count double 24 lastval RollBacks Count of PostgreSQL database

rollbacks_avg_count double 24 average The Average rollBacks Count of PostgreSQL database

rollbacks_min_count double 24 min The Minimum rollBacks Count of PostgreSQL database

rollbacks_max_count double 24 max The Maximum rollBacks Count of PostgreSQL database

indexes_count double 24 lastval Indexes Count of PostgreSQL database

indexes_avg_count double 24 average The Average indexes Count of PostgreSQL database

indexes_min_count double 24 min The Minimum indexes Count of PostgreSQL database

indexes_max_count double 24 max The Maximum indexes Count 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

triggers_count double 24 lastval Triggers Count of PostgreSQL database

triggers_avg_count double 24 average The Average triggers Count of PostgreSQL database

triggers_min_count double 24 min The Minimum triggers Count of PostgreSQL database

triggers_max_count double 24 max The Maximum triggers Count of PostgreSQL database

tables_count double 24 lastval Tables Count of PostgreSQL database

tables_avg_count double 24 average The Average tables Count of PostgreSQL database

tables_min_count double 24 min The Minimum tables Count of PostgreSQL database

tables_max_count double 24 max The Maximum tables Count of PostgreSQL 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 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

postgres_db_name_id string 255 PostgreSQL Database Name

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

1.4.2.7. Management Pack for Oracle Database


This section provides you information about the Management Pack for Oracle Database:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_ora_dataguard_status opsb_ora_dataguard_status_1h opsb_ora_dataguard_status_1d

opsb_ora_db_space_util opsb_ora_db_space_util_1h opsb_ora_db_space_util_1d

opsb_ora_instance_status opsb_ora_instance_status_1h opsb_ora_instance_status_1d

opsb_ora_io_perf opsb_ora_io_perf_1h opsb_ora_io_perf_1d

opsb_ora_perf opsb_ora_perf_1h opsb_ora_perf_1d

opsb_ora_query_perf opsb_ora_query_perf_1h opsb_ora_query_perf_1d Not available

opsb_ora_replication_metrics opsb_ora_replication_metrics_1h opsb_ora_replication_metrics_1d

opsb_ora_segment_space_util opsb_ora_segment_space_util_1h opsb_ora_segment_space_util_1d

opsb_ora_storage_metrics opsb_ora_storage_metrics_1h opsb_ora_storage_metrics_1d

opsb_ora_tablespace_metrics opsb_ora_tablespace_metrics_1h opsb_ora_tablespace_metrics_1d

opsb_ora_users_sessions opsb_ora_users_sessions_1h opsb_ora_users_sessions_1d

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

E037_USERLOGONCNT user_logon_count integer 24 Current Number of user logons

E082_SESSHIGHWATRCNT session_count integer 24 Number of sessions since startup

E087_PROCESSPCT curr_act_process_pct integer 24 Percentage of current active processes

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

user_logon_avg_count integer 24 average The Average current Number of user logons

user_logon_min_count integer 24 min The Minimum current Number of user logons

user_logon_max_count integer 24 max The Maximum current Number of user logons

user_logon_count integer 24 lastval Current Number of user logons

session_avg_count integer 24 average The Average number of sessions since startup

session_min_count integer 24 min The Minimum number of sessions since startup

session_max_count integer 24 max The Maximum number of sessions since startup

session_count integer 24 lastval Number of sessions since startup

curr_act_process_avg_pct integer 24 average The Average percentage of current active processes

curr_act_process_min_pct integer 24 min The Minimum percentage of current active processes

curr_act_process_max_pct integer 24 max The Maximum percentage of current active processes

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

user_logon_avg_count integer 24 average The Average current Number of user logons

user_logon_min_count integer 24 min The Minimum current Number of user logons

user_logon_max_count integer 24 max The Maximum current Number of user logons

user_logon_count integer 24 lastval Current Number of user logons

session_avg_count integer 24 average The Average number of sessions since startup

session_min_count integer 24 min The Minimum number of sessions since startup

session_max_count integer 24 max The Maximum number of sessions since startup

session_count integer 24 lastval Number of sessions since startup

curr_act_process_avg_pct integer 24 average The Average percentage of current active processes

curr_act_process_min_pct integer 24 min The Minimum percentage of current active processes

curr_act_process_max_pct integer 24 max The Maximum percentage of current active processes

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

null ora_tablespace_name string 255 Tablespace Name

null tablespace_alloc_space_mb integer 24 Space Allocated for Tablespace in MB

null tablespace_free_space_mb integer 24 Free Space Available for Tablespace in MB

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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_alloc_space_avg_mb integer 24 average The Average space Allocated for Tablespace in MB

tablespace_alloc_space_min_mb integer 24 min The Minimum space Allocated for Tablespace in MB

tablespace_alloc_space_max_mb integer 24 max The Maximum space Allocated for Tablespace in MB

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

ora_tablespace_name_id string 255 Tablespace Name

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_alloc_space_avg_mb integer 24 average The Average space Allocated for Tablespace in MB

tablespace_alloc_space_min_mb integer 24 min The Minimum space Allocated for Tablespace in MB

tablespace_alloc_space_max_mb integer 24 max The Maximum space Allocated for Tablespace in MB

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

ora_tablespace_name_id string 255 Tablespace Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

E062_BKGRDUMPSPCEPCT bg_dump_space_used_pct integer 24 Space used on background dump device in Percentage

E064_USERDUMPSPACPCT user_dump_space_used_pct integer 24 Space used on user dump device in Percentage

E065_COREDUMPSPACPCT core_dump_space_used_pct integer 24 Space used on core dump device in percentage

E066_ALERTLOGSIZE alert_log_file_size_mb integer 24 Alert log file size in MB

E006_TBLSPFREEPCTCNT low_space_tablespace_count integer 24 Number of table spaces with low free space

E007_TBLSPCSTATUSCNT offline_tablespace_count integer 24 Number of offline tablespaces

Number of table spaces with high ratio of block to physical


E008_TSBREADRATIOCNT high_tablespace_read_ratio_count integer 24
reads

Number of tablespaces with high use of temporary segments


E009_TSTMPEXNTPCTCNT high_temp_segments_tablespace_count integer 24
to total

E011_TBLSPCFRGMNTCNT fragmented_tablespaces_count integer 24 Number of fragmented tablespaces

E505_FGIMBALANCECNT fail_group_imbalance_count integer 24 Number of diskgroups having imbalanced failure groups

timestamp_utc timestamp_utc_s integer 24 The sample time field which holds value in unix epoch

The sample collection time field which holds value in unix


null timestamp_utc_collector_s integer 24
epoch

Source of the Metric Collection that produced this data row. It


collection_source collection_source string 255 can 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


tenant_id tenant_id string 255 belongs to. Needed to apply row level access policies to
control access to data.

Indicates the type of the data producer that ingested the


producer_instance_type producer_instance_type string 50
data. E.g UCMDB, NOM

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should


cmdb_id cmdb_id uuid be used 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]


cmdb_global_id cmdb_global_id uuid should be used in 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
collection_data_flow collection_data_flow string 80 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
CollectionConfigName collection_policy_name string 255 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: "SiteScope Streaming",
collection_type collection_type string 255 "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 1108
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

The fully qualified hostname of the server being monitored.


MonitoredSystem node_fqdn string 255
That is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6


node_ipv6_address node_ipv6_address string 50 format. Fully specified ipv6 format without any simplification
rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being


MonitoredSystemTimezone node_timezone_offset_h string 80
monitored. For 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 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

The Percentile of the space used on background dump device in


bg_dump_space_used_pctl_pct integer 24 90 percentile
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

alert_log_file_size_avg_mb integer 24 average The Average alert log file size in MB

alert_log_file_size_min_mb integer 24 min The Minimum alert log file size in MB

alert_log_file_size_max_mb integer 24 max The Maximum alert log file size in MB

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

offline_tablespace_avg_count integer 24 average The Average number of offline tablespaces

offline_tablespace_min_count integer 24 min The Minimum number of offline tablespaces

offline_tablespace_max_count integer 24 max The Maximum number of offline tablespaces

offline_tablespace_count integer 24 lastval Number of offline tablespaces

The Average number of table spaces with high ratio of block to


high_tablespace_read_ratio_avg_count integer 24 average
physical reads

The Minimum number of table spaces with high ratio of block to


high_tablespace_read_ratio_min_count integer 24 min
physical reads

The Maximum number of table spaces with high ratio of block to


high_tablespace_read_ratio_max_count integer 24 max
physical reads

high_tablespace_read_ratio_count integer 24 lastval Number of table spaces with high ratio of block to physical reads

The Average number of tablespaces with high use of temporary


high_temp_segments_tablespace_avg_count integer 24 average
segments to total

The Minimum number of tablespaces with high use of temporary


high_temp_segments_tablespace_min_count integer 24 min
segments to total

The Maximum number of tablespaces with high use of temporary


high_temp_segments_tablespace_max_count integer 24 max
segments to total

high_temp_segments_tablespace_count integer 24 lastval Number of tablespaces with high use of temporary segments to total

fragmented_tablespaces_avg_count integer 24 average The Average number of fragmented tablespaces

fragmented_tablespaces_min_count integer 24 min The Minimum number of fragmented tablespaces

fragmented_tablespaces_max_count integer 24 max The Maximum number of fragmented tablespaces

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

fragmented_tablespaces_count integer 24 lastval Number of fragmented tablespaces

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

fail_group_imbalance_count integer 24 lastval 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

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

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


cmdb_global_id uuid lastval used in 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
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

The Percentile of the space used on background dump device in


bg_dump_space_used_pctl_pct integer 24 90 percentile
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

alert_log_file_size_avg_mb integer 24 average The Average alert log file size in MB

alert_log_file_size_min_mb integer 24 min The Minimum alert log file size in MB

alert_log_file_size_max_mb integer 24 max The Maximum alert log file size in MB

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

offline_tablespace_avg_count integer 24 average The Average number of offline tablespaces

offline_tablespace_min_count integer 24 min The Minimum number of offline tablespaces

offline_tablespace_max_count integer 24 max The Maximum number of offline tablespaces

offline_tablespace_count integer 24 lastval Number of offline tablespaces

The Average number of table spaces with high ratio of block to


high_tablespace_read_ratio_avg_count integer 24 average
physical reads

The Minimum number of table spaces with high ratio of block to


high_tablespace_read_ratio_min_count integer 24 min
physical reads

The Maximum number of table spaces with high ratio of block to


high_tablespace_read_ratio_max_count integer 24 max
physical reads

high_tablespace_read_ratio_count integer 24 lastval Number of table spaces with high ratio of block to physical reads

The Average number of tablespaces with high use of temporary


high_temp_segments_tablespace_avg_count integer 24 average
segments to total

The Minimum number of tablespaces with high use of temporary


high_temp_segments_tablespace_min_count integer 24 min
segments to total

The Maximum number of tablespaces with high use of temporary


high_temp_segments_tablespace_max_count integer 24 max
segments to total

high_temp_segments_tablespace_count integer 24 lastval Number of tablespaces with high use of temporary segments to total

fragmented_tablespaces_avg_count integer 24 average The Average number of fragmented tablespaces

fragmented_tablespaces_min_count integer 24 min The Minimum number of fragmented tablespaces

fragmented_tablespaces_max_count integer 24 max The Maximum number of fragmented tablespaces

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

fragmented_tablespaces_count integer 24 lastval Number of fragmented tablespaces

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

fail_group_imbalance_count integer 24 lastval 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

ID that uniquely identifies the data producer instance within a


producer_instance_id string 255 lastval
producer type

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


cmdb_global_id uuid lastval used in 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
collection_data_flow string 80 lastval
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
collection_policy_name string 255 lastval
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

null ora_segment_name string 255 Segment Name

null segment_alloc_space_mb integer 24 Allocated Segment Space in MB

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

segment_alloc_space_avg_mb integer 24 average The Average allocated Segment Space in MB

segment_alloc_space_min_mb integer 24 min The Minimum allocated Segment Space in MB

segment_alloc_space_max_mb integer 24 max The Maximum allocated Segment 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

ora_segment_name_id string 255 Segment Name

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

segment_alloc_space_avg_mb integer 24 average The Average allocated Segment Space in MB

segment_alloc_space_min_mb integer 24 min The Minimum allocated Segment Space in MB

segment_alloc_space_max_mb integer 24 max The Maximum allocated Segment 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
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

ora_segment_name_id string 255 Segment Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

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

E058_ARCHVFREESPCPCT archive_free_space_pct integer 24 Percentage of free space on archive device

E060_REDOUNARCHVDCNT redo_log_unarchived_count integer 24 Number of redo logs not yet archived

E113_ADVREPBROKJOBS broken_dbms_jobs_count integer 24 Number of Broken DBMS Jobs

E114_ADVREPFAILJOBS failed_dbms_jobs_count integer 24 Number of Failed DBMS Jobs

E115_ADVREPDEFTRANS deffered_txn_count integer 24 Number of Deferred Transactions

E116_ADVREPERRTRANS err_txn_count integer 24 Number of Error transactions

E117_ADVREPFAILREQ failed_admin_reqs_count integer 24 Number of failed admin requests

E118_ADVREPFAILVIEWS failed_material_views_count integer 24 Number of failed material views

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 1117
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

redo_log_unarchived_count integer 24 lastval Number of redo logs not yet archived

broken_dbms_jobs_avg_count integer 24 average The Average number of Broken DBMS Jobs

broken_dbms_jobs_min_count integer 24 min The Minimum number of Broken DBMS Jobs

broken_dbms_jobs_max_count integer 24 max The Maximum number of Broken DBMS Jobs

broken_dbms_jobs_count integer 24 lastval Number of Broken DBMS Jobs

failed_dbms_jobs_avg_count integer 24 average The Average number of Failed DBMS Jobs

failed_dbms_jobs_min_count integer 24 min The Minimum number of Failed DBMS Jobs

failed_dbms_jobs_max_count integer 24 max The Maximum number of Failed DBMS Jobs

failed_dbms_jobs_count integer 24 lastval Number of Failed DBMS Jobs

deffered_txn_avg_count integer 24 average The Average number of Deferred Transactions

deffered_txn_min_count integer 24 min The Minimum number of Deferred Transactions

deffered_txn_max_count integer 24 max The Maximum number of Deferred Transactions

deffered_txn_count integer 24 lastval Number of Deferred Transactions

err_txn_avg_count integer 24 average The Average number of Error transactions

err_txn_min_count integer 24 min The Minimum number of Error transactions

err_txn_max_count integer 24 max The Maximum number of Error transactions

err_txn_count integer 24 lastval Number of Error transactions

failed_admin_reqs_avg_count integer 24 average The Average number of failed admin requests

failed_admin_reqs_min_count integer 24 min The Minimum number of failed admin requests

failed_admin_reqs_max_count integer 24 max The Maximum number of failed admin requests

failed_admin_reqs_count integer 24 lastval Number of failed admin requests

failed_material_views_avg_count integer 24 average The Average number of failed material views

failed_material_views_min_count integer 24 min The Minimum number of failed material views

failed_material_views_max_count integer 24 max The Maximum number of failed material views

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

failed_material_views_count integer 24 lastval Number of failed material views

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

redo_log_unarchived_count integer 24 lastval Number of redo logs not yet archived

broken_dbms_jobs_avg_count integer 24 average The Average number of Broken DBMS Jobs

broken_dbms_jobs_min_count integer 24 min The Minimum number of Broken DBMS Jobs

broken_dbms_jobs_max_count integer 24 max The Maximum number of Broken DBMS Jobs

broken_dbms_jobs_count integer 24 lastval Number of Broken DBMS Jobs

failed_dbms_jobs_avg_count integer 24 average The Average number of Failed DBMS Jobs

failed_dbms_jobs_min_count integer 24 min The Minimum number of Failed DBMS Jobs

failed_dbms_jobs_max_count integer 24 max The Maximum number of Failed DBMS Jobs

failed_dbms_jobs_count integer 24 lastval Number of Failed DBMS Jobs

deffered_txn_avg_count integer 24 average The Average number of Deferred Transactions

deffered_txn_min_count integer 24 min The Minimum number of Deferred Transactions

deffered_txn_max_count integer 24 max The Maximum number of Deferred Transactions

deffered_txn_count integer 24 lastval Number of Deferred Transactions

err_txn_avg_count integer 24 average The Average number of Error transactions

err_txn_min_count integer 24 min The Minimum number of Error transactions

err_txn_max_count integer 24 max The Maximum number of Error transactions

err_txn_count integer 24 lastval Number of Error transactions

failed_admin_reqs_avg_count integer 24 average The Average number of failed admin requests

failed_admin_reqs_min_count integer 24 min The Minimum number of failed admin requests

failed_admin_reqs_max_count integer 24 max The Maximum number of failed admin requests

failed_admin_reqs_count integer 24 lastval Number of failed admin requests

failed_material_views_avg_count integer 24 average The Average number of failed material views

failed_material_views_min_count integer 24 min The Minimum number of failed material views

failed_material_views_max_count integer 24 max The Maximum number of failed material views

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

failed_material_views_count integer 24 lastval Number of failed material views

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

E070_PQSERVRSBUSYPCT srvs_busy_pct integer 24 Percentage of busy servers to parallel query servers

E071_PQSRVHIGHWTRPCT srv_highwater_pct integer 24 Percentage of highwatermark servers to parallel query servers

E074_PQQUERYRATE parallel_qry_count_per_min integer 24 Rate of parallel queries initiated

E076_PQRANGESCANPCT parallel_qry_range_scan_pct integer 24 Percentage of range scan vs full table scans

E031_OPENCRSRPCTCNT open_cursors_users_count integer 24 Number of users with percentage of open cursors

E044_COMMITRATE commit_count_per_s integer 24 Number of transactions commit rate

E049_USERCALLRATE user_call_count_per_s integer 24 Rate of user calls

E050_RCSVUSRCALRATIO recursive_vs_user_call_ratio integer 24 Ratio of recursive calls to user calls

E054_ROLLBACKRATE rollback_count_per_min integer 24 Rate at which rollbacks are being generated

E085_TRANSACTIONPCT current_txn_pct integer 24 Percentage of current transactions to configured

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to COSO. 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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 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 1123
AI Operations Management - Containerized 24.4

Metric Name/Global Data


Column Name Size Description
Name Type

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

The Percentile of the percentage of highwatermark servers to parallel query


srv_highwater_pctl_pct integer 24 90 percentile
servers

parallel_qry_avg_count_per_min integer 24 average The Average rate of parallel queries initiated

parallel_qry_min_count_per_min integer 24 min The Minimum rate of parallel queries initiated

parallel_qry_max_count_per_min integer 24 max The Maximum rate of parallel queries initiated

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

open_cursors_users_count integer 24 lastval Number of users with percentage of open cursors

commit_avg_count_per_s integer 24 average The Average number of transactions commit rate

commit_min_count_per_s integer 24 min The Minimum number of transactions commit rate

commit_max_count_per_s integer 24 max The Maximum number of transactions commit rate

user_call_avg_count_per_s integer 24 average The Average rate of user calls

user_call_min_count_per_s integer 24 min The Minimum rate of user calls

user_call_max_count_per_s integer 24 max The Maximum rate of user calls

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

recursive_vs_user_call_ratio integer 24 lastval 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_avg_pct integer 24 average The Average percentage of current transactions to configured

current_txn_min_pct integer 24 min The Minimum percentage of current transactions to configured

current_txn_max_pct integer 24 max The Maximum percentage of current transactions to configured

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

The Percentile of the percentage of highwatermark servers to parallel query


srv_highwater_pctl_pct integer 24 90 percentile
servers

parallel_qry_avg_count_per_min integer 24 average The Average rate of parallel queries initiated

parallel_qry_min_count_per_min integer 24 min The Minimum rate of parallel queries initiated

parallel_qry_max_count_per_min integer 24 max The Maximum rate of parallel queries initiated

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

open_cursors_users_count integer 24 lastval Number of users with percentage of open cursors

commit_avg_count_per_s integer 24 average The Average number of transactions commit rate

commit_min_count_per_s integer 24 min The Minimum number of transactions commit rate

commit_max_count_per_s integer 24 max The Maximum number of transactions commit rate

user_call_avg_count_per_s integer 24 average The Average rate of user calls

user_call_min_count_per_s integer 24 min The Minimum rate of user calls

user_call_max_count_per_s integer 24 max The Maximum rate of user calls

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

recursive_vs_user_call_ratio integer 24 lastval 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_avg_pct integer 24 average The Average percentage of current transactions to configured

current_txn_min_pct integer 24 min The Minimum percentage of current transactions to configured

current_txn_max_pct integer 24 max The Maximum percentage of current transactions to configured

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

E004_USERSTMPDFLTCNT default_tablespace_users_count integer 24 Number of users with default tablespace set to SYSTEM

E005_OBJCTSFORIGNCNT foreign_obj_sys_count integer 24 Number of foreign objects in SYSTEM table space

E030_FULLGTBLSCNRATE long_tablescan_count_per_min integer 24 Rate of Long Table scans

E041_FULSHTBLSCNRATE short_tablescan_count_per_min integer 24 Rate of Short Table scans

E042_UNLYZTBLINDXPCT unanalyzed_tables_indexes_pct integer 24 Percentage of never analyzed tables & indexes

E046_ROWFETCBYIDXPCT rows_fetched_index_pct integer 24 Percentage of rows fetched by index

E047_TABLESCACHEDCNT cached_tables_count integer 24 Number of tables cached

E048_CHANDROWFTCHPCT chained_rows_fetched_pct integer 24 Percentage of chained rows fetched

E016_SEGMNTEXTENDCNT segments_extension_disabled_count integer 24 Number of segments that cannot extend

E017_SEGMAXEXTENTCNT max_extents_segments_count integer 24 Number of segments approaching max extent

E018_SEGEXTRAPIDCNT segments_extension_growth_count integer 24 Number of segments adding extents rapidly

E067_RBSEGMNTSTATCNT rollback_segments_not_online_count integer 24 Number of Rollback Segments not online

E090_DSPTCHRBUSYPCT dispatchers_busy_pct integer 24 Percentage of busy dispatchers

E091_NUMDSPTCHRCLNTS curr_dispatchers_clients_count integer 24 Number of clients currently connected to all dispatchers

E092_SHRSRVRREQWTPCT shared_servers_waiting_pct integer 24 Percentage of the shared servers waiting for requests

E095_SESUGAMEMMAXPCT uga_mem_used_pct integer 24 Percentage of shared pool allocated to UGA

E096_SHRDSRVHWMPCT shared_server_highwater_pct integer 24 Percentage of highwater to shared server processes in a session

E019_SORTDISKRATE disk_sort_count_per_h integer 24 Number of disk sorts per hour

E020_SORTMEMORYPCT mem_sort_pct integer 24 Percentage of in-memory sorts

E021_BUFFERBUSYPCT buffer_busy_pct integer 24 Percentage of buffer busy waits to logical reads

E022_TOTBUFCACHITPCT total_buffer_cache_hit_pct integer 24 Total buffer cache hit percentage

E023_CURBUFCACHITPCT curr_buffer_cache_hit_pct integer 24 Current buffer cache hit percentage

E024_EQWAITSREQPCT enque_waits_pct integer 24 Percentage of enqueue waits to enqueue requests

E026_DICTCACHEHITPCT dictionary_cache_hit_pct integer 24 Percentage of dictionary cache get hit to total cache hit

Percentage of cache misses (reloads) to executions (pins) in the


E027_LIBCACHRELODPCT library_cache_misses_pct integer 24
dictionary cache

E032_REDOLGSPCREQCNT redo_log_space_req_count integer 24 Number of request for redo log space

E033_REDOALOCLTCHPCT redo_alloc_latch_misses_pct integer 24 Percentage of redo allocation latch misses

E034_REDOCOPYLTCHPCT redo_copy_latch_misses_pct integer 24 Percentage of redo copy latch misses

E035_BCKGNDCKPTRATE bg_checkpoints_count_per_min integer 24 Rate of background checkpoints completed

E039_LIBCACGETHITPCT library_cache_gethits_pct integer 24 Percentage of gethits to gets in dictionary cache

E040_LIBCACPINHITPCT library_cache_pinhits_pct integer 24 Percentage of pinhits to pins in dictionary cache

E045_SHRDPOOLFREEPCT free_shared_pool_pct integer 24 Percentage of free shared pool memory

E051_SORTROWSAVGCNT rows_per_sort_count integer 24 Number of rows per sort

E052_SORTTOTALRATE sort_count_per_min integer 24 Rate of sorts (disk & in-memory)

E059_CURSORCACHEPCT cursor_in_cache_pct integer 24 Percentage of cursors in cache parameter

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

Metric Name/Global Data


Column Name Size Description
Name Type

E075_RCRSVCURSRRATIO recursive_vs_opened_cursor_ratio integer 24 Ratio of recursive calls to cumulative opened cursors

E083_DBWRCKPTRATE dbwr_checkpoint_count_per_min integer 24 Rate of Database Writer process checkpoints

E502_JAVAPOOLFREEPCT free_java_pool_pct integer 24 Percentage of JAVA pool free memory

E503_LARGPOOLFREEPCT free_large_pool_pct integer 24 Percentage of Large pool free memory

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


collection_source collection_source string 255 can 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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid be used in 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
collection_data_flow collection_data_flow string 80
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.
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "Collection Service - Agent", "BPM Probe", RUM
Engine", "OBM Server Event Forwarding", "SCOM MP", etc.

The fully qualified hostname of the server being monitored. That


MonitoredSystem node_fqdn string 255
is the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

Short name of the server being monitored. Name must not


MonitoredSystemID node_short_name string 255
contain any '.' (Period) character.

Time zone offset to UTC in hours of the server being monitored.


MonitoredSystemTimezone node_timezone_offset_h string 80
For 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 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

foreign_obj_sys_count integer 24 lastval Number of foreign objects in SYSTEM table space

long_tablescan_avg_count_per_min integer 24 average The Average rate of Long Table scans

long_tablescan_min_count_per_min integer 24 min The Minimum rate of Long Table scans

long_tablescan_max_count_per_min integer 24 max The Maximum rate of Long Table scans

short_tablescan_avg_count_per_min integer 24 average The Average rate of Short Table scans

short_tablescan_min_count_per_min integer 24 min The Minimum rate of Short Table scans

short_tablescan_max_count_per_min integer 24 max The Maximum rate of Short Table scans

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_avg_pct integer 24 average The Average percentage of rows fetched by index

rows_fetched_index_min_pct integer 24 min The Minimum percentage of rows fetched by index

rows_fetched_index_max_pct integer 24 max The Maximum percentage of rows fetched by index

rows_fetched_index_pctl_pct integer 24 10 percentile The Percentile of the percentage of rows fetched by index

cached_tables_avg_count integer 24 average The Average number of tables cached

cached_tables_min_count integer 24 min The Minimum number of tables cached

cached_tables_max_count integer 24 max The Maximum number of tables cached

cached_tables_count integer 24 lastval Number of tables cached

chained_rows_fetched_avg_pct integer 24 average The Average percentage of chained rows fetched

chained_rows_fetched_min_pct integer 24 min The Minimum percentage of chained rows fetched

chained_rows_fetched_max_pct integer 24 max The Maximum percentage of chained rows fetched

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

segments_extension_disabled_count integer 24 lastval 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

max_extents_segments_count integer 24 lastval 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

segments_extension_growth_count integer 24 lastval 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

rollback_segments_not_online_count integer 24 lastval Number of Rollback Segments not online

dispatchers_busy_avg_pct integer 24 average The Average percentage of busy dispatchers

dispatchers_busy_min_pct integer 24 min The Minimum percentage of busy dispatchers

dispatchers_busy_max_pct integer 24 max The Maximum percentage of busy dispatchers

dispatchers_busy_pctl_pct integer 24 90 percentile The Percentile of the percentage of busy dispatchers

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

curr_dispatchers_clients_count integer 24 lastval 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

The Percentile of the percentage of the shared servers waiting for


shared_servers_waiting_pctl_pct integer 24 90 percentile
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

The Average percentage of highwater to shared server processes in a


shared_server_highwater_avg_pct integer 24 average
session

The Minimum percentage of highwater to shared server processes in a


shared_server_highwater_min_pct integer 24 min
session

The Maximum percentage of highwater to shared server processes in a


shared_server_highwater_max_pct integer 24 max
session

The Percentile of the percentage of highwater to shared server processes


shared_server_highwater_pctl_pct integer 24 90 percentile
in a session

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

mem_sort_avg_pct integer 24 average The Average percentage of in-memory sorts

mem_sort_min_pct integer 24 min The Minimum percentage of in-memory sorts

mem_sort_max_pct integer 24 max The Maximum percentage of in-memory sorts

mem_sort_pctl_pct integer 24 10 percentile The Percentile of the percentage of in-memory sorts

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

The Average percentage of cache misses (reloads) to executions (pins) in


library_cache_misses_avg_pct integer 24 average
the dictionary cache

The Minimum percentage of cache misses (reloads) to executions (pins)


library_cache_misses_min_pct integer 24 min
in the dictionary cache

The Maximum percentage of cache misses (reloads) to executions (pins)


library_cache_misses_max_pct integer 24 max
in the dictionary cache

The Percentile of the percentage of cache misses (reloads) to executions


library_cache_misses_pctl_pct integer 24 90 percentile
(pins) in the dictionary cache

redo_log_space_req_count integer 24 lastval Number of request for redo log space

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

bg_checkpoints_avg_count_per_min integer 24 average The Average rate of background checkpoints completed

bg_checkpoints_min_count_per_min integer 24 min The Minimum rate of background checkpoints completed

bg_checkpoints_max_count_per_min integer 24 max The Maximum rate of background checkpoints completed

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

rows_per_sort_avg_count integer 24 average The Average number of rows per sort

rows_per_sort_min_count integer 24 min The Minimum number of rows per sort

rows_per_sort_max_count integer 24 max The Maximum number of rows per sort

rows_per_sort_count integer 24 lastval Number of rows per sort

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_avg_pct integer 24 average The Average percentage of cursors in cache parameter

cursor_in_cache_min_pct integer 24 min The Minimum percentage of cursors in cache parameter

cursor_in_cache_max_pct integer 24 max The Maximum percentage of cursors in cache parameter

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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 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
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.

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"

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

foreign_obj_sys_count integer 24 lastval Number of foreign objects in SYSTEM table space

long_tablescan_avg_count_per_min integer 24 average The Average rate of Long Table scans

long_tablescan_min_count_per_min integer 24 min The Minimum rate of Long Table scans

long_tablescan_max_count_per_min integer 24 max The Maximum rate of Long Table scans

short_tablescan_avg_count_per_min integer 24 average The Average rate of Short Table scans

short_tablescan_min_count_per_min integer 24 min The Minimum rate of Short Table scans

short_tablescan_max_count_per_min integer 24 max The Maximum rate of Short Table scans

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_avg_pct integer 24 average The Average percentage of rows fetched by index

rows_fetched_index_min_pct integer 24 min The Minimum percentage of rows fetched by index

rows_fetched_index_max_pct integer 24 max The Maximum percentage of rows fetched by index

rows_fetched_index_pctl_pct integer 24 10 percentile The Percentile of the percentage of rows fetched by index

cached_tables_avg_count integer 24 average The Average number of tables cached

cached_tables_min_count integer 24 min The Minimum number of tables cached

cached_tables_max_count integer 24 max The Maximum number of tables cached

cached_tables_count integer 24 lastval Number of tables cached

chained_rows_fetched_avg_pct integer 24 average The Average percentage of chained rows fetched

chained_rows_fetched_min_pct integer 24 min The Minimum percentage of chained rows fetched

chained_rows_fetched_max_pct integer 24 max The Maximum percentage of chained rows fetched

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

segments_extension_disabled_count integer 24 lastval 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

max_extents_segments_count integer 24 lastval 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

segments_extension_growth_count integer 24 lastval 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

rollback_segments_not_online_count integer 24 lastval Number of Rollback Segments not online

dispatchers_busy_avg_pct integer 24 average The Average percentage of busy dispatchers

dispatchers_busy_min_pct integer 24 min The Minimum percentage of busy dispatchers

dispatchers_busy_max_pct integer 24 max The Maximum percentage of busy dispatchers

dispatchers_busy_pctl_pct integer 24 90 percentile The Percentile of the percentage of busy dispatchers

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

curr_dispatchers_clients_count integer 24 lastval 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

The Percentile of the percentage of the shared servers waiting for


shared_servers_waiting_pctl_pct integer 24 90 percentile
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

The Average percentage of highwater to shared server processes in a


shared_server_highwater_avg_pct integer 24 average
session

The Minimum percentage of highwater to shared server processes in a


shared_server_highwater_min_pct integer 24 min
session

The Maximum percentage of highwater to shared server processes in a


shared_server_highwater_max_pct integer 24 max
session

The Percentile of the percentage of highwater to shared server processes


shared_server_highwater_pctl_pct integer 24 90 percentile
in a session

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

mem_sort_avg_pct integer 24 average The Average percentage of in-memory sorts

mem_sort_min_pct integer 24 min The Minimum percentage of in-memory sorts

mem_sort_max_pct integer 24 max The Maximum percentage of in-memory sorts

mem_sort_pctl_pct integer 24 10 percentile The Percentile of the percentage of in-memory sorts

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

The Average percentage of cache misses (reloads) to executions (pins) in


library_cache_misses_avg_pct integer 24 average
the dictionary cache

The Minimum percentage of cache misses (reloads) to executions (pins)


library_cache_misses_min_pct integer 24 min
in the dictionary cache

The Maximum percentage of cache misses (reloads) to executions (pins)


library_cache_misses_max_pct integer 24 max
in the dictionary cache

The Percentile of the percentage of cache misses (reloads) to executions


library_cache_misses_pctl_pct integer 24 90 percentile
(pins) in the dictionary cache

redo_log_space_req_count integer 24 lastval Number of request for redo log space

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

bg_checkpoints_avg_count_per_min integer 24 average The Average rate of background checkpoints completed

bg_checkpoints_min_count_per_min integer 24 min The Minimum rate of background checkpoints completed

bg_checkpoints_max_count_per_min integer 24 max The Maximum rate of background checkpoints completed

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

rows_per_sort_avg_count integer 24 average The Average number of rows per sort

rows_per_sort_min_count integer 24 min The Minimum number of rows per sort

rows_per_sort_max_count integer 24 max The Maximum number of rows per sort

rows_per_sort_count integer 24 lastval Number of rows per sort

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_avg_pct integer 24 average The Average percentage of cursors in cache parameter

cursor_in_cache_min_pct integer 24 min The Minimum percentage of cursors in cache parameter

cursor_in_cache_max_pct integer 24 max The Maximum percentage of cursors in cache parameter

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id string 255 lastval
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 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
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.

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"

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address string 50 lastval
specified ipv6 format without any simplification rules.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

E086_PHYSREADSRATE physical_reads_per_min integer 24 Number of physical reads per min

E088_LOGICREADSRATE logical_reads_per_min integer 24 Number of logical reads per min

E028_LOCKSUSEDPCT dml_locks_used_pct integer 24 Percentage of DML locks used

E029_SESSWAITLCKCNT sessions_wait_for_lock_count integer 24 Number of sessions waiting for release of a lock

E038_LTCHOVRLIMITCNT high_contention_latches_count integer 24 Number of latches with high contention ratio

E043_EQTIMEOUTREQPCT enque_timeout_pct integer 24 Enqueue timeouts in percentage

E097_DISBLDTBLLCKNUM locks_disabled_tables_count integer 24 Number of tables with table locks disabled

Maximum blocked time of DB because of transactional locks in


E501_MAXBLKDBTIMELCK max_blocked_db_time_s integer 24
seconds

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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 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_avg_pct integer 24 average The Average percentage of DML locks used

dml_locks_used_min_pct integer 24 min The Minimum percentage of DML locks used

dml_locks_used_max_pct integer 24 max The Maximum percentage of DML locks used

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

sessions_wait_for_lock_count integer 24 lastval 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

high_contention_latches_count integer 24 lastval Number of latches with high contention ratio

enque_timeout_avg_pct integer 24 average The Average enqueue timeouts in percentage

enque_timeout_min_pct integer 24 min The Minimum enqueue timeouts in percentage

enque_timeout_max_pct integer 24 max The Maximum enqueue timeouts in percentage

enque_timeout_pctl_pct integer 24 90 percentile The Percentile of the enqueue timeouts in percentage

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

locks_disabled_tables_count integer 24 lastval Number of tables with table locks disabled

The Average maximum blocked time of DB because of transactional locks in


max_blocked_db_time_avg_s integer 24 average
seconds

The Maximum maximum blocked time of DB because of transactional locks in


max_blocked_db_time_max_s integer 24 max
seconds

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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_avg_pct integer 24 average The Average percentage of DML locks used

dml_locks_used_min_pct integer 24 min The Minimum percentage of DML locks used

dml_locks_used_max_pct integer 24 max The Maximum percentage of DML locks used

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

sessions_wait_for_lock_count integer 24 lastval 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

high_contention_latches_count integer 24 lastval Number of latches with high contention ratio

enque_timeout_avg_pct integer 24 average The Average enqueue timeouts in percentage

enque_timeout_min_pct integer 24 min The Minimum enqueue timeouts in percentage

enque_timeout_max_pct integer 24 max The Maximum enqueue timeouts in percentage

enque_timeout_pctl_pct integer 24 90 percentile The Percentile of the enqueue timeouts in percentage

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

locks_disabled_tables_count integer 24 lastval Number of tables with table locks disabled

The Average maximum blocked time of DB because of transactional locks in


max_blocked_db_time_avg_s integer 24 average
seconds

The Maximum maximum blocked time of DB because of transactional locks in


max_blocked_db_time_max_s integer 24 max
seconds

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

Oracle Database Instance status. The status are UP - 0, Shutdown Mode -


E001_DBINSTANCESTAT ora_db_instance_status integer 24
1, Restricted Mode - 2, Cannot Connect - 3, RAC DB Down - 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

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

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 with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

null ora_database_name string 255 Oracle Database Name

null db_alloc_space_mb integer 24 Space Allocated for DB in MB

null db_free_space_mb integer 24 Free Space Available for DB in MB

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

db_alloc_space_avg_mb integer 24 average The Average space Allocated for DB in MB

db_alloc_space_min_mb integer 24 min The Minimum space Allocated for DB in MB

db_alloc_space_max_mb integer 24 max The Maximum space Allocated for DB in MB

db_free_space_avg_mb integer 24 average The Average free Space Available for DB in MB

db_free_space_min_mb integer 24 min The Minimum free Space Available for DB in MB

db_free_space_max_mb integer 24 max The Maximum free Space Available for DB 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_database_name_id string 255 Oracle Database Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

db_alloc_space_avg_mb integer 24 average The Average space Allocated for DB in MB

db_alloc_space_min_mb integer 24 min The Minimum space Allocated for DB in MB

db_alloc_space_max_mb integer 24 max The Maximum space Allocated for DB in MB

db_free_space_avg_mb integer 24 average The Average free Space Available for DB in MB

db_free_space_min_mb integer 24 min The Minimum free Space Available for DB in MB

db_free_space_max_mb integer 24 max The Maximum free Space Available for DB 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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_database_name_id string 255 Oracle Database Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

Data Guard Fast-Start Failover Status (1-Disabled, 2-Unsynchronized, 3-


E138_HEALTHCHECKDGFO fast_start_failover_status integer 24
Loading Dictionary, 4-Suspended, 5-Primary Unobserved)

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

INSTANCENAME ora_instance_name string 255 Oracle DB Instance Name

DATABASEHOST ora_database_host string 255 Oracle Database Host Name

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 with timezone at which the counter value (sample) was


null timestamp_tz timestamp
gathered.

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name 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

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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

ora_database_host_id string 255 Oracle Database Host Name

ora_instance_name_id string 255 Oracle DB Instance Name

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

1.4.2.8. Management Pack for Oracle Weblogic


This section provides you information about the Management Pack for Oracle Weblogic:

Raw Tables Aggregated Tables (Hourly) Aggregated Tables (Daily) Forecast Tables

opsb_weblogic_cluster opsb_weblogic_cluster_1h opsb_weblogic_cluster_1d

opsb_weblogic_ejb_cache opsb_weblogic_ejb_cache_1h opsb_weblogic_ejb_cache_1d

opsb_weblogic_ejb_pool opsb_weblogic_ejb_pool_1h opsb_weblogic_ejb_pool_1d

opsb_weblogic_ejb_transaction opsb_weblogic_ejb_transaction_1h opsb_weblogic_ejb_transaction_1d

opsb_weblogic_gridlink opsb_weblogic_gridlink_1h opsb_weblogic_gridlink_1d

opsb_weblogic_jca_conn_pool opsb_weblogic_jca_conn_pool_1h opsb_weblogic_jca_conn_pool_1d

opsb_weblogic_jdbc opsb_weblogic_jdbc_1h opsb_weblogic_jdbc_1d

opsb_weblogic_jdk_gc opsb_weblogic_jdk_gc_1h opsb_weblogic_jdk_gc_1d

opsb_weblogic_jdk_total_gc opsb_weblogic_jdk_total_gc_1h opsb_weblogic_jdk_total_gc_1d

opsb_weblogic_jms opsb_weblogic_jms_1h opsb_weblogic_jms_1d

opsb_weblogic_jms_module_state opsb_weblogic_jms_module_state_1h opsb_weblogic_jms_module_state_1d

opsb_weblogic_jms_processed_msg opsb_weblogic_jms_processed_msg_1h opsb_weblogic_jms_processed_msg_1d

opsb_weblogic_jms_util opsb_weblogic_jms_util_1h opsb_weblogic_jms_util_1d Not available

opsb_weblogic_jvm opsb_weblogic_jvm_1h opsb_weblogic_jvm_1d

opsb_weblogic_maxthreadsconst opsb_weblogic_maxthreadsconst_1h opsb_weblogic_maxthreadsconst_1d

opsb_weblogic_minthreadsconst opsb_weblogic_minthreadsconst_1h opsb_weblogic_minthreadsconst_1d

opsb_weblogic_security opsb_weblogic_security_1h opsb_weblogic_security_1d

opsb_weblogic_server_status opsb_weblogic_server_status_1h opsb_weblogic_server_status_1d

opsb_weblogic_servlet_session opsb_weblogic_servlet_session_1h opsb_weblogic_servlet_session_1d

opsb_weblogic_servlets opsb_weblogic_servlets_1h opsb_weblogic_servlets_1d

opsb_weblogic_threadpool opsb_weblogic_threadpool_1h opsb_weblogic_threadpool_1d

opsb_weblogic_transaction opsb_weblogic_transaction_1h opsb_weblogic_transaction_1d

opsb_weblogic_xml_cache opsb_weblogic_xml_cache_1h opsb_weblogic_xml_cache_1d

opsb_weblogic_cluster_status Not available Not available

opsb_weblogic_gridlink_state Not available Not available

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

Metric Name/Global Data


Column Name Size Description
Name Type

Weblogic server instance name. This is formatted with server name,


WEBLOGIC_INSTANCE weblogic_srv_instance_name string 255
instance name and server listen port.

WEBLOGIC_NAME weblogic_cluster_name string 255 Weblogic cluster name

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC-DL. Pull:Data producer provides
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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_cluster_name_id string 255 Weblogic cluster name

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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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_cluster_name_id string 255 Weblogic cluster name

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

Metric Name/Global Data


Column Name Size Description
Name Type

Weblogic server instance name. This is formatted with server name,


WEBLOGIC_INSTANCE weblogic_srv_instance_name string 255
instance name and server listen port.

WEBLOGIC_NAME weblogic_cluster_name string 255 Weblogic cluster name

Health of the cluster (0-OK, 1-WARN, 2-CRITICAL, 3-FAILED, 4-


WEBLGC_CLUSTERHEALTH cluster_health_status integer 24
OVERLOADED)

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

ID that uniquely identifies the data producer instance within a producer


producer_instance_id producer_instance_id string 255
type

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

Values are Push or Pull. Push:Data producer (producer instance id)


actively pushes data directly to OPTIC-DL. Pull:Data producer provides
collection_data_flow collection_data_flow string 80
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
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.

The IP address of the monitored server. Encoded as IPv6 format. Fully


node_ipv6_address node_ipv6_address string 50
specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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

Metric Name/Global Data


Column Name Size Description
Name Type

Weblogic server instance name. This is formatted with server name,


WEBLOGIC_INSTANCE weblogic_srv_instance_name string 255
instance name and server listen port.

WEBLOGIC_NAME weblogic_ejb_cache_rt_app_name string 255 Weblogic EJB cache runtime application name

Provides a count of the total number of attempts to access a bean


WEBLGCEJBRTCACACCCNT cache_access_count double 24
from the cache.

Provides a count of the total number of times an attempt to access


WEBLGCEJBRTCACMISCNT cache_miss_count double 24
a bean from the cache failed.

WEBLGCEJBCACHEHITPCT cache_hit_pct double 24 Percentage of Enterprise JavaBeans (EJBs) in the cache in use.

WEBLGCEJBCACHEMISPCT cache_miss_pct double 24 Percentage of Enterprise JavaBeans (EJBs) cache missed.

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

ID that uniquely identifies the data producer instance within a


producer_instance_id producer_instance_id string 255
producer type

Holds the local ID of the entity in UCMDB. [entity type] should be


cmdb_id cmdb_id uuid used 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


cmdb_global_id cmdb_global_id uuid used in 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
collection_data_flow collection_data_flow string 80
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
CollectionConfigName collection_policy_name string 255
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: "SiteScope Streaming", "Operations Agent
collection_type collection_type string 255
Streaming", "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


MonitoredSystem node_fqdn string 255
the server to which the data belongs

node_ipv4_address node_ipv4_address string 50 IPV4 address of the server being monitored if using IPV4.

The IP address of the monitored server. Encoded as IPv6 format.


node_ipv6_address node_ipv6_address string 50
Fully specified ipv6 format without any simplification rules.

node_ip_type node_ip_type string 80 IP Type of the monitored node (IPV4 or IPV6).

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.

The Minimum provides a count of the total number of attempts to access a


cache_access_min_count double 24 min
bean from the cache.

The Maximum provides a count of the total number of attempts to access a


cache_access_max_count double 24 max
bean from the cache.

The Average provides a count of the total number of times an attempt to


cache_miss_avg_count double 24 average
access a bean from the cache failed.

The Minimum provides a count of the total number of times an attempt to


cache_miss_min_count double 24 min
access a bean from the cache failed.

The Maximum provides a count of the total number of times an attempt to


cache_miss_max_count double 24 max
access a bean from the cache failed.

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.

The Percentile of the percentage of Enterprise JavaBeans (EJBs) in the cache in


cache_hit_pctl_pct double 24 90 percentile
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.

node_ip_type string 80 lastval IP Type of the monitored node (IPV4 or IPV6).

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_ejb_cache_rt_app_name_id string 255 Weblogic EJB cache runtime application name

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.

The Minimum provides a count of the total number of attempts to access a


cache_access_min_count double 24 min
bean from the cache.

The Maximum provides a count of the total number of attempts to access a


cache_access_max_count double 24 max
bean from the cache.

The Average provides a count of the total number of times an attempt to


cache_miss_avg_count double 24 average
access a bean from the cache failed.

The Minimum provides a count of the total number of times an attempt to


cache_miss_min_count double 24 min
access a bean from the cache failed.

The Maximum provides a count of the total number of times an attempt to


cache_miss_max_count double 24 max
access a bean from the cache failed.

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.

The Percentile of the percentage of Enterprise JavaBeans (EJBs) in the cache in


cache_hit_pctl_pct double 24 90 percentile
use.

cache_miss_avg_pct double 24 average The Average percentage of Enter

You might also like